BigQuery Connection V1 API - Class Google::Cloud::Bigquery::Connection::V1::CloudSpannerProperties (v1.4.0)

Reference documentation and code samples for the BigQuery Connection V1 API class Google::Cloud::Bigquery::Connection::V1::CloudSpannerProperties.

Connection properties specific to Cloud Spanner.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#database

def database() -> ::String
Returns
  • (::String) — Cloud Spanner database in the form `project/instance/database'

#database=

def database=(value) -> ::String
Parameter
  • value (::String) — Cloud Spanner database in the form `project/instance/database'
Returns
  • (::String) — Cloud Spanner database in the form `project/instance/database'

#database_role

def database_role() -> ::String
Returns
  • (::String) — Optional. Cloud Spanner database role for fine-grained access control. The Cloud Spanner admin should have provisioned the database role with appropriate permissions, such as SELECT and INSERT. Other users should only use roles provided by their Cloud Spanner admins.

    For more details, see About fine-grained access control.

    REQUIRES: The database role name must start with a letter, and can only contain letters, numbers, and underscores.

#database_role=

def database_role=(value) -> ::String
Parameter
  • value (::String) — Optional. Cloud Spanner database role for fine-grained access control. The Cloud Spanner admin should have provisioned the database role with appropriate permissions, such as SELECT and INSERT. Other users should only use roles provided by their Cloud Spanner admins.

    For more details, see About fine-grained access control.

    REQUIRES: The database role name must start with a letter, and can only contain letters, numbers, and underscores.

Returns
  • (::String) — Optional. Cloud Spanner database role for fine-grained access control. The Cloud Spanner admin should have provisioned the database role with appropriate permissions, such as SELECT and INSERT. Other users should only use roles provided by their Cloud Spanner admins.

    For more details, see About fine-grained access control.

    REQUIRES: The database role name must start with a letter, and can only contain letters, numbers, and underscores.

#max_parallelism

def max_parallelism() -> ::Integer
Returns
  • (::Integer) — Allows setting max parallelism per query when executing on Spanner independent compute resources. If unspecified, default values of parallelism are chosen that are dependent on the Cloud Spanner instance configuration.

    REQUIRES: use_parallelism must be set. REQUIRES: Either use_data_boost or use_serverless_analytics must be set.

#max_parallelism=

def max_parallelism=(value) -> ::Integer
Parameter
  • value (::Integer) — Allows setting max parallelism per query when executing on Spanner independent compute resources. If unspecified, default values of parallelism are chosen that are dependent on the Cloud Spanner instance configuration.

    REQUIRES: use_parallelism must be set. REQUIRES: Either use_data_boost or use_serverless_analytics must be set.

Returns
  • (::Integer) — Allows setting max parallelism per query when executing on Spanner independent compute resources. If unspecified, default values of parallelism are chosen that are dependent on the Cloud Spanner instance configuration.

    REQUIRES: use_parallelism must be set. REQUIRES: Either use_data_boost or use_serverless_analytics must be set.

#use_data_boost

def use_data_boost() -> ::Boolean
Returns
  • (::Boolean) — If set, the request will be executed via Spanner independent compute resources. REQUIRES: use_parallelism must be set.

    NOTE: use_serverless_analytics will be deprecated. Prefer use_data_boost over use_serverless_analytics.

#use_data_boost=

def use_data_boost=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If set, the request will be executed via Spanner independent compute resources. REQUIRES: use_parallelism must be set.

    NOTE: use_serverless_analytics will be deprecated. Prefer use_data_boost over use_serverless_analytics.

Returns
  • (::Boolean) — If set, the request will be executed via Spanner independent compute resources. REQUIRES: use_parallelism must be set.

    NOTE: use_serverless_analytics will be deprecated. Prefer use_data_boost over use_serverless_analytics.

#use_parallelism

def use_parallelism() -> ::Boolean
Returns
  • (::Boolean) — If parallelism should be used when reading from Cloud Spanner

#use_parallelism=

def use_parallelism=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If parallelism should be used when reading from Cloud Spanner
Returns
  • (::Boolean) — If parallelism should be used when reading from Cloud Spanner

#use_serverless_analytics

def use_serverless_analytics() -> ::Boolean
Returns
  • (::Boolean) — If the serverless analytics service should be used to read data from Cloud Spanner. Note: use_parallelism must be set when using serverless analytics.

#use_serverless_analytics=

def use_serverless_analytics=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If the serverless analytics service should be used to read data from Cloud Spanner. Note: use_parallelism must be set when using serverless analytics.
Returns
  • (::Boolean) — If the serverless analytics service should be used to read data from Cloud Spanner. Note: use_parallelism must be set when using serverless analytics.