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
defdatabase()->::String
Returns
(::String) — Cloud Spanner database in the form `project/instance/database'
#database=
defdatabase=(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
defdatabase_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.
REQUIRES: The database role name must start with a letter, and can only
contain letters, numbers, and underscores.
#database_role=
defdatabase_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.
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.
REQUIRES: The database role name must start with a letter, and can only
contain letters, numbers, and underscores.
#max_parallelism
defmax_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=
defmax_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
defuse_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=
defuse_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
defuse_parallelism()->::Boolean
Returns
(::Boolean) — If parallelism should be used when reading from Cloud Spanner
#use_parallelism=
defuse_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
defuse_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=
defuse_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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# BigQuery Connection V1 API - Class Google::Cloud::Bigquery::Connection::V1::CloudSpannerProperties (v1.3.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.3.0 (latest)](/ruby/docs/reference/google-cloud-bigquery-connection-v1/latest/Google-Cloud-Bigquery-Connection-V1-CloudSpannerProperties)\n- [1.2.1](/ruby/docs/reference/google-cloud-bigquery-connection-v1/1.2.1/Google-Cloud-Bigquery-Connection-V1-CloudSpannerProperties)\n- [1.1.0](/ruby/docs/reference/google-cloud-bigquery-connection-v1/1.1.0/Google-Cloud-Bigquery-Connection-V1-CloudSpannerProperties)\n- [1.0.1](/ruby/docs/reference/google-cloud-bigquery-connection-v1/1.0.1/Google-Cloud-Bigquery-Connection-V1-CloudSpannerProperties)\n- [0.18.0](/ruby/docs/reference/google-cloud-bigquery-connection-v1/0.18.0/Google-Cloud-Bigquery-Connection-V1-CloudSpannerProperties)\n- [0.17.2](/ruby/docs/reference/google-cloud-bigquery-connection-v1/0.17.2/Google-Cloud-Bigquery-Connection-V1-CloudSpannerProperties)\n- [0.16.0](/ruby/docs/reference/google-cloud-bigquery-connection-v1/0.16.0/Google-Cloud-Bigquery-Connection-V1-CloudSpannerProperties)\n- [0.15.1](/ruby/docs/reference/google-cloud-bigquery-connection-v1/0.15.1/Google-Cloud-Bigquery-Connection-V1-CloudSpannerProperties)\n- [0.14.0](/ruby/docs/reference/google-cloud-bigquery-connection-v1/0.14.0/Google-Cloud-Bigquery-Connection-V1-CloudSpannerProperties)\n- [0.13.0](/ruby/docs/reference/google-cloud-bigquery-connection-v1/0.13.0/Google-Cloud-Bigquery-Connection-V1-CloudSpannerProperties)\n- [0.12.0](/ruby/docs/reference/google-cloud-bigquery-connection-v1/0.12.0/Google-Cloud-Bigquery-Connection-V1-CloudSpannerProperties)\n- [0.11.0](/ruby/docs/reference/google-cloud-bigquery-connection-v1/0.11.0/Google-Cloud-Bigquery-Connection-V1-CloudSpannerProperties)\n- [0.10.0](/ruby/docs/reference/google-cloud-bigquery-connection-v1/0.10.0/Google-Cloud-Bigquery-Connection-V1-CloudSpannerProperties)\n- [0.9.0](/ruby/docs/reference/google-cloud-bigquery-connection-v1/0.9.0/Google-Cloud-Bigquery-Connection-V1-CloudSpannerProperties)\n- [0.8.0](/ruby/docs/reference/google-cloud-bigquery-connection-v1/0.8.0/Google-Cloud-Bigquery-Connection-V1-CloudSpannerProperties)\n- [0.7.0](/ruby/docs/reference/google-cloud-bigquery-connection-v1/0.7.0/Google-Cloud-Bigquery-Connection-V1-CloudSpannerProperties)\n- [0.6.0](/ruby/docs/reference/google-cloud-bigquery-connection-v1/0.6.0/Google-Cloud-Bigquery-Connection-V1-CloudSpannerProperties)\n- [0.5.3](/ruby/docs/reference/google-cloud-bigquery-connection-v1/0.5.3/Google-Cloud-Bigquery-Connection-V1-CloudSpannerProperties) \nReference documentation and code samples for the BigQuery Connection V1 API class Google::Cloud::Bigquery::Connection::V1::CloudSpannerProperties.\n\nConnection properties specific to Cloud Spanner. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #database\n\n def database() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Cloud Spanner database in the form \\`project/instance/database'\n\n### #database=\n\n def database=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Cloud Spanner database in the form \\`project/instance/database' \n**Returns**\n\n- (::String) --- Cloud Spanner database in the form \\`project/instance/database'\n\n### #database_role\n\n def database_role() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n\n For more details, see [About fine-grained access control](https://cloud.google.com/spanner/docs/fgac-about).\n\n REQUIRES: The database role name must start with a letter, and can only\n contain letters, numbers, and underscores.\n\n### #database_role=\n\n def database_role=(value) -\u003e ::String\n\n**Parameter**\n\n- **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.\n\n\n For more details, see [About fine-grained access control](https://cloud.google.com/spanner/docs/fgac-about).\n\n REQUIRES: The database role name must start with a letter, and can only\ncontain letters, numbers, and underscores. \n**Returns**\n\n- (::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.\n\n\n For more details, see [About fine-grained access control](https://cloud.google.com/spanner/docs/fgac-about).\n\n REQUIRES: The database role name must start with a letter, and can only\n contain letters, numbers, and underscores.\n\n### #max_parallelism\n\n def max_parallelism() -\u003e ::Integer\n\n**Returns**\n\n- (::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.\n\n REQUIRES: `use_parallelism` must be set.\n REQUIRES: Either `use_data_boost` or `use_serverless_analytics` must be\n set.\n\n### #max_parallelism=\n\n def max_parallelism=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **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.\n\n\n REQUIRES: `use_parallelism` must be set.\n REQUIRES: Either `use_data_boost` or `use_serverless_analytics` must be\nset. \n**Returns**\n\n- (::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.\n\n REQUIRES: `use_parallelism` must be set.\n REQUIRES: Either `use_data_boost` or `use_serverless_analytics` must be\n set.\n\n### #use_data_boost\n\n def use_data_boost() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- If set, the request will be executed via Spanner independent compute resources. REQUIRES: `use_parallelism` must be set.\n\n\n NOTE: `use_serverless_analytics` will be deprecated. Prefer\n `use_data_boost` over `use_serverless_analytics`.\n\n### #use_data_boost=\n\n def use_data_boost=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- If set, the request will be executed via Spanner independent compute resources. REQUIRES: `use_parallelism` must be set.\n\n\n NOTE: `use_serverless_analytics` will be deprecated. Prefer\n`use_data_boost` over `use_serverless_analytics`. \n**Returns**\n\n- (::Boolean) --- If set, the request will be executed via Spanner independent compute resources. REQUIRES: `use_parallelism` must be set.\n\n\n NOTE: `use_serverless_analytics` will be deprecated. Prefer\n `use_data_boost` over `use_serverless_analytics`.\n\n### #use_parallelism\n\n def use_parallelism() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- If parallelism should be used when reading from Cloud Spanner\n\n### #use_parallelism=\n\n def use_parallelism=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- If parallelism should be used when reading from Cloud Spanner \n**Returns**\n\n- (::Boolean) --- If parallelism should be used when reading from Cloud Spanner\n\n### #use_serverless_analytics\n\n def use_serverless_analytics() -\u003e ::Boolean\n\n**Returns**\n\n- (::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.\n\n### #use_serverless_analytics=\n\n def use_serverless_analytics=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **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. \n**Returns**\n\n- (::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."]]
