Class DatabaseAdminClient (1.19.2)

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.

Inheritance

builtins.object > google.cloud.spanner_admin_database_v1.gapic.database_admin_client.DatabaseAdminClient > DatabaseAdminClient

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 `Channel` instance through which to make calls. This argument is mutually exclusive with `credentials`; providing both will raise an exception.
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 `transport`; doing so will raise an exception.
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 `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.
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 `projects/<project>/instances/<instance>`.
backup_id	`str` Required. The id of the backup to be created. The `backup_id` appended to `parent` forms the full backup name of the form `projects/<project>/instances/<instance>/backups/<backup_id>`.
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 `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
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 `projects/<project>/instances/<instance>`.
create_statement	`str` Required. A `CREATE DATABASE` statement, which specifies the ID of the new database. The database ID must conform to the regular expression `[a-z][a-z0-9_\-]*[a-z0-9]` and be between 2 and 30 characters in length. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks (:literal:```).
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 `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
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 `projects/<project>/instances/<instance>/backups/<backup>`.
retry	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
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 `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
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 `projects/<project>/instances/<instance>/backups/<backup>`.
retry	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
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 `projects/<project>/instances/<instance>/databases/<database>`.
retry	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
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 `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
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 `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. If a dict is provided, it must be of the same form as the protobuf message GetPolicyOptions
retry	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
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 `projects/<project>/instances/<instance>`.
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: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the `operation` are eligible for filtering: - `name` - The name of the long-running operation - `done` - False if the operation is in progress, else true. - `metadata.@type` - the type of metadata. For example, the type string for `CreateBackupMetadata` is `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`. - `metadata.<field_name>` - any field in metadata.value. - `error` - Error associated with the long-running operation. - `response.@type` - the type of response. - `response.<field_name>` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly. Here are a few examples: - `done:true` - The operation is complete. - `metadata.database:prod` - The database the backup was taken from has a name containing the string "prod". - `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` `(metadata.name:howl) AND` `(metadata.progress.start_time < "2018-03-28T14:50:00Z") AND` `(error:*)` - Returns operations where: - The operation's metadata type is `CreateBackupMetadata`. - The backup name contains the string "howl". - The operation started before 2018-03-28T14:50:00Z. - The operation resulted in an error.
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 `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
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 `projects/<project>/instances/<instance>`.
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: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the `Backup` are eligible for filtering: - `name` - `database` - `state` - `create_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) - `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) - `size_bytes` You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly. Here are a few examples: - `name:Howl` - The backup's name contains the string "howl". - `database:prod` - The database's name contains the string "prod". - `state:CREATING` - The backup is pending creation. - `state:READY` - The backup is fully created and ready for use. - `(name:howl) AND (create_time < "2018-03-28T14:50:00Z")` - The backup name contains the string "howl" and `create_time` of the backup is before 2018-03-28T14:50:00Z. - `expire_time < "2018-03-28T14:50:00Z"` - The backup `expire_time` is before 2018-03-28T14:50:00Z. - `size_bytes > 10000000000` - The backup's size is greater than 10GB
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 `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
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 `projects/<project>/instances/<instance>`.
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: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the `Operation` are eligible for filtering: - `name` - The name of the long-running operation - `done` - False if the operation is in progress, else true. - `metadata.@type` - the type of metadata. For example, the type string for `RestoreDatabaseMetadata` is `type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata`. - `metadata.<field_name>` - any field in metadata.value. - `error` - Error associated with the long-running operation. - `response.@type` - the type of response. - `response.<field_name>` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: - `done:true` - The operation is complete. - `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` `(metadata.source_type:BACKUP) AND` `(metadata.backup_info.backup:backup_howl) AND` `(metadata.name:restored_howl) AND` `(metadata.progress.start_time < "2018-03-28T14:50:00Z") AND` `(error:*)` - Return operations where: - The operation's metadata type is `RestoreDatabaseMetadata`. - The database is restored from a backup. - The backup name contains "backup_howl". - The restored database's name contains "restored_howl". - The operation started before 2018-03-28T14:50:00Z. - The operation resulted in an error.
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 `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
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 `projects/<project>/instances/<instance>`.
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 `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
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 `projects/<project>/instances/<instance>`.
database_id	`str` Required. The id of the database to create and restore to. This database must not already exist. The `database_id` appended to `parent` forms the full database name of the form `projects/<project>/instances/<instance>/databases/<database_id>`.
backup	`str` Name of the backup from which to restore. Values are of the form `projects/<project>/instances/<instance>/backups/<backup>`.
retry	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
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 `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. If a dict is provided, it must be of the same form as the protobuf message Policy
retry	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
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 `resource`. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see `IAM Overview <https://cloud.google.com/iam/docs/overview#permissions>`__.
retry	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
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. `backup.name`, and the fields to be updated as specified by `update_mask` are required. Other fields are ignored. Update is only supported for the following fields: - `backup.expire_time`. If a dict is provided, it must be of the same form as the protobuf message Backup
update_mask	`Union[dict, FieldMask]` Required. A mask specifying which fields (e.g. `expire_time`) in the Backup resource should be updated. This mask is relative to the Backup resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them. If a dict is provided, it must be of the same form as the protobuf message FieldMask
retry	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
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, `operation_id` is used to construct the name of the resulting `Operation`. Specifying an explicit operation ID simplifies determining whether the statements were executed in the event that the `UpdateDatabaseDdl` call is replayed, or the return value is otherwise lost: the `database` and `operation_id` fields can be combined to form the `name` of the resulting `longrunning.Operation`: `<database>/operations/<operation_id>`. `operation_id` should be unique within the database, and must be a valid identifier: `a-z][a-z0-9_]`*. Note that automatically-generated operation IDs always begin with an underscore. If the named operation already exists, `UpdateDatabaseDdl` returns `ALREADY_EXISTS`.
retry	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
timeout	`Optional[float]` The amount of time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
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.

Class DatabaseAdminClient (1.19.2)

Inheritance

Methods

DatabaseAdminClient

backup_path

create_backup

TODO: Initialize backup_id:

TODO: Initialize backup:

Handle metadata.

create_database

TODO: Initialize create_statement:

Handle metadata.

database_path

delete_backup

drop_database

from_service_account_file

from_service_account_json

get_backup

get_database

get_database_ddl

get_iam_policy

TODO: Initialize resource:

instance_path

list_backup_operations

Iterate over all results

Alternatively:

Iterate over results one page at a time

list_backups

Iterate over all results

Alternatively:

Iterate over results one page at a time

list_database_operations

Iterate over all results

Alternatively:

Iterate over results one page at a time

list_databases

Iterate over all results

Alternatively:

Iterate over results one page at a time

restore_database

TODO: Initialize database_id:

Handle metadata.

set_iam_policy

TODO: Initialize resource:

TODO: Initialize policy:

test_iam_permissions

TODO: Initialize resource:

TODO: Initialize permissions:

update_backup

TODO: Initialize backup:

TODO: Initialize update_mask:

update_database_ddl

TODO: Initialize statements:

Handle metadata.

TODO: Initialize `backup_id`:

TODO: Initialize `backup`:

TODO: Initialize `create_statement`:

TODO: Initialize `resource`:

TODO: Initialize `database_id`:

TODO: Initialize `resource`:

TODO: Initialize `policy`:

TODO: Initialize `resource`:

TODO: Initialize `permissions`:

TODO: Initialize `backup`:

TODO: Initialize `update_mask`:

TODO: Initialize `statements`: