Struct google_api_proto::google::firestore::v1beta1::StructuredQuery

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>,
}

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 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.

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

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 Default for StructuredQuery

fn default() -> Self

Returns the “default value” for a type.

impl Message for StructuredQuery

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for StructuredQuery

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for StructuredQuery