Struct google_firestore1_beta1::StructuredQuery
[−]
[src]
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 inorder_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
becomesSELECT * FROM Foo ORDER BY A, __name__
SELECT * FROM Foo ORDER BY A DESC
becomesSELECT * FROM Foo ORDER BY A DESC, __name__ DESC
SELECT * FROM Foo WHERE A > 1
becomesSELECT * 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 Default for StructuredQuery
[src]
fn default() -> StructuredQuery
[src]
Returns the "default value" for a type. Read more
impl Clone for StructuredQuery
[src]
fn clone(&self) -> StructuredQuery
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more