Struct RunQueryRequest

pub struct RunQueryRequest {
    pub explain_options: Option<ExplainOptions>,
    pub new_transaction: Option<TransactionOptions>,
    pub read_time: Option<DateTime<Utc>>,
    pub structured_query: Option<StructuredQuery>,
    pub transaction: Option<Vec<u8>>,
}

The request for Firestore.RunQuery.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• databases documents run query projects (request)

Fields

explain_options: Option<ExplainOptions>

Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.

new_transaction: Option<TransactionOptions>

Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.

read_time: Option<DateTime<Utc>>

Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

structured_query: Option<StructuredQuery>

A structured query.

transaction: Option<Vec<u8>>

Run the query within an already active transaction. The value here is the opaque transaction ID to execute the query in.

Trait Implementations

impl Clone for RunQueryRequest

fn clone(&self) -> RunQueryRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunQueryRequest

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

Formats the value using the given formatter.

impl Default for RunQueryRequest

fn default() -> RunQueryRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RunQueryRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RunQueryRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl RequestValue for RunQueryRequest