Class: Google::Cloud::Bigquery::Connection::V1::CloudSpannerProperties

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/bigquery/connection/v1/connection.rb

Overview

Connection properties specific to Cloud Spanner.

Instance Attribute Summary collapse

Instance Attribute Details

#database ⇒ ::String

Returns Cloud Spanner database in the form `project/instance/database'.

Returns:

  • (::String) —

    Cloud Spanner database in the form `project/instance/database'



251
252
253
254
 
# File 'proto_docs/google/cloud/bigquery/connection/v1/connection.rb', line 251

class CloudSpannerProperties
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#database_role ⇒ ::String

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



251
252
253
254
 
# File 'proto_docs/google/cloud/bigquery/connection/v1/connection.rb', line 251

class CloudSpannerProperties
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#max_parallelism ⇒ ::Integer

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



251
252
253
254
 
# File 'proto_docs/google/cloud/bigquery/connection/v1/connection.rb', line 251

class CloudSpannerProperties
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#use_data_boost ⇒ ::Boolean

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



251
252
253
254
 
# File 'proto_docs/google/cloud/bigquery/connection/v1/connection.rb', line 251

class CloudSpannerProperties
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#use_parallelism ⇒ ::Boolean

Returns If parallelism should be used when reading from Cloud Spanner.

Returns:

  • (::Boolean) —

    If parallelism should be used when reading from Cloud Spanner



251
252
253
254
 
# File 'proto_docs/google/cloud/bigquery/connection/v1/connection.rb', line 251

class CloudSpannerProperties
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#use_serverless_analytics ⇒ ::Boolean

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



251
252
253
254
 
# File 'proto_docs/google/cloud/bigquery/connection/v1/connection.rb', line 251

class CloudSpannerProperties
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end