Class: Gcloud::Datastore::Query

Inherits:
Object
  • Object
show all
Defined in:
lib/gcloud/datastore/query.rb

Overview

# Query

Represents the search criteria against a Datastore.

Examples:

query = Gcloud::Datastore::Query.new
query.kind("Task").
  where("done", "=", false).
  where("priority", ">=", 4).
  order("priority", :desc)

tasks = datastore.run query

See Also:

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Query

Returns a new query object.

Examples:

query = Gcloud::Datastore::Query.new


47
48
49
 
# File 'lib/gcloud/datastore/query.rb', line 47

def initialize
  @grpc = Google::Datastore::V1beta3::Query.new
end

Instance Method Details

#ancestor(parent) ⇒ Object

Add a filter for entities that inherit from a key.

Examples:

task_list_key = datastore.key "TaskList", "default"

query = Gcloud::Datastore::Query.new
query.kind("Task").
  ancestor(task_list_key)

tasks = datastore.run query


161
162
163
164
165
 
# File 'lib/gcloud/datastore/query.rb', line 161

def ancestor parent
  # Use key if given an entity
  parent = parent.key if parent.respond_to? :key
  where "__key__", "~", parent
end

#group_by(*names) ⇒ Object Also known as: distinct_on

Group results by a list of properties.

Examples:

query = Gcloud::Datastore::Query.new
query.kind("Task").
  distinct_on("type", "priority").
  order("type").
  order("priority")

tasks = datastore.run query


317
318
319
320
321
322
323
324
325
 
# File 'lib/gcloud/datastore/query.rb', line 317

def group_by *names
  names.each do |name|
    grpc_property = Google::Datastore::V1beta3::PropertyReference.new(
      name: name)
    @grpc.distinct_on << grpc_property
  end

  self
end

#kind(*kinds) ⇒ Object

Add the kind of entities to query.

Special entity kinds such as ‘__namespace__`, `__kind__`, and `__property__` can be used for [metadata queries](cloud.google.com/datastore/docs/concepts/metadataqueries).

Examples:

query = Gcloud::Datastore::Query.new
query.kind "Task"

tasks = datastore.run query


64
65
66
67
68
69
70
71
 
# File 'lib/gcloud/datastore/query.rb', line 64

def kind *kinds
  kinds.each do |kind|
    grpc_kind = Google::Datastore::V1beta3::KindExpression.new(name: kind)
    @grpc.kind << grpc_kind
  end

  self
end

#limit(num) ⇒ Object

Set a limit on the number of results to be returned.

Examples:

query = Gcloud::Datastore::Query.new
query.kind("Task").
  limit(5)

tasks = datastore.run query


224
225
226
227
228
 
# File 'lib/gcloud/datastore/query.rb', line 224

def limit num
  @grpc.limit = Google::Protobuf::Int32Value.new(value: num)

  self
end

#offset(num) ⇒ Object

Set an offset for the results to be returned.

Examples:

query = Gcloud::Datastore::Query.new
query.kind("Task").
  limit(5).
  offset(10)

tasks = datastore.run query


241
242
243
244
245
 
# File 'lib/gcloud/datastore/query.rb', line 241

def offset num
  @grpc.offset = num

  self
end

#order(name, direction = :asc) ⇒ Object

Sort the results by a property name. By default, an ascending sort order will be used. To sort in descending order, provide a second argument of a string or symbol that starts with “d”.

Examples:

With ascending sort order:

query = Gcloud::Datastore::Query.new
query.kind("Task").
  order("created")

tasks = datastore.run query

With descending sort order:

query = Gcloud::Datastore::Query.new
query.kind("Task").
  order("created", :desc)

tasks = datastore.run query

With multiple sort orders:

query = Gcloud::Datastore::Query.new
query.kind("Task").
  order("priority", :desc).
  order("created")

tasks = datastore.run query

A property used in an inequality filter must be ordered first:

query = Gcloud::Datastore::Query.new
query.kind("Task").
  where("priority", ">", 3).
  order("priority").
  order("created")

tasks = datastore.run query


204
205
206
207
208
209
210
211
212
 
# File 'lib/gcloud/datastore/query.rb', line 204

def order name, direction = :asc
  @grpc.order << Google::Datastore::V1beta3::PropertyOrder.new(
    property: Google::Datastore::V1beta3::PropertyReference.new(
      name: name),
    direction: prop_order_direction(direction)
  )

  self
end

#select(*names) ⇒ Object Also known as: projection

Retrieve only select properties from the matched entities.

Examples:

query = Gcloud::Datastore::Query.new
query.kind("Task").
  select("priority", "percent_complete")

priorities = []
percent_completes = []
datastore.run(query).each do |task|
  priorities << task["priority"]
  percent_completes << task["percent_complete"]
end

A keys-only query using the special property ‘__key__`:

query = Gcloud::Datastore::Query.new
query.kind("Task").
  select("__key__")

keys = datastore.run(query).map(&:key)


293
294
295
296
297
298
299
300
301
302
 
# File 'lib/gcloud/datastore/query.rb', line 293

def select *names
  names.each do |name|
    grpc_projection = Google::Datastore::V1beta3::Projection.new(
      property: Google::Datastore::V1beta3::PropertyReference.new(
        name: name))
    @grpc.projection << grpc_projection
  end

  self
end

#start(cursor) ⇒ Object Also known as: cursor

Set the cursor to start the results at.

Examples:

query = Gcloud::Datastore::Query.new
query.kind("Task").
  limit(page_size).
  start(page_cursor)

tasks = datastore.run query


258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/gcloud/datastore/query.rb', line 258

def start cursor
  if cursor.is_a? Cursor
    @grpc.start_cursor = cursor.to_grpc
  elsif cursor.is_a? String
    @grpc.start_cursor = GRPCUtils.decode_bytes cursor
  else
    fail ArgumentError, "Can't set a cursor using a #{cursor.class}."
  end

  self
end

#to_grpc ⇒ Object 



329
330
331
 
# File 'lib/gcloud/datastore/query.rb', line 329

def to_grpc
  @grpc
end

#where(name, operator, value) ⇒ Object Also known as: filter

Add a property filter to the query.

Examples:

query = Gcloud::Datastore::Query.new
query.kind("Task").
  where("done", "=", false)

tasks = datastore.run query

Add a composite property filter:

query = Gcloud::Datastore::Query.new
query.kind("Task").
  where("done", "=", false).
  where("priority", ">=", 4)

tasks = datastore.run query

Add an inequality filter on a single property only:

query = Gcloud::Datastore::Query.new
query.kind("Task").
  where("created", ">=", Time.utc(1990, 1, 1)).
  where("created", "<", Time.utc(2000, 1, 1))

tasks = datastore.run query

Add a composite filter on an array property:

query = Gcloud::Datastore::Query.new
query.kind("Task").
  where("tag", "=", "fun").
  where("tag", "=", "programming")

tasks = datastore.run query

Add an inequality filter on an array property :

query = Gcloud::Datastore::Query.new
query.kind("Task").
  where("tag", ">", "learn").
  where("tag", "<", "math")

tasks = datastore.run query

Add a key filter using the special property ‘__key__`:

query = Gcloud::Datastore::Query.new
query.kind("Task").
  where("__key__", ">", datastore.key("Task", "someTask"))

tasks = datastore.run query

Add a key filter to a kindless query:

last_seen_key = datastore.key "Task", "a"
query = Gcloud::Datastore::Query.new
query.where("__key__", ">", last_seen_key)

tasks = datastore.run query


129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/gcloud/datastore/query.rb', line 129

def where name, operator, value
  @grpc.filter ||= Google::Datastore::V1beta3::Filter.new(
    composite_filter: Google::Datastore::V1beta3::CompositeFilter.new(
      op: :AND
    )
  )
  @grpc.filter.composite_filter.filters << \
    Google::Datastore::V1beta3::Filter.new(
      property_filter: Google::Datastore::V1beta3::PropertyFilter.new(
        property: Google::Datastore::V1beta3::PropertyReference.new(
          name: name),
        op: GRPCUtils.to_prop_filter_op(operator),
        value: GRPCUtils.to_value(value)
      )
    )

  self
end