class Google::Cloud::Firestore::DocumentReference::List

DocumentReference::List is a special case Array with additional values.

@example

require "google/cloud/firestore"

firestore = Google::Cloud::Firestore.new

col = firestore.col "cities"

doc_refs = col.list_documents

doc_refs.each do |doc_ref|
  puts doc_ref.document_id
end

Attributes

token[RW]

If not empty, indicates that there are more records that match the request and this value should be passed to continue.

Public Class Methods

from_grpc(grpc, client, parent, collection_id, max = nil) click to toggle source

@private New DocumentReference::List from a Google::Cloud::Firestore::V1::ListDocumentsResponse object.

# File lib/google/cloud/firestore/document_reference/list.rb, line 165
def self.from_grpc grpc, client, parent, collection_id, max = nil
  documents = List.new(Array(grpc.documents).map do |document|
    DocumentReference.from_path document.name, client
  end)
  documents.instance_variable_set :@parent, parent
  documents.instance_variable_set :@collection_id, collection_id
  token = grpc.next_page_token
  token = nil if token == ""
  documents.instance_variable_set :@token, token
  documents.instance_variable_set :@client, client
  documents.instance_variable_set :@max, max
  documents
end
new(arr = []) click to toggle source

@private Create a new DocumentReference::List with an array of DocumentReference instances.

Calls superclass method
# File lib/google/cloud/firestore/document_reference/list.rb, line 48
def initialize arr = []
  super arr
end

Public Instance Methods

all(request_limit: nil, &block) click to toggle source

Retrieves remaining results by repeatedly invoking {#next} until {#next?} returns `false`. Calls the given block once for each result, which is passed as the argument to the block.

An Enumerator is returned if no block is given.

This method will make repeated API calls until all remaining results are retrieved. (Unlike `#each`, for example, which merely iterates over the results returned by a single API call.) Use with caution.

@param [Integer] request_limit The upper limit of API requests to

make to load all document references. Default is no limit.

@yield [document] The block for accessing each document. @yieldparam [DocumentReference] document The document reference

object.

@return [Enumerator]

@example Iterating each document reference by passing a block or proc:

require "google/cloud/firestore"

firestore = Google::Cloud::Firestore.new
col = firestore.col "cities"

doc_refs = col.list_documents
doc_refs.all do |doc_ref|
  puts doc_ref.document_id
end

@example Using the enumerator by not passing a block:

require "google/cloud/firestore"

firestore = Google::Cloud::Firestore.new
col = firestore.col "cities"

doc_refs = col.list_documents
all_document_ids = doc_refs.all.map do |doc_ref|
  doc_ref.document_id
end

@example Limit the number of API calls made:

require "google/cloud/firestore"

firestore = Google::Cloud::Firestore.new
col = firestore.col "cities"

doc_refs = col.list_documents
doc_refs.all(request_limit: 10) do |doc_ref|
  puts doc_ref.document_id
end
# File lib/google/cloud/firestore/document_reference/list.rb, line 145
def all request_limit: nil, &block
  request_limit = request_limit.to_i if request_limit
  unless block_given?
    return enum_for :all, request_limit: request_limit
  end
  results = self
  loop do
    results.each(&block)
    if request_limit
      request_limit -= 1
      break if request_limit.negative?
    end
    break unless results.next?
    results = results.next
  end
end
next() click to toggle source

Retrieve the next page of document references.

@return [DocumentReference::List]

@example

require "google/cloud/firestore"

firestore = Google::Cloud::Firestore.new
col = firestore.col "cities"

doc_refs = col.list_documents
if doc_refs.next?
  next_documents = doc_refs.next
end
# File lib/google/cloud/firestore/document_reference/list.rb, line 86
def next
  return nil unless next?
  ensure_client!
  grpc = @client.service.list_documents @parent, @collection_id, token: token, max: @max
  self.class.from_grpc grpc, @client, @parent, @collection_id, @max
end
next?() click to toggle source

Whether there is a next page of document references.

@return [Boolean]

@example

require "google/cloud/firestore"

firestore = Google::Cloud::Firestore.new
col = firestore.col "cities"

doc_refs = col.list_documents
if doc_refs.next?
  next_documents = doc_refs.next
end
# File lib/google/cloud/firestore/document_reference/list.rb, line 67
def next?
  !token.nil?
end

Protected Instance Methods

ensure_client!() click to toggle source

Raise an error unless an active client is available.

# File lib/google/cloud/firestore/document_reference/list.rb, line 183
def ensure_client!
  raise "Must have active connection" unless @client
end