Class: Google::Cloud::Firestore::V1::FirestoreClient

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

Overview

The Cloud Firestore service.

Cloud Firestore is a fast, fully managed, serverless, cloud-native NoSQL document database that simplifies storing, syncing, and querying data for your mobile, web, and IoT apps at global scale. Its client libraries provide live synchronization and offline support, while its security features and integrations with Firebase and Google Cloud Platform (GCP) accelerate building truly serverless apps.

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, service_address: nil, service_port: 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) (defaults to: nil) —

    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>) (defaults to: ALL_SCOPES) —

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

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

    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) (defaults to: DEFAULT_TIMEOUT) —

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

  • metadata (Hash) (defaults to: nil) —

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

  • service_address (String) (defaults to: nil) —

    Override for the service hostname, or nil to leave as the default.

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

    Override for the service port, or nil to leave as the default.

  • exception_transformer (Proc) (defaults to: nil) —

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



190
191
192
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
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/google/cloud/firestore/v1/firestore_client.rb', line 190

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: nil,
    service_address: nil,
    service_port: 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/v1/firestore_services_pb"

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

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Firestore::V1::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 = Google::Cloud::Firestore::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 }
  if credentials.respond_to?(:quota_project_id) && credentials.quota_project_id
    headers[:"x-goog-user-project"] = credentials.quota_project_id
  end
  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.v1.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 = service_address || self.class::SERVICE_ADDRESS
  port = service_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::V1::Firestore::Stub.method(:new)
  )

  @get_document = Google::Gax.create_api_call(
    @firestore_stub.method(:get_document),
    defaults["get_document"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @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,
    params_extractor: proc do |request|
      {'document.name' => request.document.name}
    end
  )
  @delete_document = Google::Gax.create_api_call(
    @firestore_stub.method(:delete_document),
    defaults["delete_document"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @batch_get_documents = Google::Gax.create_api_call(
    @firestore_stub.method(:batch_get_documents),
    defaults["batch_get_documents"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'database' => request.database}
    end
  )
  @begin_transaction = Google::Gax.create_api_call(
    @firestore_stub.method(:begin_transaction),
    defaults["begin_transaction"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'database' => request.database}
    end
  )
  @commit = Google::Gax.create_api_call(
    @firestore_stub.method(:commit),
    defaults["commit"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'database' => request.database}
    end
  )
  @rollback = Google::Gax.create_api_call(
    @firestore_stub.method(:rollback),
    defaults["rollback"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'database' => request.database}
    end
  )
  @run_query = Google::Gax.create_api_call(
    @firestore_stub.method(:run_query),
    defaults["run_query"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @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,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
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) 


113
114
115
116
117
118
119
120
 
# File 'lib/google/cloud/firestore/v1/firestore_client.rb', line 113

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) 


126
127
128
129
130
131
 
# File 'lib/google/cloud/firestore/v1/firestore_client.rb', line 126

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) 


138
139
140
141
142
143
144
 
# File 'lib/google/cloud/firestore/v1/firestore_client.rb', line 138

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) 


150
151
152
153
154
155
 
# File 'lib/google/cloud/firestore/v1/firestore_client.rb', line 150

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::V1::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/v1"

firestore_client = Google::Cloud::Firestore::V1.new
formatted_database = Google::Cloud::Firestore::V1::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) —

    Required. 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::V1::DocumentMask | Hash) (defaults to: nil) —

    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::V1::DocumentMask can also be provided.

  • transaction (String) (defaults to: nil) —

    Reads documents in a transaction.

  • new_transaction (Google::Firestore::V1::TransactionOptions | Hash) (defaults to: nil) —

    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::V1::TransactionOptions can also be provided.

  • read_time (Google::Protobuf::Timestamp | Hash) (defaults to: nil) —

    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) (defaults to: nil) —

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

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
 
# File 'lib/google/cloud/firestore/v1/firestore_client.rb', line 740

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::V1::BatchGetDocumentsRequest)
  @batch_get_documents.call(req, options)
end

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

Starts a new transaction.

Examples:

require "google/cloud/firestore/v1"

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

Parameters:

  • database (String) —

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

  • options_ (Google::Firestore::V1::TransactionOptions | Hash) (defaults to: nil) —

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

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    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.



785
786
787
788
789
790
791
792
793
794
795
796
 
# File 'lib/google/cloud/firestore/v1/firestore_client.rb', line 785

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::V1::BeginTransactionRequest)
  @begin_transaction.call(req, options, &block)
end

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

Commits a transaction, while optionally updating documents.

Examples:

require "google/cloud/firestore/v1"

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

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

Parameters:

  • database (String) —

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

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

    The writes to apply.

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

  • transaction (String) (defaults to: nil) —

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

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    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.



829
830
831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/google/cloud/firestore/v1/firestore_client.rb', line 829

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::V1::CommitRequest)
  @commit.call(req, options, &block)
end

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

Creates a new document.

Examples:

require "google/cloud/firestore/v1"

firestore_client = Google::Cloud::Firestore::V1.new
formatted_parent = Google::Cloud::Firestore::V1::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) —

    Required. 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) —

    Required. 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::V1::Document | Hash) —

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

  • mask (Google::Firestore::V1::DocumentMask | Hash) (defaults to: nil) —

    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::V1::DocumentMask can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    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.



564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'lib/google/cloud/firestore/v1/firestore_client.rb', line 564

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::V1::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/v1"

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

Parameters:

  • name (String) —

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

  • current_document (Google::Firestore::V1::Precondition | Hash) (defaults to: nil) —

    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::V1::Precondition can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    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.



673
674
675
676
677
678
679
680
681
682
683
684
685
 
# File 'lib/google/cloud/firestore/v1/firestore_client.rb', line 673

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::V1::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::V1::Document

Gets a single document.

Examples:

require "google/cloud/firestore/v1"

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

Parameters:

  • name (String) —

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

  • mask (Google::Firestore::V1::DocumentMask | Hash) (defaults to: nil) —

    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::V1::DocumentMask can also be provided.

  • transaction (String) (defaults to: nil) —

    Reads the document in a transaction.

  • read_time (Google::Protobuf::Timestamp | Hash) (defaults to: nil) —

    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) (defaults to: nil) —

    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.



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/google/cloud/firestore/v1/firestore_client.rb', line 399

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::V1::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/v1"

firestore_client = Google::Cloud::Firestore::V1.new
formatted_parent = Google::Cloud::Firestore::V1::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) —

    Required. 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) (defaults to: nil) —

    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) (defaults to: nil) —

    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.



1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
 
# File 'lib/google/cloud/firestore/v1/firestore_client.rb', line 1057

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::V1::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::V1::Document>

Lists documents.

Examples:

require "google/cloud/firestore/v1"

firestore_client = Google::Cloud::Firestore::V1.new
formatted_parent = Google::Cloud::Firestore::V1::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) —

    Required. 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) —

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

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

    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) (defaults to: nil) —

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

  • mask (Google::Firestore::V1::DocumentMask | Hash) (defaults to: nil) —

    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::V1::DocumentMask can also be provided.

  • transaction (String) (defaults to: nil) —

    Reads documents in a transaction.

  • read_time (Google::Protobuf::Timestamp | Hash) (defaults to: nil) —

    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) (defaults to: nil) —

    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) (defaults to: nil) —

    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::V1::Document>) —

    An enumerable of Google::Firestore::V1::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.



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/google/cloud/firestore/v1/firestore_client.rb', line 492

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::V1::ListDocumentsRequest)
  @list_documents.call(req, options, &block)
end

#listen(reqs, options: nil) ⇒ Enumerable<Google::Firestore::V1::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/v1"

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

Parameters:

  • reqs (Enumerable<Google::Firestore::V1::ListenRequest>) —

    The input requests.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

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

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1006
1007
1008
1009
1010
1011
 
# File 'lib/google/cloud/firestore/v1/firestore_client.rb', line 1006

def listen reqs, options: nil
  request_protos = reqs.lazy.map do |req|
    Google::Gax::to_proto(req, Google::Firestore::V1::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/v1"

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

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

Parameters:

  • database (String) —

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

  • transaction (String) —

    Required. The transaction to roll back.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    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.



868
869
870
871
872
873
874
875
876
877
878
879
880
 
# File 'lib/google/cloud/firestore/v1/firestore_client.rb', line 868

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::V1::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::V1::RunQueryResponse>

Runs a query.

Examples:

require "google/cloud/firestore/v1"

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

Parameters:

  • parent (String) —

    Required. 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::V1::StructuredQuery | Hash) (defaults to: nil) —

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

  • transaction (String) (defaults to: nil) —

    Reads documents in a transaction.

  • new_transaction (Google::Firestore::V1::TransactionOptions | Hash) (defaults to: nil) —

    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::V1::TransactionOptions can also be provided.

  • read_time (Google::Protobuf::Timestamp | Hash) (defaults to: nil) —

    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) (defaults to: nil) —

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

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
 
# File 'lib/google/cloud/firestore/v1/firestore_client.rb', line 925

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::V1::RunQueryRequest)
  @run_query.call(req, options)
end

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

Updates or inserts a document.

Examples:

require "google/cloud/firestore/v1"

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

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

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

Parameters:

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

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

  • update_mask (Google::Firestore::V1::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::V1::DocumentMask can also be provided.

  • mask (Google::Firestore::V1::DocumentMask | Hash) (defaults to: nil) —

    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::V1::DocumentMask can also be provided.

  • current_document (Google::Firestore::V1::Precondition | Hash) (defaults to: nil) —

    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::V1::Precondition can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    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.



632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'lib/google/cloud/firestore/v1/firestore_client.rb', line 632

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::V1::UpdateDocumentRequest)
  @update_document.call(req, options, &block)
end

#write(reqs, options: nil) ⇒ Enumerable<Google::Firestore::V1::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/v1"

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

Parameters:

  • reqs (Enumerable<Google::Firestore::V1::WriteRequest>) —

    The input requests.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

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

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



971
972
973
974
975
976
 
# File 'lib/google/cloud/firestore/v1/firestore_client.rb', line 971

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