View Source GoogleApi.Firestore.V1beta1.Model.StructuredQuery (google_api_firestore v0.27.0)
A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit
Attributes
-
endAt
(type:GoogleApi.Firestore.V1beta1.Model.Cursor.t
, default:nil
) - A potential prefix of a position in the result set to end the query at. This is similar toSTART_AT
but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in theORDER BY
clause. -
findNearest
(type:GoogleApi.Firestore.V1beta1.Model.FindNearest.t
, default:nil
) - Optional. A potential Nearest Neighbors Search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. -
from
(type:list(GoogleApi.Firestore.V1beta1.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. Requires: * The value must be greater than or equal to zero if specified. -
offset
(type:integer()
, default:nil
) - The number of documents to skip before returning the first result. This applies after the constraints specified by theWHERE
,START AT
, &END AT
but before theLIMIT
clause. Requires: * The value must be greater than or equal to zero if specified. -
orderBy
(type:list(GoogleApi.Firestore.V1beta1.Model.Order.t)
, default:nil
) - The order to apply to the query results. Firestore allows callers to provide a full ordering, a partial ordering, or no ordering at all. In all cases, Firestore guarantees a stable ordering through the following rules: Theorder_by
is required to reference all fields used with an inequality filter. All fields that are required to be in theorder_by
but are not already present are appended in lexicographical ordering of the field name. 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:ORDER BY a
becomesORDER BY a ASC, __name__ ASC
ORDER BY a DESC
becomesORDER BY a DESC, __name__ DESC
WHERE a > 1
becomesWHERE a > 1 ORDER BY a ASC, __name__ ASC
*WHERE __name__ > ... AND a > 1
becomesWHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC
-
select
(type:GoogleApi.Firestore.V1beta1.Model.Projection.t
, default:nil
) - Optional sub-set of the fields to return. This acts as a DocumentMask over the documents returned from a query. When not set, assumes that the caller wants all fields returned. -
startAt
(type:GoogleApi.Firestore.V1beta1.Model.Cursor.t
, default:nil
) - A potential prefix of a position in the result set to start the query at. The ordering of the result set is based on theORDER BY
clause of the original query.SELECT * FROM k WHERE a = 1 AND b > 2 ORDER BY b ASC, __name__ ASC;
This query's results are ordered by(b ASC, __name__ ASC)
. Cursors can reference either the full ordering or a prefix of the location, though it cannot reference more fields than what are in the providedORDER BY
. Continuing off the example above, attaching the following start cursors will have varying impact: -START BEFORE (2, /k/123)
: start the query right beforea = 1 AND b > 2 AND __name__ > /k/123
. -START AFTER (10)
: start the query right aftera = 1 AND b > 10
. UnlikeOFFSET
which requires scanning over the first N results to skip, a start cursor allows the query to begin at a logical position. This position is not required to match an actual result, it will scan forward from this position to find the next document. Requires: * The number of values cannot be greater than the number of fields specified in theORDER BY
clause. -
where
(type:GoogleApi.Firestore.V1beta1.Model.Filter.t
, default:nil
) - The filter to apply.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.Firestore.V1beta1.Model.StructuredQuery{ endAt: GoogleApi.Firestore.V1beta1.Model.Cursor.t() | nil, findNearest: GoogleApi.Firestore.V1beta1.Model.FindNearest.t() | nil, from: [GoogleApi.Firestore.V1beta1.Model.CollectionSelector.t()] | nil, limit: integer() | nil, offset: integer() | nil, orderBy: [GoogleApi.Firestore.V1beta1.Model.Order.t()] | nil, select: GoogleApi.Firestore.V1beta1.Model.Projection.t() | nil, startAt: GoogleApi.Firestore.V1beta1.Model.Cursor.t() | nil, where: GoogleApi.Firestore.V1beta1.Model.Filter.t() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.