Struct FirestorePartitionQueryParams

pub struct FirestorePartitionQueryParams {
    pub query_params: FirestoreQueryParams,
    pub partition_count: u32,
    pub page_size: u32,
    pub page_token: Option<String>,
}

Parameters for a partitioned query.

Partitioned queries allow you to divide a large query into smaller, parallelizable chunks. This is useful for exporting data or performing large-scale data processing.

Fields

query_params: FirestoreQueryParams

The base query parameters to partition.

partition_count: u32

The desired number of partitions to return. Must be a positive integer.

page_size: u32

The maximum number of partitions to return in this call, used for paging. Must be a positive integer.

page_token: Option<String>

A page token from a previous PartitionQuery response to retrieve the next set of partitions.

Implementations

impl FirestorePartitionQueryParams

pub fn new( query_params: FirestoreQueryParams, partition_count: u32, page_size: u32, ) -> Self

pub fn query_params(&mut self, value: FirestoreQueryParams) -> &mut Self

pub fn with_query_params(self, value: FirestoreQueryParams) -> Self

pub fn partition_count(&mut self, value: u32) -> &mut Self

pub fn with_partition_count(self, value: u32) -> Self

pub fn page_size(&mut self, value: u32) -> &mut Self

pub fn with_page_size(self, value: u32) -> Self

pub fn page_token(&mut self, value: String) -> &mut Self

pub fn reset_page_token(&mut self) -> &mut Self

pub fn mopt_page_token(&mut self, value: Option<String>) -> &mut Self

pub fn with_page_token(self, value: String) -> Self

pub fn without_page_token(self) -> Self

pub fn opt_page_token(self, value: Option<String>) -> Self

Trait Implementations

impl Clone for FirestorePartitionQueryParams

fn clone(&self) -> FirestorePartitionQueryParams

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FirestorePartitionQueryParams

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<FirestorePartitionQueryParamsInit> for FirestorePartitionQueryParams

fn from(value: FirestorePartitionQueryParamsInit) -> Self

Converts to this type from the input type.

impl PartialEq for FirestorePartitionQueryParams

fn eq(&self, other: &FirestorePartitionQueryParams) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for FirestorePartitionQueryParams