Class: Google::Cloud::Firestore::DocumentReference::List

Inherits:
Array
  • Object
show all
Defined in:
lib/google/cloud/firestore/document_reference/list.rb

Overview

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

Examples:

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#token ⇒ Object

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



43
44
45
 
# File 'lib/google/cloud/firestore/document_reference/list.rb', line 43

def token
  @token
end

Instance Method Details

#all(request_limit: nil) {|document| ... } ⇒ Enumerator

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.

Examples:

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

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

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

Parameters:

  • request_limit (Integer) (defaults to: nil) —

    The upper limit of API requests to make to load all document references. Default is no limit.

Yields:

  • (document) —

    The block for accessing each document.

Yield Parameters:

Returns:

  • (Enumerator) 


146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/google/cloud/firestore/document_reference/list.rb', line 146

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 ⇒ DocumentReference::List

Retrieve the next page of document references.

Examples:

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

Returns:



86
87
88
89
90
91
92
 
# 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, \
    read_time: @read_time
  self.class.from_grpc grpc, @client, @parent, @collection_id, @max, read_time: @read_time
end

#next? ⇒ Boolean

Whether there is a next page of document references.

Examples:

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

Returns:

  • (Boolean) 


67
68
69
 
# File 'lib/google/cloud/firestore/document_reference/list.rb', line 67

def next?
  !token.nil?
end