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
,
transport
:
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 .
- project_id(String) — Identifier for a Firestore project. If not present, the default project for the credentials is used.
- credentials(Google::Auth::Credentials) — A Google::Auth::Credentials
object. (See Firestore::Credentials
)
@note Warning: Passing a
Stringto a keyfile path or aHashof credentials is deprecated. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data.@example
# The recommended way to provide credentials is to use the
make_credsmethod # on the appropriate credentials class for your environment.credentials = ::Google::Auth::ServiceAccountCredentials.make_creds( json_key_io: ::File.open("/path/to/keyfile.json") )
firestore = Google::Cloud::Firestore.new( project_id: "my-project-id", credentials: 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.
- transport(:grpc, :rest) (defaults to: nil)
— Which transport to use to communicate
with the server. Defaults to
:grpc.
require "google/cloud" firestore = Google :: Cloud . firestore
#firestore
def
firestore
(
scope
:
nil
,
timeout
:
nil
,
database_id
:
nil
,
transport
:
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 .
- 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.
- transport(:grpc, :rest) (defaults to: nil)
— Which transport to use to communicate
with the server. Defaults to
:grpc.
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
