Method: ActiveModel::Datastore::ClassMethods#all

Defined in:
lib/active_model/datastore.rb

#all(options = {}) ⇒ Array<Model>, String

Queries entities from Cloud Datastore by named kind and using the provided options. When a limit option is provided queries up to the limit and returns results with a cursor.

This method may make several API calls until all query results are retrieved. The run method returns a QueryResults object, which is a special case Array with additional values. QueryResults are returned in batches, and the batch size is determined by the Datastore API. Batch size is not guaranteed. It will be affected by the size of the data being returned, and by other forces such as how distributed and/or consistent the data in Datastore is. Calling all on the QueryResults retrieves all results by repeatedly loading #next until #next? returns false. The all method returns an enumerator which from_entities iterates on.

Be sure to use as narrow a search criteria as possible. Please use with caution.

or if options was provided:

Parameters:

  • options (Hash) (defaults to: {}) —

    The options to construct the query with.

Options Hash (options):

  • :ancestor (Google::Cloud::Datastore::Key) —

    Filter for inherited results.

  • :cursor (String) —

    Sets the cursor to start the results at.

  • :limit (Integer) —

    Sets a limit to the number of results to be returned.

  • :order (String) —

    Sort the results by property name.

  • :desc_order (String) —

    Sort the results by descending property name.

  • :select (Array) —

    Retrieve only select properties from the matched entities.

  • :distinct_on (Array) —

    Group results by a list of properties.

  • :where (Array) —

    Adds a property filter of arrays in the format [name, operator, value].

Returns:

  • (Array<Model>, String) —

    An array of ActiveModel results

  • (Array<Model>, String) —

    An array of ActiveModel results and a cursor that can be used to query for additional results.



300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/active_model/datastore.rb', line 300

def all(options = {})
  next_cursor = nil
  query = build_query(options)
  query_results = retry_on_exception(operation: 'run query') do
    CloudDatastore.dataset.run query
  end
  if options[:limit]
    next_cursor = query_results.cursor if query_results.size == options[:limit]
    return from_entities(query_results.all), next_cursor
  end
  from_entities(query_results.all)
end