Module: Google::Cloud::Bigquery::Storage

Defined in:
lib/google/cloud/bigquery/storage.rb,
lib/google/cloud/bigquery/storage/version.rb

Constant Summary collapse

VERSION = 
"1.5.1"

Class Method Summary collapse

Class Method Details

.big_query_read(version: :v1, &block) ⇒ ::Object

Create a new client object for BigQueryRead.

By default, this returns an instance of Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the BigQueryRead service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About BigQueryRead

BigQuery Read API.

The Read API can be used to read data from BigQuery.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (::Object) —

    A client object for the specified version.



70
71
72
73
74
75
76
77
78
79
 
# File 'lib/google/cloud/bigquery/storage.rb', line 70

def self.big_query_read version: :v1, &block
  require "google/cloud/bigquery/storage/#{version.to_s.downcase}"

  package_name = Google::Cloud::Bigquery::Storage
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::Bigquery::Storage.const_get(package_name).const_get(:BigQueryRead)
  service_module.const_get(:Client).new(&block)
end

.big_query_write(version: :v1, &block) ⇒ ::Object

Create a new client object for BigQueryWrite.

By default, this returns an instance of Google::Cloud::Bigquery::Storage::V1::BigQueryWrite::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the BigQueryWrite service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About BigQueryWrite

BigQuery Write API.

The Write API can be used to write data to BigQuery.

For supplementary information about the Write API, see: https://cloud.google.com/bigquery/docs/write-api

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (::Object) —

    A client object for the specified version.



105
106
107
108
109
110
111
112
113
114
 
# File 'lib/google/cloud/bigquery/storage.rb', line 105

def self.big_query_write version: :v1, &block
  require "google/cloud/bigquery/storage/#{version.to_s.downcase}"

  package_name = Google::Cloud::Bigquery::Storage
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::Bigquery::Storage.const_get(package_name).const_get(:BigQueryWrite)
  service_module.const_get(:Client).new(&block)
end

.configure {|::Google::Cloud.configure.bigquery_storage| ... } ⇒ ::Google::Cloud::Config

Configure the google-cloud-bigquery-storage library.

The following configuration parameters are supported:

  • credentials (type: 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.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.

Yields:

Returns:

  • (::Google::Cloud::Config) —

    The default configuration used by this library



144
145
146
147
148
 
# File 'lib/google/cloud/bigquery/storage.rb', line 144

def self.configure
  yield ::Google::Cloud.configure.bigquery_storage if block_given?

  ::Google::Cloud.configure.bigquery_storage
end