Class: Google::Cloud::Firestore::V1beta1::FirestoreClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/firestore/v1beta1/firestore_client.rb

Overview

The Cloud Firestore service.

This service exposes several types of comparable timestamps:

  • +create_time+ - The time at which a document was created. Changes only when a document is deleted, then re-created. Increases in a strict monotonic fashion.
  • +update_time+ - The time at which a document was last updated. Changes every time a document is modified. Does not change when a write results in no modifications. Increases in a strict monotonic fashion.
  • +read_time+ - The time at which a particular state was observed. Used to denote a consistent snapshot of the database or the time at which a Document was observed to not exist.
  • +commit_time+ - The time at which the writes in a transaction were committed. Any read with an equal or greater +read_time+ is guaranteed to see the effects of the transaction.

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"firestore.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
GRPC_INTERCEPTORS =

The default set of gRPC interceptors.

[]
DEFAULT_TIMEOUT = 
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform",
  "https://www.googleapis.com/auth/datastore"
].freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ FirestoreClient

Returns a new instance of FirestoreClient

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) —

    Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash) —

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric) —

    The default timeout, in seconds, for calls made through this client.

  • metadata (Hash) —

    Default metadata to be sent with each request. This can be overridden on a per call basis.

  • exception_transformer (Proc) —

    An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 193

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: nil,
    exception_transformer: nil,
    lib_name: nil,
    lib_version: ""
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "google/gax/grpc"
  require "google/firestore/v1beta1/firestore_services_pb"

  credentials ||= Google::Cloud::Firestore::V1beta1::Credentials.default

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Firestore::V1beta1::Credentials.new(credentials).updater_proc
  end
  if credentials.is_a?(GRPC::Core::Channel)
    channel = credentials
  end
  if credentials.is_a?(GRPC::Core::ChannelCredentials)
    chan_creds = credentials
  end
  if credentials.is_a?(Proc)
    updater_proc = credentials
  end
  if credentials.is_a?(Google::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  package_version = Gem.loaded_specs['google-cloud-firestore'].version.version

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  headers.merge!(metadata) unless metadata.nil?
  client_config_file = Pathname.new(__dir__).join(
    "firestore_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.firestore.v1beta1.Firestore",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      page_descriptors: PAGE_DESCRIPTORS,
      errors: Google::Gax::Grpc::API_ERRORS,
      metadata: headers
    )
  end

  # Allow overriding the service path/port in subclasses.
  service_path = self.class::SERVICE_ADDRESS
  port = self.class::DEFAULT_SERVICE_PORT
  interceptors = self.class::GRPC_INTERCEPTORS
  @firestore_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    interceptors: interceptors,
    &Google::Firestore::V1beta1::Firestore::Stub.method(:new)
  )

  @get_document = Google::Gax.create_api_call(
    @firestore_stub.method(:get_document),
    defaults["get_document"],
    exception_transformer: exception_transformer
  )
  @list_documents = Google::Gax.create_api_call(
    @firestore_stub.method(:list_documents),
    defaults["list_documents"],
    exception_transformer: exception_transformer
  )
  @create_document = Google::Gax.create_api_call(
    @firestore_stub.method(:create_document),
    defaults["create_document"],
    exception_transformer: exception_transformer
  )
  @update_document = Google::Gax.create_api_call(
    @firestore_stub.method(:update_document),
    defaults["update_document"],
    exception_transformer: exception_transformer
  )
  @delete_document = Google::Gax.create_api_call(
    @firestore_stub.method(:delete_document),
    defaults["delete_document"],
    exception_transformer: exception_transformer
  )
  @batch_get_documents = Google::Gax.create_api_call(
    @firestore_stub.method(:batch_get_documents),
    defaults["batch_get_documents"],
    exception_transformer: exception_transformer
  )
  @begin_transaction = Google::Gax.create_api_call(
    @firestore_stub.method(:begin_transaction),
    defaults["begin_transaction"],
    exception_transformer: exception_transformer
  )
  @commit = Google::Gax.create_api_call(
    @firestore_stub.method(:commit),
    defaults["commit"],
    exception_transformer: exception_transformer
  )
  @rollback = Google::Gax.create_api_call(
    @firestore_stub.method(:rollback),
    defaults["rollback"],
    exception_transformer: exception_transformer
  )
  @run_query = Google::Gax.create_api_call(
    @firestore_stub.method(:run_query),
    defaults["run_query"],
    exception_transformer: exception_transformer
  )
  @write = Google::Gax.create_api_call(
    @firestore_stub.method(:write),
    defaults["write"],
    exception_transformer: exception_transformer
  )
  @listen = Google::Gax.create_api_call(
    @firestore_stub.method(:listen),
    defaults["listen"],
    exception_transformer: exception_transformer
  )
  @list_collection_ids = Google::Gax.create_api_call(
    @firestore_stub.method(:list_collection_ids),
    defaults["list_collection_ids"],
    exception_transformer: exception_transformer
  )
end

Class Method Details

.any_path_path(project, database, document, any_path) ⇒ String

Returns a fully-qualified any_path resource name string.

Parameters:

  • project (String)
  • database (String)
  • document (String)
  • any_path (String)

Returns:

  • (String) 


155
156
157
158
159
160
161
162
 
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 155

def self.any_path_path project, database, document, any_path
  ANY_PATH_PATH_TEMPLATE.render(
    :"project" => project,
    :"database" => database,
    :"document" => document,
    :"any_path" => any_path
  )
end

.database_root_path(project, database) ⇒ String

Returns a fully-qualified database_root resource name string.

Parameters:

  • project (String)
  • database (String)

Returns:

  • (String) 


118
119
120
121
122
123
 
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 118

def self.database_root_path project, database
  DATABASE_ROOT_PATH_TEMPLATE.render(
    :"project" => project,
    :"database" => database
  )
end

.document_path_path(project, database, document_path) ⇒ String

Returns a fully-qualified document_path resource name string.

Parameters:

  • project (String)
  • database (String)
  • document_path (String)

Returns:

  • (String) 


141
142
143
144
145
146
147
 
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 141

def self.document_path_path project, database, document_path
  DOCUMENT_PATH_PATH_TEMPLATE.render(
    :"project" => project,
    :"database" => database,
    :"document_path" => document_path
  )
end

.document_root_path(project, database) ⇒ String

Returns a fully-qualified document_root resource name string.

Parameters:

  • project (String)
  • database (String)

Returns:

  • (String) 


129
130
131
132
133
134
 
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 129

def self.document_root_path project, database
  DOCUMENT_ROOT_PATH_TEMPLATE.render(
    :"project" => project,
    :"database" => database
  )
end

Instance Method Details

#batch_get_documents(database, documents, mask: nil, transaction: nil, new_transaction: nil, read_time: nil, options: nil) ⇒ Enumerable<Google::Firestore::V1beta1::BatchGetDocumentsResponse>

Gets multiple documents.

Documents returned by this method are not guaranteed to be returned in the same order that they were requested.

Examples:

require "google/cloud/firestore/v1beta1"

firestore_client = Google::Cloud::Firestore::V1beta1.new
formatted_database = Google::Cloud::Firestore::V1beta1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")

# TODO: Initialize +documents+:
documents = []
firestore_client.batch_get_documents(formatted_database, documents).each do |element|
  # Process element.
end

Parameters:

  • database (String) —

    The database name. In the format: +projects/{project_id}/databases/{database_id}+.

  • documents (Array<String>) —

    The names of the documents to retrieve. In the format: +projects/{project_id}/databases/{database_id}/documents/{document_path}+. The request will fail if any of the document is not a child resource of the given +database+. Duplicate names will be elided.

  • mask (Google::Firestore::V1beta1::DocumentMask | Hash) —

    The fields to return. If not set, returns all fields.

    If a document has a field that is not present in this mask, that field will not be returned in the response. A hash of the same form as Google::Firestore::V1beta1::DocumentMask can also be provided.

  • transaction (String) —

    Reads documents in a transaction.

  • new_transaction (Google::Firestore::V1beta1::TransactionOptions | Hash) —

    Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream. A hash of the same form as Google::Firestore::V1beta1::TransactionOptions can also be provided.

  • read_time (Google::Protobuf::Timestamp | Hash) —

    Reads documents as they were at the given time. This may not be older than 60 seconds. A hash of the same form as Google::Protobuf::Timestamp can also be provided.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
 
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 711

def batch_get_documents \
    database,
    documents,
    mask: nil,
    transaction: nil,
    new_transaction: nil,
    read_time: nil,
    options: nil
  req = {
    database: database,
    documents: documents,
    mask: mask,
    transaction: transaction,
    new_transaction: new_transaction,
    read_time: read_time
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::BatchGetDocumentsRequest)
  @batch_get_documents.call(req, options)
end

#begin_transaction(database, options_: nil, options: nil) {|result, operation| ... } ⇒ Google::Firestore::V1beta1::BeginTransactionResponse

Starts a new transaction.

Examples:

require "google/cloud/firestore/v1beta1"

firestore_client = Google::Cloud::Firestore::V1beta1.new
formatted_database = Google::Cloud::Firestore::V1beta1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")
response = firestore_client.begin_transaction(formatted_database)

Parameters:

  • database (String) —

    The database name. In the format: +projects/{project_id}/databases/{database_id}+.

  • options_ (Google::Firestore::V1beta1::TransactionOptions | Hash) —

    The options for the transaction. Defaults to a read-write transaction. A hash of the same form as Google::Firestore::V1beta1::TransactionOptions can also be provided.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



756
757
758
759
760
761
762
763
764
765
766
767
 
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 756

def begin_transaction \
    database,
    options_: nil,
    options: nil,
    &block
  req = {
    database: database,
    options: options_
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::BeginTransactionRequest)
  @begin_transaction.call(req, options, &block)
end

#commit(database, writes, transaction: nil, options: nil) {|result, operation| ... } ⇒ Google::Firestore::V1beta1::CommitResponse

Commits a transaction, while optionally updating documents.

Examples:

require "google/cloud/firestore/v1beta1"

firestore_client = Google::Cloud::Firestore::V1beta1.new
formatted_database = Google::Cloud::Firestore::V1beta1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")

# TODO: Initialize +writes+:
writes = []
response = firestore_client.commit(formatted_database, writes)

Parameters:

  • database (String) —

    The database name. In the format: +projects/{project_id}/databases/{database_id}+.

  • writes (Array<Google::Firestore::V1beta1::Write | Hash>) —

    The writes to apply.

    Always executed atomically and in order. A hash of the same form as Google::Firestore::V1beta1::Write can also be provided.

  • transaction (String) —

    If set, applies all writes in this transaction, and commits it.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



800
801
802
803
804
805
806
807
808
809
810
811
812
813
 
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 800

def commit \
    database,
    writes,
    transaction: nil,
    options: nil,
    &block
  req = {
    database: database,
    writes: writes,
    transaction: transaction
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::CommitRequest)
  @commit.call(req, options, &block)
end

#create_document(parent, collection_id, document_id, document, mask: nil, options: nil) {|result, operation| ... } ⇒ Google::Firestore::V1beta1::Document

Creates a new document.

Examples:

require "google/cloud/firestore/v1beta1"

firestore_client = Google::Cloud::Firestore::V1beta1.new
formatted_parent = Google::Cloud::Firestore::V1beta1::FirestoreClient.any_path_path("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]")

# TODO: Initialize +collection_id+:
collection_id = ''

# TODO: Initialize +document_id+:
document_id = ''

# TODO: Initialize +document+:
document = {}
response = firestore_client.create_document(formatted_parent, collection_id, document_id, document)

Parameters:

  • parent (String) —

    The parent resource. For example: +projects/{project_id}/databases/{database_id}/documents+ or +projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}+

  • collection_id (String) —

    The collection ID, relative to +parent+, to list. For example: +chatrooms+.

  • document_id (String) —

    The client-assigned document ID to use for this document.

    Optional. If not specified, an ID will be assigned by the service.

  • document (Google::Firestore::V1beta1::Document | Hash) —

    The document to create. +name+ must not be set. A hash of the same form as Google::Firestore::V1beta1::Document can also be provided.

  • mask (Google::Firestore::V1beta1::DocumentMask | Hash) —

    The fields to return. If not set, returns all fields.

    If the document has a field that is not present in this mask, that field will not be returned in the response. A hash of the same form as Google::Firestore::V1beta1::DocumentMask can also be provided.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
 
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 535

def create_document \
    parent,
    collection_id,
    document_id,
    document,
    mask: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    collection_id: collection_id,
    document_id: document_id,
    document: document,
    mask: mask
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::CreateDocumentRequest)
  @create_document.call(req, options, &block)
end

#delete_document(name, current_document: nil, options: nil) {|result, operation| ... } ⇒ Object

Deletes a document.

Examples:

require "google/cloud/firestore/v1beta1"

firestore_client = Google::Cloud::Firestore::V1beta1.new
formatted_name = Google::Cloud::Firestore::V1beta1::FirestoreClient.any_path_path("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]")
firestore_client.delete_document(formatted_name)

Parameters:

  • name (String) —

    The resource name of the Document to delete. In the format: +projects/{project_id}/databases/{database_id}/documents/{document_path}+.

  • current_document (Google::Firestore::V1beta1::Precondition | Hash) —

    An optional precondition on the document. The request will fail if this is set and not met by the target document. A hash of the same form as Google::Firestore::V1beta1::Precondition can also be provided.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • result —

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



644
645
646
647
648
649
650
651
652
653
654
655
656
 
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 644

def delete_document \
    name,
    current_document: nil,
    options: nil,
    &block
  req = {
    name: name,
    current_document: current_document
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::DeleteDocumentRequest)
  @delete_document.call(req, options, &block)
  nil
end

#get_document(name, mask: nil, transaction: nil, read_time: nil, options: nil) {|result, operation| ... } ⇒ Google::Firestore::V1beta1::Document

Gets a single document.

Examples:

require "google/cloud/firestore/v1beta1"

firestore_client = Google::Cloud::Firestore::V1beta1.new
formatted_name = Google::Cloud::Firestore::V1beta1::FirestoreClient.any_path_path("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]")
response = firestore_client.get_document(formatted_name)

Parameters:

  • name (String) —

    The resource name of the Document to get. In the format: +projects/{project_id}/databases/{database_id}/documents/{document_path}+.

  • mask (Google::Firestore::V1beta1::DocumentMask | Hash) —

    The fields to return. If not set, returns all fields.

    If the document has a field that is not present in this mask, that field will not be returned in the response. A hash of the same form as Google::Firestore::V1beta1::DocumentMask can also be provided.

  • transaction (String) —

    Reads the document in a transaction.

  • read_time (Google::Protobuf::Timestamp | Hash) —

    Reads the version of the document at the given time. This may not be older than 60 seconds. A hash of the same form as Google::Protobuf::Timestamp can also be provided.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 370

def get_document \
    name,
    mask: nil,
    transaction: nil,
    read_time: nil,
    options: nil,
    &block
  req = {
    name: name,
    mask: mask,
    transaction: transaction,
    read_time: read_time
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::GetDocumentRequest)
  @get_document.call(req, options, &block)
end

#list_collection_ids(parent, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<String>

Lists all the collection IDs underneath a document.

Examples:

require "google/cloud/firestore/v1beta1"

firestore_client = Google::Cloud::Firestore::V1beta1.new
formatted_parent = Google::Cloud::Firestore::V1beta1::FirestoreClient.any_path_path("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]")

# Iterate over all results.
firestore_client.list_collection_ids(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
firestore_client.list_collection_ids(formatted_parent).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • parent (String) —

    The parent document. In the format: +projects/{project_id}/databases/{database_id}/documents/{document_path}+. For example: +projects/my-project/databases/my-database/documents/chatrooms/my-chatroom+

  • page_size (Integer) —

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • result (Google::Gax::PagedEnumerable<String>)
  • operation (GRPC::ActiveCall::Operation)

Returns:

  • (Google::Gax::PagedEnumerable<String>) —

    An enumerable of String instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
 
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 1028

def list_collection_ids \
    parent,
    page_size: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::ListCollectionIdsRequest)
  @list_collection_ids.call(req, options, &block)
end

#list_documents(parent, collection_id, page_size: nil, order_by: nil, mask: nil, transaction: nil, read_time: nil, show_missing: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Firestore::V1beta1::Document>

Lists documents.

Examples:

require "google/cloud/firestore/v1beta1"

firestore_client = Google::Cloud::Firestore::V1beta1.new
formatted_parent = Google::Cloud::Firestore::V1beta1::FirestoreClient.any_path_path("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]")

# TODO: Initialize +collection_id+:
collection_id = ''

# Iterate over all results.
firestore_client.list_documents(formatted_parent, collection_id).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
firestore_client.list_documents(formatted_parent, collection_id).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • parent (String) —

    The parent resource name. In the format: +projects/{project_id}/databases/{database_id}/documents+ or +projects/{project_id}/databases/{database_id}/documents/{document_path}+. For example: +projects/my-project/databases/my-database/documents+ or +projects/my-project/databases/my-database/documents/chatrooms/my-chatroom+

  • collection_id (String) —

    The collection ID, relative to +parent+, to list. For example: +chatrooms+ or +messages+.

  • page_size (Integer) —

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • order_by (String) —

    The order to sort results by. For example: +priority desc, name+.

  • mask (Google::Firestore::V1beta1::DocumentMask | Hash) —

    The fields to return. If not set, returns all fields.

    If a document has a field that is not present in this mask, that field will not be returned in the response. A hash of the same form as Google::Firestore::V1beta1::DocumentMask can also be provided.

  • transaction (String) —

    Reads documents in a transaction.

  • read_time (Google::Protobuf::Timestamp | Hash) —

    Reads documents as they were at the given time. This may not be older than 60 seconds. A hash of the same form as Google::Protobuf::Timestamp can also be provided.

  • show_missing (true, false) —

    If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, Document#create_time, or Document#update_time set.

    Requests with +show_missing+ may not specify +where+ or +order_by+.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

  • (Google::Gax::PagedEnumerable<Google::Firestore::V1beta1::Document>) —

    An enumerable of Google::Firestore::V1beta1::Document instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 463

def list_documents \
    parent,
    collection_id,
    page_size: nil,
    order_by: nil,
    mask: nil,
    transaction: nil,
    read_time: nil,
    show_missing: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    collection_id: collection_id,
    page_size: page_size,
    order_by: order_by,
    mask: mask,
    transaction: transaction,
    read_time: read_time,
    show_missing: show_missing
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::ListDocumentsRequest)
  @list_documents.call(req, options, &block)
end

#listen(reqs, options: nil) ⇒ Enumerable<Google::Firestore::V1beta1::ListenResponse>

Note:

EXPERIMENTAL: Streaming requests are still undergoing review. This method interface might change in the future.

Listens to changes.

Examples:

require "google/cloud/firestore/v1beta1"

firestore_client = Google::Cloud::Firestore::V1beta1.new
formatted_database = Google::Cloud::Firestore::V1beta1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")
request = { database: formatted_database }
requests = [request]
firestore_client.listen(requests).each do |element|
  # Process element.
end

Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



977
978
979
980
981
982
 
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 977

def listen reqs, options: nil
  request_protos = reqs.lazy.map do |req|
    Google::Gax::to_proto(req, Google::Firestore::V1beta1::ListenRequest)
  end
  @listen.call(request_protos, options)
end

#rollback(database, transaction, options: nil) {|result, operation| ... } ⇒ Object

Rolls back a transaction.

Examples:

require "google/cloud/firestore/v1beta1"

firestore_client = Google::Cloud::Firestore::V1beta1.new
formatted_database = Google::Cloud::Firestore::V1beta1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")

# TODO: Initialize +transaction+:
transaction = ''
firestore_client.rollback(formatted_database, transaction)

Parameters:

  • database (String) —

    The database name. In the format: +projects/{project_id}/databases/{database_id}+.

  • transaction (String) —

    The transaction to roll back.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • result —

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 839

def rollback \
    database,
    transaction,
    options: nil,
    &block
  req = {
    database: database,
    transaction: transaction
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::RollbackRequest)
  @rollback.call(req, options, &block)
  nil
end

#run_query(parent, structured_query: nil, transaction: nil, new_transaction: nil, read_time: nil, options: nil) ⇒ Enumerable<Google::Firestore::V1beta1::RunQueryResponse>

Runs a query.

Examples:

require "google/cloud/firestore/v1beta1"

firestore_client = Google::Cloud::Firestore::V1beta1.new
formatted_parent = Google::Cloud::Firestore::V1beta1::FirestoreClient.any_path_path("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]")
firestore_client.run_query(formatted_parent).each do |element|
  # Process element.
end

Parameters:

  • parent (String) —

    The parent resource name. In the format: +projects/{project_id}/databases/{database_id}/documents+ or +projects/{project_id}/databases/{database_id}/documents/{document_path}+. For example: +projects/my-project/databases/my-database/documents+ or +projects/my-project/databases/my-database/documents/chatrooms/my-chatroom+

  • structured_query (Google::Firestore::V1beta1::StructuredQuery | Hash) —

    A structured query. A hash of the same form as Google::Firestore::V1beta1::StructuredQuery can also be provided.

  • transaction (String) —

    Reads documents in a transaction.

  • new_transaction (Google::Firestore::V1beta1::TransactionOptions | Hash) —

    Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream. A hash of the same form as Google::Firestore::V1beta1::TransactionOptions can also be provided.

  • read_time (Google::Protobuf::Timestamp | Hash) —

    Reads documents as they were at the given time. This may not be older than 60 seconds. A hash of the same form as Google::Protobuf::Timestamp can also be provided.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
 
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 896

def run_query \
    parent,
    structured_query: nil,
    transaction: nil,
    new_transaction: nil,
    read_time: nil,
    options: nil
  req = {
    parent: parent,
    structured_query: structured_query,
    transaction: transaction,
    new_transaction: new_transaction,
    read_time: read_time
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::RunQueryRequest)
  @run_query.call(req, options)
end

#update_document(document, update_mask, mask: nil, current_document: nil, options: nil) {|result, operation| ... } ⇒ Google::Firestore::V1beta1::Document

Updates or inserts a document.

Examples:

require "google/cloud/firestore/v1beta1"

firestore_client = Google::Cloud::Firestore::V1beta1.new

# TODO: Initialize +document+:
document = {}

# TODO: Initialize +update_mask+:
update_mask = {}
response = firestore_client.update_document(document, update_mask)

Parameters:

  • document (Google::Firestore::V1beta1::Document | Hash) —

    The updated document. Creates the document if it does not already exist. A hash of the same form as Google::Firestore::V1beta1::Document can also be provided.

  • update_mask (Google::Firestore::V1beta1::DocumentMask | Hash) —

    The fields to update. None of the field paths in the mask may contain a reserved name.

    If the document exists on the server and has fields not referenced in the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document, are deleted from the document on the server. A hash of the same form as Google::Firestore::V1beta1::DocumentMask can also be provided.

  • mask (Google::Firestore::V1beta1::DocumentMask | Hash) —

    The fields to return. If not set, returns all fields.

    If the document has a field that is not present in this mask, that field will not be returned in the response. A hash of the same form as Google::Firestore::V1beta1::DocumentMask can also be provided.

  • current_document (Google::Firestore::V1beta1::Precondition | Hash) —

    An optional precondition on the document. The request will fail if this is set and not met by the target document. A hash of the same form as Google::Firestore::V1beta1::Precondition can also be provided.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
 
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 603

def update_document \
    document,
    update_mask,
    mask: nil,
    current_document: nil,
    options: nil,
    &block
  req = {
    document: document,
    update_mask: update_mask,
    mask: mask,
    current_document: current_document
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::UpdateDocumentRequest)
  @update_document.call(req, options, &block)
end

#write(reqs, options: nil) ⇒ Enumerable<Google::Firestore::V1beta1::WriteResponse>

Note:

EXPERIMENTAL: Streaming requests are still undergoing review. This method interface might change in the future.

Streams batches of document updates and deletes, in order.

Examples:

require "google/cloud/firestore/v1beta1"

firestore_client = Google::Cloud::Firestore::V1beta1.new
formatted_database = Google::Cloud::Firestore::V1beta1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")
request = { database: formatted_database }
requests = [request]
firestore_client.write(requests).each do |element|
  # Process element.
end

Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



942
943
944
945
946
947
 
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 942

def write reqs, options: nil
  request_protos = reqs.lazy.map do |req|
    Google::Gax::to_proto(req, Google::Firestore::V1beta1::WriteRequest)
  end
  @write.call(request_protos, options)
end