Ruby Client for Google Cloud Firestore API
Google Cloud Firestore API
:
In order to use this library, you first need to go through the following
steps:
- Select or create a Cloud Platform project.
- Enable the Google Cloud Firestore API.
- Setup Authentication.
$ gem install google-cloud-firestore
require
"google/cloud/firestore"
firestore
=
Google
::
Cloud
::
Firestore
.
new
(
project_id
:
"my-project"
,
credentials
:
"/path/to/keyfile.json"
)
city
=
firestore
.
col
(
"cities"
)
.
doc
(
"SF"
)
city
.
set
(
{
name
:
"San Francisco"
,
state
:
"CA"
,
country
:
"USA"
,
capital
:
false
,
population
:
860000
}
)
firestore
.
transaction
do
|
tx
|
new_population
=
tx
.
get
(
city
)
.
data
[
:population
]
+
1
tx
.
update
(
city
,
{
population
:
new_population
}
)
end
To enable logging for this library, set the logger for the underlying
gRPC
library. The logger that you set may be a Ruby stdlib
Logger
as shown below, or a
Google::Cloud::Logging::Logger
that will write logs to
Stackdriver Logging
. See
grpc/logconfig.rb
and the gRPC
spec_helper.rb
for additional information.
Configuring a Ruby stdlib logger:
require
"logger"
module
MyLogger
LOGGER
=
Logger
.
new
$stderr
,
level
:
Logger
::
WARN
def
logger
LOGGER
end
end
# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
module
GRPC
extend
MyLogger
end
This library is supported on Ruby 2.6+.
Google provides official support for Ruby versions that are actively supported
by Ruby Core?that is, Ruby versions that are either in normal maintenance or
in security maintenance, and not end of life. Older versions of Ruby
may
still work, but are unsupported and not recommended. See
https://www.ruby-lang.org/en/downloads/branches/
for details about the Ruby
support schedule.