View Source GoogleApi.Firestore.V1beta1.Model.RunQueryRequest (google_api_firestore v0.26.0)

The request for Firestore.RunQuery.

Attributes

  • explainOptions (type: GoogleApi.Firestore.V1beta1.Model.ExplainOptions.t, default: nil) - Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.
  • newTransaction (type: GoogleApi.Firestore.V1beta1.Model.TransactionOptions.t, default: nil) - 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.
  • readTime (type: DateTime.t, default: nil) - 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.
  • structuredQuery (type: GoogleApi.Firestore.V1beta1.Model.StructuredQuery.t, default: nil) - A structured query.
  • transaction (type: String.t, default: nil) - Run the query within an already active transaction. The value here is the opaque transaction ID to execute the query in.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() :: %GoogleApi.Firestore.V1beta1.Model.RunQueryRequest{
  explainOptions: GoogleApi.Firestore.V1beta1.Model.ExplainOptions.t() | nil,
  newTransaction:
    GoogleApi.Firestore.V1beta1.Model.TransactionOptions.t() | nil,
  readTime: DateTime.t() | nil,
  structuredQuery: GoogleApi.Firestore.V1beta1.Model.StructuredQuery.t() | nil,
  transaction: String.t() | nil
}

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.