module Google::Cloud::Firestore

# Cloud Firestore

Cloud Firestore is a NoSQL document database built for automatic scaling, high performance, and ease of application development. While the Cloud Firestore interface has many of the same features as traditional databases, as a NoSQL database it differs from them in the way it describes relationships between data objects.

See {file:OVERVIEW.md Firestore Overview}.

Constants

VERSION

Public Class Methods

configure() { |configure.firestore| ... } click to toggle source

Configure the Google Cloud Firestore library.

The following Firestore configuration parameters are supported:

  • `project_id` - (String) Identifier for a Firestore project. (The parameter `project` is considered deprecated, but may also be 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}) (The parameter `keyfile` is considered deprecated, but may also be used.)

  • `scope` - (String, Array<String>) The OAuth 2.0 scopes controlling the set of resources and operations that the connection can access.

  • `timeout` - (Integer) Default timeout to use in requests.

  • `endpoint` - (String) Override of the endpoint host name, or `nil` to use the default endpoint.

  • `emulator_host` - (String) Host name of the emulator. Defaults to `ENV`

@return [Google::Cloud::Config] The configuration object the

Google::Cloud::Firestore library uses.
# File lib/google/cloud/firestore.rb, line 134
def self.configure
  yield Google::Cloud.configure.firestore if block_given?

  Google::Cloud.configure.firestore
end
default_credentials(scope: nil) click to toggle source

@private Default credentials.

# File lib/google/cloud/firestore.rb, line 150
def self.default_credentials scope: nil
  Google::Cloud.configure.firestore.credentials ||
    Google::Cloud.configure.credentials ||
    Firestore::Credentials.default(scope: scope)
end
default_project_id() click to toggle source

@private Default project.

# File lib/google/cloud/firestore.rb, line 142
def self.default_project_id
  Google::Cloud.configure.firestore.project_id ||
    Google::Cloud.configure.project_id ||
    Google::Cloud.env.project_id
end
new(project_id: nil, credentials: nil, scope: nil, timeout: nil, endpoint: nil, emulator_host: nil, project: nil, keyfile: nil) click to toggle source

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 {file:AUTHENTICATION.md Authentication Guide}.

@param [String] project_id Identifier for a Firestore project. If not

present, the default project for the credentials is used.

@param [String, Hash, Google::Auth::Credentials] 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})

@param [String, Array<String>] scope 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](https://developers.google.com/identity/protocols/OAuth2).

The default scope is:

* `https://www.googleapis.com/auth/datastore`

@param [Integer] timeout Default timeout to use in requests. Optional. @param [String] endpoint Override of the endpoint host name. Optional.

If the param is nil, uses the default endpoint.

@param [String] emulator_host Firestore emulator host. Optional.

If the param is nil, uses the value of the `emulator_host` config.

@param [String] project Alias for the `project_id` argument. Deprecated. @param [String] keyfile Alias for the `credentials` argument.

Deprecated.

@return [Google::Cloud::Firestore::Client]

@example

require "google/cloud/firestore"

firestore = Google::Cloud::Firestore.new
# File lib/google/cloud/firestore.rb, line 73
def self.new project_id: nil,
             credentials: nil,
             scope: nil,
             timeout: nil,
             endpoint: nil,
             emulator_host: nil,
             project: nil,
             keyfile: nil
  project_id    ||= (project || default_project_id)
  scope         ||= configure.scope
  timeout       ||= configure.timeout
  endpoint      ||= configure.endpoint
  emulator_host ||= configure.emulator_host

  if emulator_host
    project_id = project_id.to_s
    raise ArgumentError, "project_id is missing" if project_id.empty?

    service = Firestore::Service.new project_id, :this_channel_is_insecure, host: emulator_host, timeout: timeout
    return Firestore::Client.new service
  end

  credentials ||= (keyfile || default_credentials(scope: scope))
  unless credentials.is_a? Google::Auth::Credentials
    credentials = Firestore::Credentials.new credentials, scope: scope
  end

  if credentials.respond_to? :project_id
    project_id ||= credentials.project_id
  end
  project_id = project_id.to_s
  raise ArgumentError, "project_id is missing" if project_id.empty?

  service = Firestore::Service.new project_id, credentials, host: endpoint, timeout: timeout
  Firestore::Client.new service
end