google-cloud-firestore - Class Google::Cloud::Firestore::DocumentReference::List (v2.6.6)

Reference documentation and code samples for the google-cloud-firestore class Google::Cloud::Firestore::DocumentReference::List.

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

Inherits

  • Array

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

Methods

#all

def all(request_limit: nil, &block) { |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.

Parameter
  • 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 Parameter
Returns
  • (Enumerator)
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

#next

def next() -> DocumentReference::List

Retrieve the next page of document references.

Returns
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

#next?

def next?() -> Boolean

Whether there is a next page of document references.

Returns
  • (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

#token

def token()

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

#token=

def token=(value)

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