Firestore in Datastore mode V1 API - Class Google::Cloud::Datastore::V1::Query (v0.13.1)

Reference documentation and code samples for the Firestore in Datastore mode V1 API class Google::Cloud::Datastore::V1::Query.

A query for entities.

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 order is specified, the set of distinct on properties must appear before the non-distinct on properties in order.

#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 order is specified, the set of distinct on properties must appear before the non-distinct on properties in order.
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 order is specified, the set of distinct on properties must appear before the non-distinct on properties in order.

#end_cursor

def end_cursor() -> ::String
Returns

#end_cursor=

def end_cursor=(value) -> ::String
Parameter
Returns

#filter

def filter() -> ::Google::Cloud::Datastore::V1::Filter
Returns

#filter=

def filter=(value) -> ::Google::Cloud::Datastore::V1::Filter
Parameter
Returns

#kind

def kind() -> ::Array<::Google::Cloud::Datastore::V1::KindExpression>
Returns

#kind=

def kind=(value) -> ::Array<::Google::Cloud::Datastore::V1::KindExpression>
Parameter
Returns

#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

#order=

def order=(value) -> ::Array<::Google::Cloud::Datastore::V1::PropertyOrder>
Parameter
Returns

#projection

def projection() -> ::Array<::Google::Cloud::Datastore::V1::Projection>
Returns

#projection=

def projection=(value) -> ::Array<::Google::Cloud::Datastore::V1::Projection>
Parameter
Returns

#start_cursor

def start_cursor() -> ::String
Returns

#start_cursor=

def start_cursor=(value) -> ::String
Parameter
Returns