Skip to content
Branch: master
Find file History
Latest commit 5a27fd3 Mar 18, 2019
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
acceptance Firestore Numeric Transforms (#2847) Jan 28, 2019
benchmark Switch Firestore to use the V1 API (#2852) Jan 29, 2019
conformance
lib
support Switch Firestore to use the V1 API (#2852) Jan 29, 2019
test
.gitignore
.rubocop.yml Update .rubocop.yml in manual packages (#2778) Feb 15, 2019
.yardopts Add Firestore emulator support (#2744) Jan 4, 2019
AUTHENTICATION.md Update documentation files (#2338) Sep 6, 2018
CHANGELOG.md Fix typo (#2903) Feb 8, 2019
CODE_OF_CONDUCT.md Update documentation files (#2338) Sep 6, 2018
CONTRIBUTING.md Update documentation files (#2338) Sep 6, 2018
EMULATOR.md
Gemfile
LICENSE
LOGGING.md Move to googleapis organization (#2461) Sep 19, 2018
OVERVIEW.md
README.md
Rakefile
TROUBLESHOOTING.md
google-cloud-firestore.gemspec
synth.metadata Update generated google-cloud-firestore files (#3032) Mar 18, 2019
synth.py Switch Firestore to use the V1 API (#2852) Jan 29, 2019

README.md

Ruby Client for Google Cloud Firestore API (Beta)

Google Cloud Firestore API:

Quick Start

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 the Google Cloud Firestore API.
  3. Setup Authentication.

Installation

$ gem install google-cloud-firestore

Next Steps

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

Supported Ruby Versions

This library is supported on Ruby 2.3+.

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.3 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.

You can’t perform that action at this time.