Class DatabaseAdminClient (3.41.0)

Cloud Spanner Database Admin API

The Cloud Spanner Database Admin API can be used to:

• create, drop, and list databases
• update the schema of pre-existing databases
• create, delete and list backups for a database
• restore a database from an existing backup

Returns the transport used by the client instance.

Instantiates the database admin client.

Releases underlying transport's resources.

Returns a fully-qualified backup string.

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Returns a fully-qualified billing_account string.

Returns a fully-qualified folder string.

Returns a fully-qualified location string.

Returns a fully-qualified organization string.

Returns a fully-qualified project string.

Starts copying a Cloud Spanner Backup. The returned backup long-running operation][google.longrunning.Operation] will have a name of the format projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id> and can be used to track copying of the backup. The operation is associated with the destination backup. The metadata][google.longrunning.Operation.metadata] field type is CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata]. The response][google.longrunning.Operation.response] field type is Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the copying and delete the backup. Concurrent CopyBackup requests can run on the same source backup.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import spanner_admin_database_v1

def sample_copy_backup():
    # Create a client
    client = spanner_admin_database_v1.DatabaseAdminClient()

    # Initialize request argument(s)
    request = spanner_admin_database_v1.CopyBackupRequest(
        parent="parent_value",
        backup_id="backup_id_value",
        source_backup="source_backup_value",
    )

    # Make the request
    operation = client.copy_backup(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Starts creating a new Cloud Spanner Backup. The returned backup long-running operation][google.longrunning.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][google.longrunning.Operation.metadata] field type is CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. The response][google.longrunning.Operation.response] field type is Backup][google.spanner.admin.database.v1.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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import spanner_admin_database_v1

def sample_create_backup():
    # Create a client
    client = spanner_admin_database_v1.DatabaseAdminClient()

    # Initialize request argument(s)
    request = spanner_admin_database_v1.CreateBackupRequest(
        parent="parent_value",
        backup_id="backup_id_value",
    )

    # Make the request
    operation = client.create_backup(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Creates a new Cloud Spanner database and starts to prepare it for serving. The returned [long-running operation][google.longrunning.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][google.longrunning.Operation.metadata] field type is CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The response][google.longrunning.Operation.response] field type is Database][google.spanner.admin.database.v1.Database], if successful.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import spanner_admin_database_v1

def sample_create_database():
    # Create a client
    client = spanner_admin_database_v1.DatabaseAdminClient()

    # Initialize request argument(s)
    request = spanner_admin_database_v1.CreateDatabaseRequest(
        parent="parent_value",
        create_statement="create_statement_value",
    )

    # Make the request
    operation = client.create_database(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Returns a fully-qualified crypto_key string.

Returns a fully-qualified crypto_key_version string.

Returns a fully-qualified database string.

Returns a fully-qualified database_role string.

Deletes a pending or completed Backup][google.spanner.admin.database.v1.Backup].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import spanner_admin_database_v1

def sample_delete_backup():
    # Create a client
    client = spanner_admin_database_v1.DatabaseAdminClient()

    # Initialize request argument(s)
    request = spanner_admin_database_v1.DeleteBackupRequest(
        name="name_value",
    )

    # Make the request
    client.delete_backup(request=request)

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their expire_time. Note: Cloud Spanner might continue to accept requests for a few seconds after the database has been deleted.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import spanner_admin_database_v1

def sample_drop_database():
    # Create a client
    client = spanner_admin_database_v1.DatabaseAdminClient()

    # Initialize request argument(s)
    request = spanner_admin_database_v1.DropDatabaseRequest(
        database="database_value",
    )

    # Make the request
    client.drop_database(request=request)

Creates an instance of this client using the provided credentials file.

Creates an instance of this client using the provided credentials info.

Creates an instance of this client using the provided credentials file.

Gets metadata on a pending or completed Backup][google.spanner.admin.database.v1.Backup].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import spanner_admin_database_v1

def sample_get_backup():
    # Create a client
    client = spanner_admin_database_v1.DatabaseAdminClient()

    # Initialize request argument(s)
    request = spanner_admin_database_v1.GetBackupRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_backup(request=request)

    # Handle the response
    print(response)

Gets the state of a Cloud Spanner database.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import spanner_admin_database_v1

def sample_get_database():
    # Create a client
    client = spanner_admin_database_v1.DatabaseAdminClient()

    # Initialize request argument(s)
    request = spanner_admin_database_v1.GetDatabaseRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_database(request=request)

    # Handle the response
    print(response)

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][google.longrunning.Operations] API.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import spanner_admin_database_v1

def sample_get_database_ddl():
    # Create a client
    client = spanner_admin_database_v1.DatabaseAdminClient()

    # Initialize request argument(s)
    request = spanner_admin_database_v1.GetDatabaseDdlRequest(
        database="database_value",
    )

    # Make the request
    response = client.get_database_ddl(request=request)

    # Handle the response
    print(response)

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][google.iam.v1.GetIamPolicyRequest.resource]. For backups, authorization requires spanner.backups.getIamPolicy permission on resource][google.iam.v1.GetIamPolicyRequest.resource].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import spanner_admin_database_v1
from google.iam.v1 import iam_policy_pb2  # type: ignore

def sample_get_iam_policy():
    # Create a client
    client = spanner_admin_database_v1.DatabaseAdminClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.GetIamPolicyRequest(
        resource="resource_value",
    )

    # Make the request
    response = client.get_iam_policy(request=request)

    # Handle the response
    print(response)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Gets the latest state of a long-running operation.

Returns a fully-qualified instance string.

Lists the backup [long-running operations][google.longrunning.Operation] 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][google.longrunning.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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import spanner_admin_database_v1

def sample_list_backup_operations():
    # Create a client
    client = spanner_admin_database_v1.DatabaseAdminClient()

    # Initialize request argument(s)
    request = spanner_admin_database_v1.ListBackupOperationsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_backup_operations(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Lists completed and pending backups. Backups returned are ordered by create_time in descending order, starting from the most recent create_time.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import spanner_admin_database_v1

def sample_list_backups():
    # Create a client
    client = spanner_admin_database_v1.DatabaseAdminClient()

    # Initialize request argument(s)
    request = spanner_admin_database_v1.ListBackupsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_backups(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Lists database longrunning-operations][google.longrunning.Operation]. A database operation has a name of the form projects/<project>/instances/<instance>/databases/<database>/operations/<operation>. The long-running operation metadata][google.longrunning.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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import spanner_admin_database_v1

def sample_list_database_operations():
    # Create a client
    client = spanner_admin_database_v1.DatabaseAdminClient()

    # Initialize request argument(s)
    request = spanner_admin_database_v1.ListDatabaseOperationsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_database_operations(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Lists Cloud Spanner database roles.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import spanner_admin_database_v1

def sample_list_database_roles():
    # Create a client
    client = spanner_admin_database_v1.DatabaseAdminClient()

    # Initialize request argument(s)
    request = spanner_admin_database_v1.ListDatabaseRolesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_database_roles(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Lists Cloud Spanner databases.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import spanner_admin_database_v1

def sample_list_databases():
    # Create a client
    client = spanner_admin_database_v1.DatabaseAdminClient()

    # Initialize request argument(s)
    request = spanner_admin_database_v1.ListDatabasesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_databases(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Lists operations that match the specified filter in the request.

Parses a backup path into its component segments.

Parse a billing_account path into its component segments.

Parse a folder path into its component segments.

Parse a location path into its component segments.

Parse a organization path into its component segments.

Parse a project path into its component segments.

Parses a crypto_key path into its component segments.

Parses a crypto_key_version path into its component segments.

Parses a database path into its component segments.

Parses a database_role path into its component segments.

Parses a instance path into its component segments.

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][google.longrunning.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][google.longrunning.Operation.metadata] field type is RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata]. The response][google.longrunning.Operation.response] type is Database][google.spanner.admin.database.v1.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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import spanner_admin_database_v1

def sample_restore_database():
    # Create a client
    client = spanner_admin_database_v1.DatabaseAdminClient()

    # Initialize request argument(s)
    request = spanner_admin_database_v1.RestoreDatabaseRequest(
        backup="backup_value",
        parent="parent_value",
        database_id="database_id_value",
    )

    # Make the request
    operation = client.restore_database(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Sets the access control policy on a database or backup resource. Replaces any existing policy.

Authorization requires spanner.databases.setIamPolicy permission on resource][google.iam.v1.SetIamPolicyRequest.resource]. For backups, authorization requires spanner.backups.setIamPolicy permission on resource][google.iam.v1.SetIamPolicyRequest.resource].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import spanner_admin_database_v1
from google.iam.v1 import iam_policy_pb2  # type: ignore

def sample_set_iam_policy():
    # Create a client
    client = spanner_admin_database_v1.DatabaseAdminClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.SetIamPolicyRequest(
        resource="resource_value",
    )

    # Make the request
    response = client.set_iam_policy(request=request)

    # Handle the response
    print(response)

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import spanner_admin_database_v1
from google.iam.v1 import iam_policy_pb2  # type: ignore

def sample_test_iam_permissions():
    # Create a client
    client = spanner_admin_database_v1.DatabaseAdminClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.TestIamPermissionsRequest(
        resource="resource_value",
        permissions=['permissions_value1', 'permissions_value2'],
    )

    # Make the request
    response = client.test_iam_permissions(request=request)

    # Handle the response
    print(response)

Updates a pending or completed Backup][google.spanner.admin.database.v1.Backup].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import spanner_admin_database_v1

def sample_update_backup():
    # Create a client
    client = spanner_admin_database_v1.DatabaseAdminClient()

    # Initialize request argument(s)
    request = spanner_admin_database_v1.UpdateBackupRequest(
    )

    # Make the request
    response = client.update_backup(request=request)

    # Handle the response
    print(response)

Updates a Cloud Spanner database. The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of updating the database. If the named database does not exist, returns NOT_FOUND.

While the operation is pending:

• The database's reconciling][google.spanner.admin.database.v1.Database.reconciling] field is set to true.
• Cancelling the operation is best-effort. If the cancellation succeeds, the operation metadata's cancel_time][google.spanner.admin.database.v1.UpdateDatabaseMetadata.cancel_time] is set, the updates are reverted, and the operation terminates with a CANCELLED status.
• New UpdateDatabase requests will return a FAILED_PRECONDITION error until the pending operation is done (returns successfully or with error).
• Reading the database via the API continues to give the pre-request values.

Upon completion of the returned operation:

• The new values are in effect and readable via the API.
• The database's reconciling][google.spanner.admin.database.v1.Database.reconciling] field becomes false.

The returned [long-running operation][google.longrunning.Operation] will have a name of the format projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id> and can be used to track the database modification. The metadata][google.longrunning.Operation.metadata] field type is UpdateDatabaseMetadata][google.spanner.admin.database.v1.UpdateDatabaseMetadata]. The response][google.longrunning.Operation.response] field type is Database][google.spanner.admin.database.v1.Database], if successful.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import spanner_admin_database_v1

def sample_update_database():
    # Create a client
    client = spanner_admin_database_v1.DatabaseAdminClient()

    # Initialize request argument(s)
    database = spanner_admin_database_v1.Database()
    database.name = "name_value"

    request = spanner_admin_database_v1.UpdateDatabaseRequest(
        database=database,
    )

    # Make the request
    operation = client.update_database(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned long-running operation][google.longrunning.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][google.longrunning.Operation.metadata] field type is UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The operation has no response.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import spanner_admin_database_v1

def sample_update_database_ddl():
    # Create a client
    client = spanner_admin_database_v1.DatabaseAdminClient()

    # Initialize request argument(s)
    request = spanner_admin_database_v1.UpdateDatabaseDdlRequest(
        database="database_value",
        statements=['statements_value1', 'statements_value2'],
    )

    # Make the request
    operation = client.update_database_ddl(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)