Ruby Client for the Cloud Firestore V1 API

API Client library for the Cloud Firestore V1 API

Cloud Firestore is a NoSQL document database built for automatic scaling, high performance, and ease of application development.

https://github.com/googleapis/google-cloud-ruby

Installation

$ gem install google-cloud-firestore-v1

Before You Begin

In order to use this library, you first need to go through the following steps:

1. Select or create a Cloud Platform project.
2. Enable billing for your project.
3. Enable the API.
4. Set up authentication.

Quick Start

```ruby require “google/cloud/firestore/v1”

client = ::Google::Cloud::Firestore::V1::Firestore::Client.new request = my_create_request response = client.get_document request ```

View the Client Library Documentation for class and method documentation.

See also the Product Documentation for general usage information.

Enabling Logging

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 Cloud Logging. See grpc/logconfig.rb and the gRPC spec_helper.rb for additional information.

Configuring a Ruby stdlib logger:

```ruby 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 ```

Supported Ruby Versions

This library is supported on Ruby 2.4+.

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. Currently, this means Ruby 2.4 and later. 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.