Reference documentation and code samples for the Google BigQuery Connection V1 Client class CloudSpannerProperties.
Connection properties specific to Cloud Spanner.
Generated from protobuf message google.cloud.bigquery.connection.v1.CloudSpannerProperties
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ database |
string
Cloud Spanner database in the form `project/instance/database' |
↳ use_parallelism |
bool
If parallelism should be used when reading from Cloud Spanner |
↳ use_serverless_analytics |
bool
If the serverless analytics service should be used to read data from Cloud Spanner. Note: |
↳ database_role |
string
Optional. Cloud Spanner database role for fine-grained access control. A database role is a collection of fine-grained access privileges. Example: Admin predefines roles that provides user a set of permissions (SELECT, INSERT, ..). The user can then specify a predefined role on a connection to execute their Cloud Spanner query. The role is passthrough here. If the user is not authorized to use the specified role, they get an error. This validation happens on Cloud Spanner. See https://cloud.google.com/spanner/docs/fgac-about for more details. REQUIRES: database role name must start with uppercase/lowercase letter and only contain uppercase/lowercase letters, numbers, and underscores. |
getDatabase
Cloud Spanner database in the form `project/instance/database'
| Returns | |
|---|---|
| Type | Description |
string | |
setDatabase
Cloud Spanner database in the form `project/instance/database'
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUseParallelism
If parallelism should be used when reading from Cloud Spanner
| Returns | |
|---|---|
| Type | Description |
bool | |
setUseParallelism
If parallelism should be used when reading from Cloud Spanner
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUseServerlessAnalytics
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 | |
|---|---|
| Type | Description |
bool | |
setUseServerlessAnalytics
If the serverless analytics service should be used to read data from Cloud Spanner.
Note: use_parallelism must be set when using serverless analytics.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDatabaseRole
Optional. Cloud Spanner database role for fine-grained access control.
A database role is a collection of fine-grained access privileges. Example: Admin predefines roles that provides user a set of permissions (SELECT, INSERT, ..). The user can then specify a predefined role on a connection to execute their Cloud Spanner query. The role is passthrough here. If the user is not authorized to use the specified role, they get an error. This validation happens on Cloud Spanner. See https://cloud.google.com/spanner/docs/fgac-about for more details. REQUIRES: database role name must start with uppercase/lowercase letter and only contain uppercase/lowercase letters, numbers, and underscores.
| Returns | |
|---|---|
| Type | Description |
string | |
setDatabaseRole
Optional. Cloud Spanner database role for fine-grained access control.
A database role is a collection of fine-grained access privileges. Example: Admin predefines roles that provides user a set of permissions (SELECT, INSERT, ..). The user can then specify a predefined role on a connection to execute their Cloud Spanner query. The role is passthrough here. If the user is not authorized to use the specified role, they get an error. This validation happens on Cloud Spanner. See https://cloud.google.com/spanner/docs/fgac-about for more details. REQUIRES: database role name must start with uppercase/lowercase letter and only contain uppercase/lowercase letters, numbers, and underscores.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |