Struct FirestoreQueryParams 

pub struct FirestoreQueryParams {

    pub parent: Option<String>,
    pub collection_id: FirestoreQueryCollection,
    pub limit: Option<u32>,
    pub offset: Option<u32>,
    pub order_by: Option<Vec<FirestoreQueryOrder>>,
    pub filter: Option<FirestoreQueryFilter>,
    pub all_descendants: Option<bool>,
    pub return_only_fields: Option<Vec<String>>,
    pub start_at: Option<FirestoreQueryCursor>,
    pub end_at: Option<FirestoreQueryCursor>,
    pub explain_options: Option<FirestoreExplainOptions>,
    pub find_nearest: Option<FirestoreFindNearestOptions>,
    pub request_options: Option<FirestoreRequestOptions>,
}

Re-exports all public items from the db module.

The db module contains the core FirestoreDb client and functionalities for interacting with the Firestore database, such as CRUD operations, queries, and transactions. Parameters for constructing and executing a Firestore query.

This struct encapsulates all configurable aspects of a query, such as the target collection, filters, ordering, limits, offsets, cursors, and projections. It is used by the fluent API and direct query methods to define the query to be sent to Firestore.

Fields

parent: Option<String>

The parent resource path. For top-level collections, this is typically the database path (e.g., “projects/my-project/databases/(default)/documents”). For sub-collections, it’s the path to the parent document. If None, the query is assumed to be on a top-level collection relative to the FirestoreDb’s document path.

collection_id: FirestoreQueryCollection

The ID of the collection or collection group to query.

limit: Option<u32>

The maximum number of results to return.

offset: Option<u32>

The number of results to skip.

order_by: Option<Vec<FirestoreQueryOrder>>

A list of fields and directions to order the results by.

filter: Option<FirestoreQueryFilter>

The filter to apply to the query.

all_descendants: Option<bool>

If true, the query will search all collections located anywhere in the database under the parent path (if specified) that have the given collection_id. This is used for collection group queries. Defaults to false if not set, meaning only direct children collections are queried.

return_only_fields: Option<Vec<String>>

If set, only these fields will be returned in the query results (projection). If None, all fields are returned.

start_at: Option<FirestoreQueryCursor>

A cursor to define the starting point of the query.

end_at: Option<FirestoreQueryCursor>

A cursor to define the ending point of the query.

explain_options: Option<FirestoreExplainOptions>

Options for requesting an explanation of the query execution plan.

find_nearest: Option<FirestoreFindNearestOptions>

Options for performing a vector similarity search (find nearest neighbors).

request_options: Option<FirestoreRequestOptions>

Request options (e.g. request tags) for this query.

Overrides any session wide default configured with FirestoreDb::clone_with_request_options.

Implementations

impl FirestoreQueryParams

pub fn new(collection_id: FirestoreQueryCollection) -> Self

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

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

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

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

pub fn without_parent(self) -> Self

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

pub fn collection_id(&mut self, value: FirestoreQueryCollection) -> &mut Self

pub fn with_collection_id(self, value: FirestoreQueryCollection) -> Self

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

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

pub fn mopt_limit(&mut self, value: Option<u32>) -> &mut Self

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

pub fn without_limit(self) -> Self

pub fn opt_limit(self, value: Option<u32>) -> Self

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

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

pub fn mopt_offset(&mut self, value: Option<u32>) -> &mut Self

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

pub fn without_offset(self) -> Self

pub fn opt_offset(self, value: Option<u32>) -> Self

pub fn order_by(&mut self, value: Vec<FirestoreQueryOrder>) -> &mut Self

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

pub fn mopt_order_by( &mut self, value: Option<Vec<FirestoreQueryOrder>>, ) -> &mut Self

pub fn with_order_by(self, value: Vec<FirestoreQueryOrder>) -> Self

pub fn without_order_by(self) -> Self

pub fn opt_order_by(self, value: Option<Vec<FirestoreQueryOrder>>) -> Self

pub fn filter(&mut self, value: FirestoreQueryFilter) -> &mut Self

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

pub fn mopt_filter(&mut self, value: Option<FirestoreQueryFilter>) -> &mut Self

pub fn with_filter(self, value: FirestoreQueryFilter) -> Self

pub fn without_filter(self) -> Self

pub fn opt_filter(self, value: Option<FirestoreQueryFilter>) -> Self

pub fn all_descendants(&mut self, value: bool) -> &mut Self

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

pub fn mopt_all_descendants(&mut self, value: Option<bool>) -> &mut Self

pub fn with_all_descendants(self, value: bool) -> Self

pub fn without_all_descendants(self) -> Self

pub fn opt_all_descendants(self, value: Option<bool>) -> Self

pub fn return_only_fields(&mut self, value: Vec<String>) -> &mut Self

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

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

pub fn with_return_only_fields(self, value: Vec<String>) -> Self

pub fn without_return_only_fields(self) -> Self

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

pub fn start_at(&mut self, value: FirestoreQueryCursor) -> &mut Self

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

pub fn mopt_start_at( &mut self, value: Option<FirestoreQueryCursor>, ) -> &mut Self

pub fn with_start_at(self, value: FirestoreQueryCursor) -> Self

pub fn without_start_at(self) -> Self

pub fn opt_start_at(self, value: Option<FirestoreQueryCursor>) -> Self

pub fn end_at(&mut self, value: FirestoreQueryCursor) -> &mut Self

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

pub fn mopt_end_at(&mut self, value: Option<FirestoreQueryCursor>) -> &mut Self

pub fn with_end_at(self, value: FirestoreQueryCursor) -> Self

pub fn without_end_at(self) -> Self

pub fn opt_end_at(self, value: Option<FirestoreQueryCursor>) -> Self

pub fn explain_options(&mut self, value: FirestoreExplainOptions) -> &mut Self

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

pub fn mopt_explain_options( &mut self, value: Option<FirestoreExplainOptions>, ) -> &mut Self

pub fn with_explain_options(self, value: FirestoreExplainOptions) -> Self

pub fn without_explain_options(self) -> Self

pub fn opt_explain_options(self, value: Option<FirestoreExplainOptions>) -> Self

pub fn find_nearest(&mut self, value: FirestoreFindNearestOptions) -> &mut Self

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

pub fn mopt_find_nearest( &mut self, value: Option<FirestoreFindNearestOptions>, ) -> &mut Self

pub fn with_find_nearest(self, value: FirestoreFindNearestOptions) -> Self

pub fn without_find_nearest(self) -> Self

pub fn opt_find_nearest( self, value: Option<FirestoreFindNearestOptions>, ) -> Self

pub fn request_options(&mut self, value: FirestoreRequestOptions) -> &mut Self

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

pub fn mopt_request_options( &mut self, value: Option<FirestoreRequestOptions>, ) -> &mut Self

pub fn with_request_options(self, value: FirestoreRequestOptions) -> Self

pub fn without_request_options(self) -> Self

pub fn opt_request_options(self, value: Option<FirestoreRequestOptions>) -> Self

Trait Implementations

impl Clone for FirestoreQueryParams

fn clone(&self) -> FirestoreQueryParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FirestoreQueryParams

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

Formats the value using the given formatter.

impl From<FirestoreQueryParamsInit> for FirestoreQueryParams

fn from(value: FirestoreQueryParamsInit) -> Self

Converts to this type from the input type.

impl PartialEq for FirestoreQueryParams

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FirestoreQueryParams

impl TryFrom<FirestoreQueryParams> for StructuredQuery

type Error = FirestoreError

The type returned in the event of a conversion error.

fn try_from(params: FirestoreQueryParams) -> Result<Self, Self::Error>

Performs the conversion.