Cloud Firestore API - Module Google::Cloud (v2.10.0)

Reference documentation and code samples for the Cloud Firestore API module Google::Cloud.

Methods

.firestore

def self.firestore(project_id = nil, credentials = nil, scope: nil, timeout: nil, database_id: nil) -> Google::Cloud::Firestore::Client

Creates a new object for connecting to the Firestore service. Each call creates a new connection.

For more information on connecting to Google Cloud see the Authentication Guide.

Parameters
  • project_id (String) — Identifier for a Firestore project. If not present, the default project for the credentials is used.
  • credentials (String, Hash, Google::Auth::Credentials) — The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object. (See Firestore::Credentials)
  • scope (String, Array<String>) (defaults to: nil) —

    The OAuth 2.0 scopes controlling the set of resources and operations that the connection can access. See Using OAuth 2.0 to Access Google APIs.

    The default scope is:

    • https://www.googleapis.com/auth/datastore
  • timeout (Integer) (defaults to: nil) — Default timeout to use in requests. Optional.
  • database_id (String) (defaults to: nil) — Identifier for a Firestore database. If not present, the default database of the project is used.
Returns
Example 
require "google/cloud"

firestore = Google::Cloud.firestore

#firestore

def firestore(scope: nil, timeout: nil, database_id: nil) -> Google::Cloud::Firestore::Client

Creates a new object for connecting to the Firestore service. Each call creates a new connection.

For more information on connecting to Google Cloud see the Authentication Guide.

Parameters
  • scope (String, Array<String>) (defaults to: nil) —

    The OAuth 2.0 scopes controlling the set of resources and operations that the connection can access. See Using OAuth 2.0 to Access Google APIs.

    The default scope is:

    • https://www.googleapis.com/auth/datastore
  • timeout (Integer) (defaults to: nil) — Default timeout to use in requests. Optional.
  • database_id (String) (defaults to: nil) — Identifier for a Firestore database. If not present, the default database of the project is used.
Returns
Examples 
require "google/cloud"

gcloud = Google::Cloud.new
firestore = gcloud.firestore

The default scope can be overridden with the scope option:

require "google/cloud"

gcloud  = Google::Cloud.new
platform_scope = "https://www.googleapis.com/auth/cloud-platform"
firestore = gcloud.firestore scope: platform_scope

The default database can be overridden with the database_id option:

require "google/cloud"

gcloud  = Google::Cloud.new
database_id = "my-todo-database"
firestore = gcloud.firestore database_id: database_id