Struct googapis::google::firestore::v1::StructuredQuery [−][src]
pub struct StructuredQuery {
pub select: Option<Projection>,
pub from: Vec<CollectionSelector>,
pub where: Option<Filter>,
pub order_by: Vec<Order>,
pub start_at: Option<Cursor>,
pub end_at: Option<Cursor>,
pub offset: i32,
pub limit: Option<i32>,
}
Expand description
A Firestore query.
Fields
select: Option<Projection>
The projection to return.
from: Vec<CollectionSelector>
The collections to query.
where: Option<Filter>
The filter to apply.
order_by: 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.
offset: i32
The number of results to skip.
Applies before limit, but after all other constraints. Must be >= 0 if specified.
limit: Option<i32>
The maximum number of results to return.
Applies after all other constraints. Must be >= 0 if specified.
Trait Implementations
fn merge_field<B>(
&mut self,
tag: u32,
wire_type: WireType,
buf: &mut B,
ctx: DecodeContext
) -> Result<(), DecodeError> where
B: Buf,
Returns the encoded length of the message without a length delimiter.
Encodes the message to a buffer. Read more
Encodes the message to a newly allocated buffer.
Encodes the message with a length-delimiter to a buffer. Read more
Encodes the message with a length-delimiter to a newly allocated buffer.
Decodes an instance of the message from a buffer. Read more
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
Decodes a length-delimited instance of the message from the buffer.
Decodes an instance of the message from a buffer, and merges it into self
. Read more
Decodes a length-delimited instance of the message from buffer, and
merges it into self
. Read more
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for StructuredQuery
impl Send for StructuredQuery
impl Sync for StructuredQuery
impl Unpin for StructuredQuery
impl UnwindSafe for StructuredQuery
Blanket Implementations
Mutably borrows from an owned value. Read more
Wrap the input message T
in a tonic::Request
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more