Module: Google::Cloud::Spanner::Admin::Database::V1

Defined in:
lib/google/cloud/spanner/admin/database/v1.rb,
lib/google/cloud/spanner/admin/database/v1/credentials.rb,
lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb

Overview

# Ruby Client for Cloud Spanner Database Admin API ([Alpha](github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))

[Cloud Spanner Database Admin API][Product Documentation]:

  • Product Documentation][

## 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.](console.cloud.google.com/project)

  2. [Enable billing for your project.](cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)

  3. [Enable the Cloud Spanner Database Admin API.](console.cloud.google.com/apis/library/spanner.googleapis.com)

  4. [Setup Authentication.](googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)

### Installation “‘ $ gem install google-cloud-spanner “`

### Next Steps

[Product Documentation]: cloud.google.com/spanner

## Enabling Logging

To enable logging for this library, set the logger for the underlying [gRPC](github.com/grpc/grpc/tree/master/src/ruby) library. The logger that you set may be a Ruby stdlib [‘Logger`](ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below, or a [`Google::Cloud::Logging::Logger`](googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger) that will write logs to [Stackdriver Logging](cloud.google.com/logging/). See [grpc/logconfig.rb](github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb) and the gRPC [spec_helper.rb](github.com/grpc/grpc/blob/master/src/ruby/spec/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 “‘

Defined Under Namespace

Classes: Credentials, DatabaseAdminClient

Class Method Summary collapse

Class Method Details

.new(credentials: nil, scopes: nil, client_config: nil, timeout: nil, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: nil) ⇒ Object

Cloud Spanner Database Admin API

The Cloud Spanner Database Admin API can be used to create, drop, and list databases. It also enables updating the schema of pre-existing databases.

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) (defaults to: nil) —

    Provides the means for authenticating requests made by the client. This parameter can be many types. A ‘Google::Auth::Credentials` uses a the properties of its represented keyfile for authenticating requests made by this client. A `String` will be treated as the path to the keyfile to be used for the construction of credentials for this client. A `Hash` will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A `GRPC::Core::Channel` will be used to make calls through. A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials should already be composed with a `GRPC::Core::CallCredentials` object. A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>) (defaults to: nil) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash) (defaults to: nil) —

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric) (defaults to: nil) —

    The default timeout, in seconds, for calls made through this client.

  • metadata (Hash) (defaults to: nil) —

    Default metadata to be sent with each request. This can be overridden on a per call basis.

  • exception_transformer (Proc) (defaults to: nil) —

    An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/google/cloud/spanner/admin/database/v1.rb', line 120

def self.new \
    credentials: nil,
    scopes: nil,
    client_config: nil,
    timeout: nil,
    metadata: nil,
    exception_transformer: nil,
    lib_name: nil,
    lib_version: nil
  kwargs = {
    credentials: credentials,
    scopes: scopes,
    client_config: client_config,
    timeout: timeout,
    metadata: metadata,
    exception_transformer: exception_transformer,
    lib_name: lib_name,
    lib_version: lib_version
  }.select { |_, v| v != nil }
  Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdminClient.new(**kwargs)
end