- 3.46.0 (latest)
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.1
- 3.39.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.1
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.27.1
- 3.26.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.2
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.1
- 3.14.1
- 3.13.0
- 3.12.1
- 3.11.1
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.0
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.0
- 2.1.1
- 2.0.0
- 1.19.3
- 1.18.0
- 1.17.1
- 1.16.0
- 1.15.1
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
DatabaseAdminClient(
transport=None,
channel=None,
credentials=None,
client_config=None,
client_info=None,
client_options=None,
)
Cloud Spanner Database Admin API
The Cloud Spanner Database Admin API can be used to create, drop, and list databases. It also enables updating the schema of pre-existing databases. It can be also used to create, delete and list backups for a database and to restore from an existing backup.
Methods
DatabaseAdminClient
DatabaseAdminClient(
transport=None,
channel=None,
credentials=None,
client_config=None,
client_info=None,
client_options=None,
)
Constructor.
Parameters | |
---|---|
Name | Description |
channel |
grpc.Channel
DEPRECATED. A |
credentials |
google.auth.credentials.Credentials
The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to |
client_config |
dict
DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is used. |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
client_options |
Union[dict, google.api_core.client_options.ClientOptions]
Client options used to set user options on the client. API Endpoint should be set through client_options. |
backup_path
backup_path(project, instance, backup)
Return a fully-qualified backup string.
create_backup
create_backup(parent, backup_id, backup, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Starts creating a new Cloud Spanner Backup. The returned backup
long-running operation
will have a name of the format
projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>
and can be used to track creation of the backup. The metadata
field
type is CreateBackupMetadata
. The response
field type is
Backup
, if successful. Cancelling the returned operation will stop
the creation and delete the backup. There can be only one pending backup
creation per database. Backup creation of different databases can run
concurrently.
.. rubric:: Example
from google.cloud import spanner_admin_database_v1
client = spanner_admin_database_v1.DatabaseAdminClient()
parent = client.instance_path('[PROJECT]', '[INSTANCE]')
TODO: Initialize
backup_id
:backup_id = ''
TODO: Initialize
backup
:backup = {}
response = client.create_backup(parent, backup_id, backup)
def callback(operation_future): ... # Handle result. ... result = operation_future.result()
response.add_done_callback(callback)
Handle metadata.
metadata = response.metadata()
Parameters | |
---|---|
Name | Description |
parent |
str
Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form |
backup_id |
str
Required. The id of the backup to be created. The |
backup |
Union[dict, Backup]
Required. The backup to create. If a dict is provided, it must be of the same form as the protobuf message Backup |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Exceptions | |
---|---|
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
create_database
create_database(parent, create_statement, extra_statements=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Creates a new Cloud Spanner database and starts to prepare it for
serving. The returned long-running operation
will have a name of the
format <database_name>/operations/<operation_id>
and can be used to
track preparation of the database. The metadata
field type is
CreateDatabaseMetadata
. The response
field type is Database
,
if successful.
.. rubric:: Example
from google.cloud import spanner_admin_database_v1
client = spanner_admin_database_v1.DatabaseAdminClient()
parent = client.instance_path('[PROJECT]', '[INSTANCE]')
TODO: Initialize
create_statement
:create_statement = ''
response = client.create_database(parent, create_statement)
def callback(operation_future): ... # Handle result. ... result = operation_future.result()
response.add_done_callback(callback)
Handle metadata.
metadata = response.metadata()
Parameters | |
---|---|
Name | Description |
parent |
str
Required. The name of the instance that will serve the new database. Values are of the form |
create_statement |
str
Required. A |
extra_statements |
list[str]
Optional. A list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created. |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Exceptions | |
---|---|
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
database_path
database_path(project, instance, database)
Return a fully-qualified database string.
delete_backup
delete_backup(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Deletes a pending or completed Backup
.
.. rubric:: Example
from google.cloud import spanner_admin_database_v1
client = spanner_admin_database_v1.DatabaseAdminClient()
name = client.backup_path('[PROJECT]', '[INSTANCE]', '[BACKUP]')
client.delete_backup(name)
Parameters | |
---|---|
Name | Description |
name |
str
Required. Name of the backup to delete. Values are of the form |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Exceptions | |
---|---|
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
drop_database
drop_database(database, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Drops (aka deletes) a Cloud Spanner database. Completed backups for the
database will be retained according to their expire_time
.
.. rubric:: Example
from google.cloud import spanner_admin_database_v1
client = spanner_admin_database_v1.DatabaseAdminClient()
database = client.database_path('[PROJECT]', '[INSTANCE]', '[DATABASE]')
client.drop_database(database)
Parameters | |
---|---|
Name | Description |
database |
str
Required. The database to be dropped. |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Exceptions | |
---|---|
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
from_service_account_file
from_service_account_file(filename, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
DatabaseAdminClient | The constructed client. |
from_service_account_json
from_service_account_json(filename, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
DatabaseAdminClient | The constructed client. |
get_backup
get_backup(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Gets metadata on a pending or completed Backup
.
.. rubric:: Example
from google.cloud import spanner_admin_database_v1
client = spanner_admin_database_v1.DatabaseAdminClient()
name = client.backup_path('[PROJECT]', '[INSTANCE]', '[BACKUP]')
response = client.get_backup(name)
Parameters | |
---|---|
Name | Description |
name |
str
Required. Name of the backup. Values are of the form |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Exceptions | |
---|---|
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
get_database
get_database(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Gets the state of a Cloud Spanner database.
.. rubric:: Example
from google.cloud import spanner_admin_database_v1
client = spanner_admin_database_v1.DatabaseAdminClient()
name = client.database_path('[PROJECT]', '[INSTANCE]', '[DATABASE]')
response = client.get_database(name)
Parameters | |
---|---|
Name | Description |
name |
str
Required. The name of the requested database. Values are of the form |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Exceptions | |
---|---|
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
get_database_ddl
get_database_ddl(database, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Returns the schema of a Cloud Spanner database as a list of formatted
DDL statements. This method does not show pending schema updates, those
may be queried using the Operations
API.
.. rubric:: Example
from google.cloud import spanner_admin_database_v1
client = spanner_admin_database_v1.DatabaseAdminClient()
database = client.database_path('[PROJECT]', '[INSTANCE]', '[DATABASE]')
response = client.get_database_ddl(database)
Parameters | |
---|---|
Name | Description |
database |
str
Required. The database whose schema we wish to get. |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Exceptions | |
---|---|
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
get_iam_policy
get_iam_policy(resource, options_=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set.
Authorization requires spanner.databases.getIamPolicy
permission on
resource
. For backups, authorization requires
spanner.backups.getIamPolicy
permission on resource
.
.. rubric:: Example
from google.cloud import spanner_admin_database_v1
client = spanner_admin_database_v1.DatabaseAdminClient()
TODO: Initialize
resource
:resource = ''
response = client.get_iam_policy(resource)
Parameters | |
---|---|
Name | Description |
resource |
str
REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
options_ |
Union[dict, GetPolicyOptions]
OPTIONAL: A |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Exceptions | |
---|---|
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
instance_path
instance_path(project, instance)
Return a fully-qualified instance string.
list_backup_operations
list_backup_operations(parent, filter_=None, page_size=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Lists the backup long-running operations
in the given instance. A
backup operation has a name of the form
projects/<project>/instances/<instance>/backups/<backup>/operations/<operation>
.
The long-running operation metadata
field type metadata.type_url
describes the type of the metadata. Operations returned include those
that have completed/failed/canceled within the last 7 days, and pending
operations. Operations returned are ordered by
operation.metadata.value.progress.start_time
in descending order
starting from the most recently started operation.
.. rubric:: Example
from google.cloud import spanner_admin_database_v1
client = spanner_admin_database_v1.DatabaseAdminClient()
parent = client.instance_path('[PROJECT]', '[INSTANCE]')
Iterate over all results
for element in client.list_backup_operations(parent): ... # process element ... pass
Alternatively:
Iterate over results one page at a time
for page in client.list_backup_operations(parent).pages: ... for element in page: ... # process element ... pass
Parameters | |
---|---|
Name | Description |
parent |
str
Required. The instance of the backup operations. Values are of the form |
filter_ |
str
An expression that filters the list of returned backup operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: |
page_size |
int
The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page. |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Exceptions | |
---|---|
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
list_backups
list_backups(parent, filter_=None, page_size=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Lists completed and pending backups. Backups returned are ordered by
create_time
in descending order, starting from the most recent
create_time
.
.. rubric:: Example
from google.cloud import spanner_admin_database_v1
client = spanner_admin_database_v1.DatabaseAdminClient()
parent = client.instance_path('[PROJECT]', '[INSTANCE]')
Iterate over all results
for element in client.list_backups(parent): ... # process element ... pass
Alternatively:
Iterate over results one page at a time
for page in client.list_backups(parent).pages: ... for element in page: ... # process element ... pass
Parameters | |
---|---|
Name | Description |
parent |
str
Required. The instance to list backups from. Values are of the form |
filter_ |
str
An expression that filters the list of returned backups. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: |
page_size |
int
The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page. |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Exceptions | |
---|---|
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
list_database_operations
list_database_operations(parent, filter_=None, page_size=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Lists database longrunning-operations
. A database operation has a
name of the form
projects/<project>/instances/<instance>/databases/<database>/operations/<operation>
.
The long-running operation metadata
field type metadata.type_url
describes the type of the metadata. Operations returned include those
that have completed/failed/canceled within the last 7 days, and pending
operations.
.. rubric:: Example
from google.cloud import spanner_admin_database_v1
client = spanner_admin_database_v1.DatabaseAdminClient()
parent = client.instance_path('[PROJECT]', '[INSTANCE]')
Iterate over all results
for element in client.list_database_operations(parent): ... # process element ... pass
Alternatively:
Iterate over results one page at a time
for page in client.list_database_operations(parent).pages: ... for element in page: ... # process element ... pass
Parameters | |
---|---|
Name | Description |
parent |
str
Required. The instance of the database operations. Values are of the form |
filter_ |
str
An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: |
page_size |
int
The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page. |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Exceptions | |
---|---|
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
list_databases
list_databases(parent, page_size=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Lists Cloud Spanner databases.
.. rubric:: Example
from google.cloud import spanner_admin_database_v1
client = spanner_admin_database_v1.DatabaseAdminClient()
parent = client.instance_path('[PROJECT]', '[INSTANCE]')
Iterate over all results
for element in client.list_databases(parent): ... # process element ... pass
Alternatively:
Iterate over results one page at a time
for page in client.list_databases(parent).pages: ... for element in page: ... # process element ... pass
Parameters | |
---|---|
Name | Description |
parent |
str
Required. The instance whose databases should be listed. Values are of the form |
page_size |
int
The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page. |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Exceptions | |
---|---|
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
restore_database
restore_database(parent, database_id, backup=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Create a new database by restoring from a completed backup. The new
database must be in the same project and in an instance with the same
instance configuration as the instance containing the backup. The
returned database long-running operation
has a name of the format
projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>
,
and can be used to track the progress of the operation, and to cancel
it. The metadata
field type is RestoreDatabaseMetadata
. The
response
type is Database
, if successful. Cancelling the
returned operation will stop the restore and delete the database. There
can be only one database being restored into an instance at a time. Once
the restore operation completes, a new restore operation can be
initiated, without waiting for the optimize operation associated with
the first restore to complete.
.. rubric:: Example
from google.cloud import spanner_admin_database_v1
client = spanner_admin_database_v1.DatabaseAdminClient()
parent = client.instance_path('[PROJECT]', '[INSTANCE]')
TODO: Initialize
database_id
:database_id = ''
response = client.restore_database(parent, database_id)
def callback(operation_future): ... # Handle result. ... result = operation_future.result()
response.add_done_callback(callback)
Handle metadata.
metadata = response.metadata()
Parameters | |
---|---|
Name | Description |
parent |
str
Required. The name of the instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance containing the source backup. Values are of the form |
database_id |
str
Required. The id of the database to create and restore to. This database must not already exist. The |
backup |
str
Name of the backup from which to restore. Values are of the form |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Exceptions | |
---|---|
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
set_iam_policy
set_iam_policy(resource, policy, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Sets the access control policy on a database or backup resource. Replaces any existing policy.
Authorization requires spanner.databases.setIamPolicy
permission on
resource
. For backups, authorization requires
spanner.backups.setIamPolicy
permission on resource
.
.. rubric:: Example
from google.cloud import spanner_admin_database_v1
client = spanner_admin_database_v1.DatabaseAdminClient()
TODO: Initialize
resource
:resource = ''
TODO: Initialize
policy
:policy = {}
response = client.set_iam_policy(resource, policy)
Parameters | |
---|---|
Name | Description |
resource |
str
REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy |
Union[dict, Policy]
REQUIRED: The complete policy to be applied to the |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Exceptions | |
---|---|
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
test_iam_permissions
test_iam_permissions(resource, permissions, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Returns permissions that the caller has on the specified database or backup resource.
Attempting this RPC on a non-existent Cloud Spanner database will result
in a NOT_FOUND error if the user has spanner.databases.list
permission on the containing Cloud Spanner instance. Otherwise returns
an empty set of permissions. Calling this method on a backup that does
not exist will result in a NOT_FOUND error if the user has
spanner.backups.list
permission on the containing instance.
.. rubric:: Example
from google.cloud import spanner_admin_database_v1
client = spanner_admin_database_v1.DatabaseAdminClient()
TODO: Initialize
resource
:resource = ''
TODO: Initialize
permissions
:permissions = []
response = client.test_iam_permissions(resource, permissions)
Parameters | |
---|---|
Name | Description |
resource |
str
REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
permissions |
list[str]
The set of permissions to check for the |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Exceptions | |
---|---|
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
update_backup
update_backup(backup, update_mask, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Updates a pending or completed Backup
.
.. rubric:: Example
from google.cloud import spanner_admin_database_v1
client = spanner_admin_database_v1.DatabaseAdminClient()
TODO: Initialize
backup
:backup = {}
TODO: Initialize
update_mask
:update_mask = {}
response = client.update_backup(backup, update_mask)
Parameters | |
---|---|
Name | Description |
backup |
Union[dict, Backup]
Required. The backup to update. |
update_mask |
Union[dict, FieldMask]
Required. A mask specifying which fields (e.g. |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Exceptions | |
---|---|
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
update_database_ddl
update_database_ddl(database, statements, operation_id=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Updates the schema of a Cloud Spanner database by
creating/altering/dropping tables, columns, indexes, etc. The returned
long-running operation
will have a name of the format
<database_name>/operations/<operation_id>
and can be used to track
execution of the schema change(s). The metadata
field type is
UpdateDatabaseDdlMetadata
. The operation has no response.
.. rubric:: Example
from google.cloud import spanner_admin_database_v1
client = spanner_admin_database_v1.DatabaseAdminClient()
database = client.database_path('[PROJECT]', '[INSTANCE]', '[DATABASE]')
TODO: Initialize
statements
:statements = []
response = client.update_database_ddl(database, statements)
def callback(operation_future): ... # Handle result. ... result = operation_future.result()
response.add_done_callback(callback)
Handle metadata.
metadata = response.metadata()
Parameters | |
---|---|
Name | Description |
database |
str
Required. The database to update. |
statements |
list[str]
Required. DDL statements to be applied to the database. |
operation_id |
str
If empty, the new update request is assigned an automatically-generated operation ID. Otherwise, |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Exceptions | |
---|---|
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |