GoogleApi.Firestore.V1.Model.StructuredQuery (google_api_firestore v0.21.3) View Source

A Firestore query.


  • endAt (type: GoogleApi.Firestore.V1.Model.Cursor.t, default: nil) - A end point for the query results.
  • from (type: list(GoogleApi.Firestore.V1.Model.CollectionSelector.t), default: nil) - The collections to query.
  • limit (type: integer(), default: nil) - The maximum number of results to return. Applies after all other constraints. Must be >= 0 if specified.
  • offset (type: integer(), default: nil) - The number of results to skip. Applies before limit, but after all other constraints. Must be >= 0 if specified.
  • orderBy (type: list(GoogleApi.Firestore.V1.Model.Order.t), default: nil) - 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 AbecomesSELECT 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 > 1becomesSELECT * FROM Foo WHERE A > 1 ORDER BY A, name`
  • select (type: GoogleApi.Firestore.V1.Model.Projection.t, default: nil) - The projection to return.
  • startAt (type: GoogleApi.Firestore.V1.Model.Cursor.t, default: nil) - A starting point for the query results.
  • where (type: GoogleApi.Firestore.V1.Model.Filter.t, default: nil) - The filter to apply.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.Firestore.V1.Model.StructuredQuery{
  endAt: GoogleApi.Firestore.V1.Model.Cursor.t() | nil,
  from: [GoogleApi.Firestore.V1.Model.CollectionSelector.t()] | nil,
  limit: integer() | nil,
  offset: integer() | nil,
  orderBy: [GoogleApi.Firestore.V1.Model.Order.t()] | nil,
  select: GoogleApi.Firestore.V1.Model.Projection.t() | nil,
  startAt: GoogleApi.Firestore.V1.Model.Cursor.t() | nil,
  where: GoogleApi.Firestore.V1.Model.Filter.t() | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.