Struct google_firestore1_beta1::StructuredQuery

pub struct StructuredQuery {
    pub order_by: Option<Vec<Order>>,
    pub start_at: Option<Cursor>,
    pub end_at: Option<Cursor>,
    pub limit: Option<i32>,
    pub offset: Option<i32>,
    pub from: Option<Vec<CollectionSelector>>,
    pub where_: Option<Filter>,
    pub select: Option<Projection>,
}

A Firestore query.

This type is not used in any activity, and only used as part of another schema.

Fields

order_by: Option<Vec<Order>>

The order to apply to the query results.

Firestore guarantees a stable ordering through the following rules:

• Any field required to appear in order_by, that is not already specified in order_by, is appended to the order in field name order by default.
• If an order on __name__ is not specified, it is appended by default.

Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example:

• SELECT * FROM Foo ORDER BY A becomes SELECT * FROM Foo ORDER BY A, __name__
• SELECT * FROM Foo ORDER BY A DESC becomes SELECT * FROM Foo ORDER BY A DESC, __name__ DESC
• SELECT * FROM Foo WHERE A > 1 becomes SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__

start_at: Option<Cursor>

A starting point for the query results.

end_at: Option<Cursor>

A end point for the query results.

limit: Option<i32>

The maximum number of results to return.

Applies after all other constraints. Must be >= 0 if specified.

offset: Option<i32>

The number of results to skip.

Applies before limit, but after all other constraints. Must be >= 0 if specified.

from: Option<Vec<CollectionSelector>>

The collections to query.

where_: Option<Filter>

The filter to apply.

select: Option<Projection>

The projection to return.

Trait Implementations

impl Part for StructuredQuery

impl Default for StructuredQuery

fn default() -> StructuredQuery

Returns the "default value" for a type.

impl Clone for StructuredQuery

fn clone(&self) -> StructuredQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StructuredQuery

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

Formats the value using the given formatter.

impl Serialize for StructuredQuery

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for StructuredQuery

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.