Class: Google::Datastore::V1::Query

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/datastore/v1/doc/google/datastore/v1/query.rb

Overview

A query for entities.

Instance Attribute Summary collapse

Instance Attribute Details

#distinct_on ⇒ Array<Google::Datastore::V1::PropertyReference>

Returns 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).

Returns:

  • (Array<Google::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).



97
 
# File 'lib/google/cloud/datastore/v1/doc/google/datastore/v1/query.rb', line 97

class Query; end

#end_cursor ⇒ String

An ending point for the query results. Query cursors are returned in query result batches and only be used to limit the same query[https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets].

Returns:



97
 
# File 'lib/google/cloud/datastore/v1/doc/google/datastore/v1/query.rb', line 97

class Query; end

#filter ⇒ Google::Datastore::V1::Filter

Returns The filter to apply.

Returns:



97
 
# File 'lib/google/cloud/datastore/v1/doc/google/datastore/v1/query.rb', line 97

class Query; end

#kind ⇒ Array<Google::Datastore::V1::KindExpression>

Returns The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.

Returns:



97
 
# File 'lib/google/cloud/datastore/v1/doc/google/datastore/v1/query.rb', line 97

class Query; end

#limit ⇒ Google::Protobuf::Int32Value

Returns 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.



97
 
# File 'lib/google/cloud/datastore/v1/doc/google/datastore/v1/query.rb', line 97

class Query; end

#offset ⇒ Integer

Returns 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.



97
 
# File 'lib/google/cloud/datastore/v1/doc/google/datastore/v1/query.rb', line 97

class Query; end

#order ⇒ Array<Google::Datastore::V1::PropertyOrder>

Returns The order to apply to the query results (if empty, order is unspecified).

Returns:



97
 
# File 'lib/google/cloud/datastore/v1/doc/google/datastore/v1/query.rb', line 97

class Query; end

#projection ⇒ Array<Google::Datastore::V1::Projection>

Returns The projection to return. Defaults to returning all properties.

Returns:



97
 
# File 'lib/google/cloud/datastore/v1/doc/google/datastore/v1/query.rb', line 97

class Query; end

#start_cursor ⇒ String

A starting point for the query results. Query cursors are returned in query result batches and only be used to continue the same query[https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets].

Returns:



97
 
# File 'lib/google/cloud/datastore/v1/doc/google/datastore/v1/query.rb', line 97

class Query; end