Reference documentation and code samples for the Firestore in Datastore mode V1 API class Google::Cloud::Datastore::V1::Query.
A query for entities.
The query stages are executed in the following order:
- kind
- filter
- projection
- order + start_cursor + end_cursor
- offset
- limit
- find_nearest
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#distinct_on
def distinct_on() -> ::Array<::Google::Cloud::Datastore::V1::PropertyReference>
Returns
-
(::Array<::Google::Cloud::Datastore::V1::PropertyReference>) —
The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).
Requires:
- If
orderis specified, the set of distinct on properties must appear before the non-distinct on properties inorder.
- If
#distinct_on=
def distinct_on=(value) -> ::Array<::Google::Cloud::Datastore::V1::PropertyReference>
Parameter
-
value (::Array<::Google::Cloud::Datastore::V1::PropertyReference>) —
The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).
Requires:
- If
orderis specified, the set of distinct on properties must appear before the non-distinct on properties inorder.
- If
Returns
-
(::Array<::Google::Cloud::Datastore::V1::PropertyReference>) —
The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).
Requires:
- If
orderis specified, the set of distinct on properties must appear before the non-distinct on properties inorder.
- If
#end_cursor
def end_cursor() -> ::String
Returns
- (::String) — An ending point for the query results. Query cursors are returned in query result batches and can only be used to limit the same query.
#end_cursor=
def end_cursor=(value) -> ::String
Parameter
- value (::String) — An ending point for the query results. Query cursors are returned in query result batches and can only be used to limit the same query.
Returns
- (::String) — An ending point for the query results. Query cursors are returned in query result batches and can only be used to limit the same query.
#filter
def filter() -> ::Google::Cloud::Datastore::V1::Filter
Returns
- (::Google::Cloud::Datastore::V1::Filter) — The filter to apply.
#filter=
def filter=(value) -> ::Google::Cloud::Datastore::V1::Filter
Parameter
- value (::Google::Cloud::Datastore::V1::Filter) — The filter to apply.
Returns
- (::Google::Cloud::Datastore::V1::Filter) — The filter to apply.
#find_nearest
def find_nearest() -> ::Google::Cloud::Datastore::V1::FindNearest
Returns
-
(::Google::Cloud::Datastore::V1::FindNearest) — Optional. A potential Nearest Neighbors Search.
Applies after all other filters and ordering.
Finds the closest vector embeddings to the given query vector.
#find_nearest=
def find_nearest=(value) -> ::Google::Cloud::Datastore::V1::FindNearest
Parameter
-
value (::Google::Cloud::Datastore::V1::FindNearest) — Optional. A potential Nearest Neighbors Search.
Applies after all other filters and ordering.
Finds the closest vector embeddings to the given query vector.
Returns
-
(::Google::Cloud::Datastore::V1::FindNearest) — Optional. A potential Nearest Neighbors Search.
Applies after all other filters and ordering.
Finds the closest vector embeddings to the given query vector.
#kind
def kind() -> ::Array<::Google::Cloud::Datastore::V1::KindExpression>
Returns
- (::Array<::Google::Cloud::Datastore::V1::KindExpression>) — The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.
#kind=
def kind=(value) -> ::Array<::Google::Cloud::Datastore::V1::KindExpression>
Parameter
- value (::Array<::Google::Cloud::Datastore::V1::KindExpression>) — The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.
Returns
- (::Array<::Google::Cloud::Datastore::V1::KindExpression>) — The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.
#limit
def limit() -> ::Google::Protobuf::Int32Value
Returns
- (::Google::Protobuf::Int32Value) — The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified.
#limit=
def limit=(value) -> ::Google::Protobuf::Int32Value
Parameter
- value (::Google::Protobuf::Int32Value) — The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified.
Returns
- (::Google::Protobuf::Int32Value) — The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified.
#offset
def offset() -> ::Integer
Returns
- (::Integer) — The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be >= 0 if specified.
#offset=
def offset=(value) -> ::Integer
Parameter
- value (::Integer) — The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be >= 0 if specified.
Returns
- (::Integer) — The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be >= 0 if specified.
#order
def order() -> ::Array<::Google::Cloud::Datastore::V1::PropertyOrder>
Returns
- (::Array<::Google::Cloud::Datastore::V1::PropertyOrder>) — The order to apply to the query results (if empty, order is unspecified).
#order=
def order=(value) -> ::Array<::Google::Cloud::Datastore::V1::PropertyOrder>
Parameter
- value (::Array<::Google::Cloud::Datastore::V1::PropertyOrder>) — The order to apply to the query results (if empty, order is unspecified).
Returns
- (::Array<::Google::Cloud::Datastore::V1::PropertyOrder>) — The order to apply to the query results (if empty, order is unspecified).
#projection
def projection() -> ::Array<::Google::Cloud::Datastore::V1::Projection>
Returns
- (::Array<::Google::Cloud::Datastore::V1::Projection>) — The projection to return. Defaults to returning all properties.
#projection=
def projection=(value) -> ::Array<::Google::Cloud::Datastore::V1::Projection>
Parameter
- value (::Array<::Google::Cloud::Datastore::V1::Projection>) — The projection to return. Defaults to returning all properties.
Returns
- (::Array<::Google::Cloud::Datastore::V1::Projection>) — The projection to return. Defaults to returning all properties.
#start_cursor
def start_cursor() -> ::String
Returns
- (::String) — A starting point for the query results. Query cursors are returned in query result batches and can only be used to continue the same query.
#start_cursor=
def start_cursor=(value) -> ::String
Parameter
- value (::String) — A starting point for the query results. Query cursors are returned in query result batches and can only be used to continue the same query.
Returns
- (::String) — A starting point for the query results. Query cursors are returned in query result batches and can only be used to continue the same query.