DatabaseAdmin¶
- class google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.spanner_admin_database_v1.services.database_admin.transports.base.DatabaseAdminTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶
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
Instantiates the database admin client.
- Parameters
credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport (Union[str, DatabaseAdminTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_endpoint
property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_cert_source
property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.
- Raises
google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.
- static backup_path(project: str, instance: str, backup: str) str ¶
Returns a fully-qualified backup string.
- static common_billing_account_path(billing_account: str) str ¶
Returns a fully-qualified billing_account string.
- static common_folder_path(folder: str) str ¶
Returns a fully-qualified folder string.
- static common_location_path(project: str, location: str) str ¶
Returns a fully-qualified location string.
- static common_organization_path(organization: str) str ¶
Returns a fully-qualified organization string.
- static common_project_path(project: str) str ¶
Returns a fully-qualified project string.
- async create_backup(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.backup.CreateBackupRequest, dict]] = None, *, parent: Optional[str] = None, backup: Optional[google.cloud.spanner_admin_database_v1.types.backup.Backup] = None, backup_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
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.- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.CreateBackupRequest, dict]) – The request object. The request for [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup].
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>
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.backup (
google.cloud.spanner_admin_database_v1.types.Backup
) – Required. The backup to create. This corresponds to thebackup
field on therequest
instance; ifrequest
is provided, this should not be set.backup_id (
str
) –Required. The id of the backup to be created. The
backup_id
appended toparent
forms the full backup name of the formprojects/<project>/instances/<instance>/backups/<backup_id>
.This corresponds to the
backup_id
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.cloud.spanner_admin_database_v1.types.Backup
A backup of a Cloud Spanner database.- Return type
google.api_core.operation_async.AsyncOperation
- async create_database(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.spanner_database_admin.CreateDatabaseRequest, dict]] = None, *, parent: Optional[str] = None, create_statement: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
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.- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.CreateDatabaseRequest, dict]) – The request object. The request for [CreateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase].
parent (
str
) –Required. The name of the instance that will serve the new database. Values are of the form
projects/<project>/instances/<instance>
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.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 (`
).This corresponds to the
create_statement
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.cloud.spanner_admin_database_v1.types.Database
A Cloud Spanner database.- Return type
google.api_core.operation_async.AsyncOperation
- static crypto_key_path(project: str, location: str, key_ring: str, crypto_key: str) str ¶
Returns a fully-qualified crypto_key string.
- static crypto_key_version_path(project: str, location: str, key_ring: str, crypto_key: str, crypto_key_version: str) str ¶
Returns a fully-qualified crypto_key_version string.
- static database_path(project: str, instance: str, database: str) str ¶
Returns a fully-qualified database string.
- async delete_backup(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.backup.DeleteBackupRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.DeleteBackupRequest, dict]) – The request object. The request for [DeleteBackup][google.spanner.admin.database.v1.DatabaseAdmin.DeleteBackup].
name (
str
) –Required. Name of the backup to delete. Values are of the form
projects/<project>/instances/<instance>/backups/<backup>
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- async drop_database(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.spanner_database_admin.DropDatabaseRequest, dict]] = None, *, database: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
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.- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.DropDatabaseRequest, dict]) – The request object. The request for [DropDatabase][google.spanner.admin.database.v1.DatabaseAdmin.DropDatabase].
database (
str
) – Required. The database to be dropped. This corresponds to thedatabase
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
info.
- Parameters
info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_json(filename: str, *args, **kwargs)¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- async get_backup(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.backup.GetBackupRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_admin_database_v1.types.backup.Backup [source]¶
Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.GetBackupRequest, dict]) – The request object. The request for [GetBackup][google.spanner.admin.database.v1.DatabaseAdmin.GetBackup].
name (
str
) –Required. Name of the backup. Values are of the form
projects/<project>/instances/<instance>/backups/<backup>
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
A backup of a Cloud Spanner database.
- Return type
- async get_database(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.spanner_database_admin.GetDatabaseRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_admin_database_v1.types.spanner_database_admin.Database [source]¶
Gets the state of a Cloud Spanner database.
- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.GetDatabaseRequest, dict]) – The request object. The request for [GetDatabase][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabase].
name (
str
) –Required. The name of the requested database. Values are of the form
projects/<project>/instances/<instance>/databases/<database>
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
A Cloud Spanner database.
- Return type
- async get_database_ddl(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.spanner_database_admin.GetDatabaseDdlRequest, dict]] = None, *, database: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_admin_database_v1.types.spanner_database_admin.GetDatabaseDdlResponse [source]¶
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.
- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.GetDatabaseDdlRequest, dict]) – The request object. The request for [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].
database (
str
) –Required. The database whose schema we wish to get. Values are of the form
projects/<project>/instances/<instance>/databases/<database>
This corresponds to the
database
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
The response for [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].
- Return type
google.cloud.spanner_admin_database_v1.types.GetDatabaseDdlResponse
- async get_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]] = None, *, resource: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.policy_pb2.Policy [source]¶
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 requiresspanner.backups.getIamPolicy
permission on [resource][google.iam.v1.GetIamPolicyRequest.resource].- Parameters
request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]) – The request object. Request message for GetIamPolicy method.
resource (
str
) –REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
This corresponds to the
resource
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
- Defines an Identity and Access Management (IAM) policy. It is used to
specify access control policies for Cloud Platform resources.
A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.
JSON Example
- {
- “bindings”: [
- {
“role”: “roles/resourcemanager.organizationAdmin”, “members”: [ “user:mike@example.com”, “group:admins@example.com”, “domain:google.com”, “serviceAccount:my-project-id@appspot.gserviceaccount.com” ]
}, { “role”: “roles/resourcemanager.organizationViewer”, “members”: [“user:eve@example.com”], “condition”: { “title”: “expirable access”, “description”: “Does not grant access after Sep 2020”, “expression”: “request.time < timestamp(‘2020-10-01T00:00:00.000Z’)”, } }
]
}
YAML Example
bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp(‘2020-10-01T00:00:00.000Z’)
For a description of IAM and its features, see the [IAM developer’s guide](https://cloud.google.com/iam/docs).
- Return type
google.iam.v1.policy_pb2.Policy
- classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶
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 variabel 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.
- Parameters
client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.
- Returns
- returns the API endpoint and the
client cert source to use.
- Return type
Tuple[str, Callable[[], Tuple[bytes, bytes]]]
- Raises
google.auth.exceptions.MutualTLSChannelError – If any errors happen.
- get_transport_class() Type[google.cloud.spanner_admin_database_v1.services.database_admin.transports.base.DatabaseAdminTransport] ¶
Returns an appropriate transport class.
- Parameters
label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
- Returns
The transport class to use.
- static instance_path(project: str, instance: str) str ¶
Returns a fully-qualified instance string.
- async list_backup_operations(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.backup.ListBackupOperationsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupOperationsAsyncPager [source]¶
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 typemetadata.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 byoperation.metadata.value.progress.start_time
in descending order starting from the most recently started operation.- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.ListBackupOperationsRequest, dict]) – The request object. The request for [ListBackupOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperations].
parent (
str
) –Required. The instance of the backup operations. Values are of the form
projects/<project>/instances/<instance>
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
- The response for
[ListBackupOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperations].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupOperationsAsyncPager
- async list_backups(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.backup.ListBackupsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupsAsyncPager [source]¶
Lists completed and pending backups. Backups returned are ordered by
create_time
in descending order, starting from the most recentcreate_time
.- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.ListBackupsRequest, dict]) – The request object. The request for [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups].
parent (
str
) –Required. The instance to list backups from. Values are of the form
projects/<project>/instances/<instance>
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
The response for [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupsAsyncPager
- async list_database_operations(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseOperationsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseOperationsAsyncPager [source]¶
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 typemetadata.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.- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.ListDatabaseOperationsRequest, dict]) – The request object. The request for [ListDatabaseOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseOperations].
parent (
str
) –Required. The instance of the database operations. Values are of the form
projects/<project>/instances/<instance>
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
- The response for
[ListDatabaseOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseOperations].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
- async list_databases(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabasesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabasesAsyncPager [source]¶
Lists Cloud Spanner databases.
- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.ListDatabasesRequest, dict]) – The request object. The request for [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].
parent (
str
) –Required. The instance whose databases should be listed. Values are of the form
projects/<project>/instances/<instance>
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
The response for [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabasesAsyncPager
- static parse_backup_path(path: str) Dict[str, str] ¶
Parses a backup path into its component segments.
- static parse_common_billing_account_path(path: str) Dict[str, str] ¶
Parse a billing_account path into its component segments.
- static parse_common_folder_path(path: str) Dict[str, str] ¶
Parse a folder path into its component segments.
- static parse_common_location_path(path: str) Dict[str, str] ¶
Parse a location path into its component segments.
- static parse_common_organization_path(path: str) Dict[str, str] ¶
Parse a organization path into its component segments.
- static parse_common_project_path(path: str) Dict[str, str] ¶
Parse a project path into its component segments.
- static parse_crypto_key_path(path: str) Dict[str, str] ¶
Parses a crypto_key path into its component segments.
- static parse_crypto_key_version_path(path: str) Dict[str, str] ¶
Parses a crypto_key_version path into its component segments.
- static parse_database_path(path: str) Dict[str, str] ¶
Parses a database path into its component segments.
- static parse_instance_path(path: str) Dict[str, str] ¶
Parses a instance path into its component segments.
- async restore_database(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.spanner_database_admin.RestoreDatabaseRequest, dict]] = None, *, parent: Optional[str] = None, database_id: Optional[str] = None, backup: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
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.- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.RestoreDatabaseRequest, dict]) – The request object. The request for [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase].
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>
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.database_id (
str
) –Required. The id of the database to create and restore to. This database must not already exist. The
database_id
appended toparent
forms the full database name of the formprojects/<project>/instances/<instance>/databases/<database_id>
.This corresponds to the
database_id
field on therequest
instance; ifrequest
is provided, this should not be set.backup (
str
) –Name of the backup from which to restore. Values are of the form
projects/<project>/instances/<instance>/backups/<backup>
.This corresponds to the
backup
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.cloud.spanner_admin_database_v1.types.Database
A Cloud Spanner database.- Return type
google.api_core.operation_async.AsyncOperation
- async set_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]] = None, *, resource: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.policy_pb2.Policy [source]¶
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 requiresspanner.backups.setIamPolicy
permission on [resource][google.iam.v1.SetIamPolicyRequest.resource].- Parameters
request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]) – The request object. Request message for SetIamPolicy method.
resource (
str
) –REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
This corresponds to the
resource
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
- Defines an Identity and Access Management (IAM) policy. It is used to
specify access control policies for Cloud Platform resources.
A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.
JSON Example
- {
- “bindings”: [
- {
“role”: “roles/resourcemanager.organizationAdmin”, “members”: [ “user:mike@example.com”, “group:admins@example.com”, “domain:google.com”, “serviceAccount:my-project-id@appspot.gserviceaccount.com” ]
}, { “role”: “roles/resourcemanager.organizationViewer”, “members”: [“user:eve@example.com”], “condition”: { “title”: “expirable access”, “description”: “Does not grant access after Sep 2020”, “expression”: “request.time < timestamp(‘2020-10-01T00:00:00.000Z’)”, } }
]
}
YAML Example
bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp(‘2020-10-01T00:00:00.000Z’)
For a description of IAM and its features, see the [IAM developer’s guide](https://cloud.google.com/iam/docs).
- Return type
google.iam.v1.policy_pb2.Policy
- async test_iam_permissions(request: Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]] = None, *, resource: Optional[str] = None, permissions: Optional[Sequence[str]] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse [source]¶
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 hasspanner.backups.list
permission on the containing instance.- Parameters
request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]) – The request object. Request message for TestIamPermissions method.
resource (
str
) –REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
This corresponds to the
resource
field on therequest
instance; ifrequest
is provided, this should not be set.permissions (
Sequence[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.This corresponds to the
permissions
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Response message for TestIamPermissions method.
- Return type
google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
- property transport: google.cloud.spanner_admin_database_v1.services.database_admin.transports.base.DatabaseAdminTransport¶
Returns the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
DatabaseAdminTransport
- async update_backup(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.backup.UpdateBackupRequest, dict]] = None, *, backup: Optional[google.cloud.spanner_admin_database_v1.types.backup.Backup] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_admin_database_v1.types.backup.Backup [source]¶
Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.UpdateBackupRequest, dict]) – The request object. The request for [UpdateBackup][google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackup].
backup (
google.cloud.spanner_admin_database_v1.types.Backup
) –Required. The backup to update.
backup.name
, and the fields to be updated as specified byupdate_mask
are required. Other fields are ignored. Update is only supported for the following fields:backup.expire_time
.
This corresponds to the
backup
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
google.protobuf.field_mask_pb2.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.This corresponds to the
update_mask
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
A backup of a Cloud Spanner database.
- Return type
- async update_database_ddl(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.spanner_database_admin.UpdateDatabaseDdlRequest, dict]] = None, *, database: Optional[str] = None, statements: Optional[Sequence[str]] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
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.- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.UpdateDatabaseDdlRequest, dict]) – The request object. Enqueues the given DDL statements to be applied, in order but not necessarily all at once, to the database schema at some point (or points) in the future. The server checks that the statements are executable (syntactically valid, name tables that exist, etc.) before enqueueing them, but they may still fail upon later execution (e.g., if a statement from another batch of statements is applied first and it conflicts in some way, or if there is some data-related problem like a NULL value in a column to which NOT NULL would be added). If a statement fails, all subsequent statements in the batch are automatically cancelled. Each batch of statements is assigned a name which can be used with the [Operations][google.longrunning.Operations] API to monitor progress. See the [operation_id][google.spanner.admin.database.v1.UpdateDatabaseDdlRequest.operation_id] field for more details.
database (
str
) – Required. The database to update. This corresponds to thedatabase
field on therequest
instance; ifrequest
is provided, this should not be set.statements (
Sequence[str]
) –Required. DDL statements to be applied to the database.
This corresponds to the
statements
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
- The result type for the operation will be
google.protobuf.empty_pb2.Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
- service Foo {
rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
}
The JSON representation for Empty is empty JSON object {}.
- The result type for the operation will be
- Return type
google.api_core.operation_async.AsyncOperation
- class google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.spanner_admin_database_v1.services.database_admin.transports.base.DatabaseAdminTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶
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
Instantiates the database admin client.
- Parameters
credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport (Union[str, DatabaseAdminTransport]) – The transport to use. If set to None, a transport is chosen automatically.
client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_endpoint
property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_cert_source
property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be 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.
- Raises
google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.
- __exit__(type, value, traceback)[source]¶
Releases underlying transport’s resources.
Warning
ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!
- static backup_path(project: str, instance: str, backup: str) str [source]¶
Returns a fully-qualified backup string.
- static common_billing_account_path(billing_account: str) str [source]¶
Returns a fully-qualified billing_account string.
- static common_location_path(project: str, location: str) str [source]¶
Returns a fully-qualified location string.
- static common_organization_path(organization: str) str [source]¶
Returns a fully-qualified organization string.
- create_backup(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.backup.CreateBackupRequest, dict]] = None, *, parent: Optional[str] = None, backup: Optional[google.cloud.spanner_admin_database_v1.types.backup.Backup] = None, backup_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
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.- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.CreateBackupRequest, dict]) – The request object. The request for [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup].
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>
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.backup (google.cloud.spanner_admin_database_v1.types.Backup) – Required. The backup to create. This corresponds to the
backup
field on therequest
instance; ifrequest
is provided, this should not be set.backup_id (str) –
Required. The id of the backup to be created. The
backup_id
appended toparent
forms the full backup name of the formprojects/<project>/instances/<instance>/backups/<backup_id>
.This corresponds to the
backup_id
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.cloud.spanner_admin_database_v1.types.Backup
A backup of a Cloud Spanner database.- Return type
google.api_core.operation.Operation
- create_database(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.spanner_database_admin.CreateDatabaseRequest, dict]] = None, *, parent: Optional[str] = None, create_statement: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
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.- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.CreateDatabaseRequest, dict]) – The request object. The request for [CreateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase].
parent (str) –
Required. The name of the instance that will serve the new database. Values are of the form
projects/<project>/instances/<instance>
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.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 (`
).This corresponds to the
create_statement
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.cloud.spanner_admin_database_v1.types.Database
A Cloud Spanner database.- Return type
google.api_core.operation.Operation
- static crypto_key_path(project: str, location: str, key_ring: str, crypto_key: str) str [source]¶
Returns a fully-qualified crypto_key string.
- static crypto_key_version_path(project: str, location: str, key_ring: str, crypto_key: str, crypto_key_version: str) str [source]¶
Returns a fully-qualified crypto_key_version string.
- static database_path(project: str, instance: str, database: str) str [source]¶
Returns a fully-qualified database string.
- delete_backup(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.backup.DeleteBackupRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.DeleteBackupRequest, dict]) – The request object. The request for [DeleteBackup][google.spanner.admin.database.v1.DatabaseAdmin.DeleteBackup].
name (str) –
Required. Name of the backup to delete. Values are of the form
projects/<project>/instances/<instance>/backups/<backup>
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- drop_database(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.spanner_database_admin.DropDatabaseRequest, dict]] = None, *, database: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
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.- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.DropDatabaseRequest, dict]) – The request object. The request for [DropDatabase][google.spanner.admin.database.v1.DatabaseAdmin.DropDatabase].
database (str) – Required. The database to be dropped. This corresponds to the
database
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
info.
- Parameters
info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_json(filename: str, *args, **kwargs)¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- get_backup(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.backup.GetBackupRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_admin_database_v1.types.backup.Backup [source]¶
Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.GetBackupRequest, dict]) – The request object. The request for [GetBackup][google.spanner.admin.database.v1.DatabaseAdmin.GetBackup].
name (str) –
Required. Name of the backup. Values are of the form
projects/<project>/instances/<instance>/backups/<backup>
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
A backup of a Cloud Spanner database.
- Return type
- get_database(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.spanner_database_admin.GetDatabaseRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_admin_database_v1.types.spanner_database_admin.Database [source]¶
Gets the state of a Cloud Spanner database.
- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.GetDatabaseRequest, dict]) – The request object. The request for [GetDatabase][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabase].
name (str) –
Required. The name of the requested database. Values are of the form
projects/<project>/instances/<instance>/databases/<database>
.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
A Cloud Spanner database.
- Return type
- get_database_ddl(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.spanner_database_admin.GetDatabaseDdlRequest, dict]] = None, *, database: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_admin_database_v1.types.spanner_database_admin.GetDatabaseDdlResponse [source]¶
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.
- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.GetDatabaseDdlRequest, dict]) – The request object. The request for [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].
database (str) –
Required. The database whose schema we wish to get. Values are of the form
projects/<project>/instances/<instance>/databases/<database>
This corresponds to the
database
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
The response for [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].
- Return type
google.cloud.spanner_admin_database_v1.types.GetDatabaseDdlResponse
- get_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]] = None, *, resource: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.policy_pb2.Policy [source]¶
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 requiresspanner.backups.getIamPolicy
permission on [resource][google.iam.v1.GetIamPolicyRequest.resource].- Parameters
request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]) – The request object. Request message for GetIamPolicy method.
resource (str) –
REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
This corresponds to the
resource
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
- Defines an Identity and Access Management (IAM) policy. It is used to
specify access control policies for Cloud Platform resources.
A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.
JSON Example
- {
- “bindings”: [
- {
“role”: “roles/resourcemanager.organizationAdmin”, “members”: [ “user:mike@example.com”, “group:admins@example.com”, “domain:google.com”, “serviceAccount:my-project-id@appspot.gserviceaccount.com” ]
}, { “role”: “roles/resourcemanager.organizationViewer”, “members”: [“user:eve@example.com”], “condition”: { “title”: “expirable access”, “description”: “Does not grant access after Sep 2020”, “expression”: “request.time < timestamp(‘2020-10-01T00:00:00.000Z’)”, } }
]
}
YAML Example
bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp(‘2020-10-01T00:00:00.000Z’)
For a description of IAM and its features, see the [IAM developer’s guide](https://cloud.google.com/iam/docs).
- Return type
google.iam.v1.policy_pb2.Policy
- classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶
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 variabel 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.
- Parameters
client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.
- Returns
- returns the API endpoint and the
client cert source to use.
- Return type
Tuple[str, Callable[[], Tuple[bytes, bytes]]]
- Raises
google.auth.exceptions.MutualTLSChannelError – If any errors happen.
- static instance_path(project: str, instance: str) str [source]¶
Returns a fully-qualified instance string.
- list_backup_operations(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.backup.ListBackupOperationsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupOperationsPager [source]¶
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 typemetadata.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 byoperation.metadata.value.progress.start_time
in descending order starting from the most recently started operation.- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.ListBackupOperationsRequest, dict]) – The request object. The request for [ListBackupOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperations].
parent (str) –
Required. The instance of the backup operations. Values are of the form
projects/<project>/instances/<instance>
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
- The response for
[ListBackupOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperations].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupOperationsPager
- list_backups(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.backup.ListBackupsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupsPager [source]¶
Lists completed and pending backups. Backups returned are ordered by
create_time
in descending order, starting from the most recentcreate_time
.- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.ListBackupsRequest, dict]) – The request object. The request for [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups].
parent (str) –
Required. The instance to list backups from. Values are of the form
projects/<project>/instances/<instance>
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
The response for [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupsPager
- list_database_operations(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseOperationsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseOperationsPager [source]¶
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 typemetadata.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.- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.ListDatabaseOperationsRequest, dict]) – The request object. The request for [ListDatabaseOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseOperations].
parent (str) –
Required. The instance of the database operations. Values are of the form
projects/<project>/instances/<instance>
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
- The response for
[ListDatabaseOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseOperations].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseOperationsPager
- list_databases(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabasesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabasesPager [source]¶
Lists Cloud Spanner databases.
- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.ListDatabasesRequest, dict]) – The request object. The request for [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].
parent (str) –
Required. The instance whose databases should be listed. Values are of the form
projects/<project>/instances/<instance>
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
The response for [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabasesPager
- static parse_backup_path(path: str) Dict[str, str] [source]¶
Parses a backup path into its component segments.
- static parse_common_billing_account_path(path: str) Dict[str, str] [source]¶
Parse a billing_account path into its component segments.
- static parse_common_folder_path(path: str) Dict[str, str] [source]¶
Parse a folder path into its component segments.
- static parse_common_location_path(path: str) Dict[str, str] [source]¶
Parse a location path into its component segments.
- static parse_common_organization_path(path: str) Dict[str, str] [source]¶
Parse a organization path into its component segments.
- static parse_common_project_path(path: str) Dict[str, str] [source]¶
Parse a project path into its component segments.
- static parse_crypto_key_path(path: str) Dict[str, str] [source]¶
Parses a crypto_key path into its component segments.
- static parse_crypto_key_version_path(path: str) Dict[str, str] [source]¶
Parses a crypto_key_version path into its component segments.
- static parse_database_path(path: str) Dict[str, str] [source]¶
Parses a database path into its component segments.
- static parse_instance_path(path: str) Dict[str, str] [source]¶
Parses a instance path into its component segments.
- restore_database(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.spanner_database_admin.RestoreDatabaseRequest, dict]] = None, *, parent: Optional[str] = None, database_id: Optional[str] = None, backup: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
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.- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.RestoreDatabaseRequest, dict]) – The request object. The request for [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase].
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>
.This corresponds to the
parent
field on therequest
instance; ifrequest
is provided, this should not be set.database_id (str) –
Required. The id of the database to create and restore to. This database must not already exist. The
database_id
appended toparent
forms the full database name of the formprojects/<project>/instances/<instance>/databases/<database_id>
.This corresponds to the
database_id
field on therequest
instance; ifrequest
is provided, this should not be set.backup (str) –
Name of the backup from which to restore. Values are of the form
projects/<project>/instances/<instance>/backups/<backup>
.This corresponds to the
backup
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
The result type for the operation will be
google.cloud.spanner_admin_database_v1.types.Database
A Cloud Spanner database.- Return type
google.api_core.operation.Operation
- set_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]] = None, *, resource: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.policy_pb2.Policy [source]¶
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 requiresspanner.backups.setIamPolicy
permission on [resource][google.iam.v1.SetIamPolicyRequest.resource].- Parameters
request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]) – The request object. Request message for SetIamPolicy method.
resource (str) –
REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
This corresponds to the
resource
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
- Defines an Identity and Access Management (IAM) policy. It is used to
specify access control policies for Cloud Platform resources.
A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.
JSON Example
- {
- “bindings”: [
- {
“role”: “roles/resourcemanager.organizationAdmin”, “members”: [ “user:mike@example.com”, “group:admins@example.com”, “domain:google.com”, “serviceAccount:my-project-id@appspot.gserviceaccount.com” ]
}, { “role”: “roles/resourcemanager.organizationViewer”, “members”: [“user:eve@example.com”], “condition”: { “title”: “expirable access”, “description”: “Does not grant access after Sep 2020”, “expression”: “request.time < timestamp(‘2020-10-01T00:00:00.000Z’)”, } }
]
}
YAML Example
bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp(‘2020-10-01T00:00:00.000Z’)
For a description of IAM and its features, see the [IAM developer’s guide](https://cloud.google.com/iam/docs).
- Return type
google.iam.v1.policy_pb2.Policy
- test_iam_permissions(request: Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]] = None, *, resource: Optional[str] = None, permissions: Optional[Sequence[str]] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse [source]¶
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 hasspanner.backups.list
permission on the containing instance.- Parameters
request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]) – The request object. Request message for TestIamPermissions method.
resource (str) –
REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
This corresponds to the
resource
field on therequest
instance; ifrequest
is provided, this should not be set.permissions (Sequence[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.This corresponds to the
permissions
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
Response message for TestIamPermissions method.
- Return type
google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
- property transport: google.cloud.spanner_admin_database_v1.services.database_admin.transports.base.DatabaseAdminTransport¶
Returns the transport used by the client instance.
- Returns
- The transport used by the client
instance.
- Return type
DatabaseAdminTransport
- update_backup(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.backup.UpdateBackupRequest, dict]] = None, *, backup: Optional[google.cloud.spanner_admin_database_v1.types.backup.Backup] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.spanner_admin_database_v1.types.backup.Backup [source]¶
Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.UpdateBackupRequest, dict]) – The request object. The request for [UpdateBackup][google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackup].
backup (google.cloud.spanner_admin_database_v1.types.Backup) –
Required. The backup to update.
backup.name
, and the fields to be updated as specified byupdate_mask
are required. Other fields are ignored. Update is only supported for the following fields:backup.expire_time
.
This corresponds to the
backup
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (google.protobuf.field_mask_pb2.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.This corresponds to the
update_mask
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
A backup of a Cloud Spanner database.
- Return type
- update_database_ddl(request: Optional[Union[google.cloud.spanner_admin_database_v1.types.spanner_database_admin.UpdateDatabaseDdlRequest, dict]] = None, *, database: Optional[str] = None, statements: Optional[Sequence[str]] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = _MethodDefault._DEFAULT_VALUE, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
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.- Parameters
request (Union[google.cloud.spanner_admin_database_v1.types.UpdateDatabaseDdlRequest, dict]) – The request object. Enqueues the given DDL statements to be applied, in order but not necessarily all at once, to the database schema at some point (or points) in the future. The server checks that the statements are executable (syntactically valid, name tables that exist, etc.) before enqueueing them, but they may still fail upon later execution (e.g., if a statement from another batch of statements is applied first and it conflicts in some way, or if there is some data-related problem like a NULL value in a column to which NOT NULL would be added). If a statement fails, all subsequent statements in the batch are automatically cancelled. Each batch of statements is assigned a name which can be used with the [Operations][google.longrunning.Operations] API to monitor progress. See the [operation_id][google.spanner.admin.database.v1.UpdateDatabaseDdlRequest.operation_id] field for more details.
database (str) – Required. The database to update. This corresponds to the
database
field on therequest
instance; ifrequest
is provided, this should not be set.statements (Sequence[str]) –
Required. DDL statements to be applied to the database.
This corresponds to the
statements
field on therequest
instance; ifrequest
is provided, this should not be set.retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- Returns
An object representing a long-running operation.
- The result type for the operation will be
google.protobuf.empty_pb2.Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
- service Foo {
rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
}
The JSON representation for Empty is empty JSON object {}.
- The result type for the operation will be
- Return type
google.api_core.operation.Operation
- class google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupOperationsAsyncPager(method: Callable[[...], Awaitable[google.cloud.spanner_admin_database_v1.types.backup.ListBackupOperationsResponse]], request: google.cloud.spanner_admin_database_v1.types.backup.ListBackupOperationsRequest, response: google.cloud.spanner_admin_database_v1.types.backup.ListBackupOperationsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_backup_operations
requests.This class thinly wraps an initial
google.cloud.spanner_admin_database_v1.types.ListBackupOperationsResponse
object, and provides an__aiter__
method to iterate through itsoperations
field.If there are more pages, the
__aiter__
method will make additionalListBackupOperations
requests and continue to iterate through theoperations
field on the corresponding responses.All the usual
google.cloud.spanner_admin_database_v1.types.ListBackupOperationsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.spanner_admin_database_v1.types.ListBackupOperationsRequest) – The initial request object.
response (google.cloud.spanner_admin_database_v1.types.ListBackupOperationsResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- class google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupOperationsPager(method: Callable[[...], google.cloud.spanner_admin_database_v1.types.backup.ListBackupOperationsResponse], request: google.cloud.spanner_admin_database_v1.types.backup.ListBackupOperationsRequest, response: google.cloud.spanner_admin_database_v1.types.backup.ListBackupOperationsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_backup_operations
requests.This class thinly wraps an initial
google.cloud.spanner_admin_database_v1.types.ListBackupOperationsResponse
object, and provides an__iter__
method to iterate through itsoperations
field.If there are more pages, the
__iter__
method will make additionalListBackupOperations
requests and continue to iterate through theoperations
field on the corresponding responses.All the usual
google.cloud.spanner_admin_database_v1.types.ListBackupOperationsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.spanner_admin_database_v1.types.ListBackupOperationsRequest) – The initial request object.
response (google.cloud.spanner_admin_database_v1.types.ListBackupOperationsResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- class google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupsAsyncPager(method: Callable[[...], Awaitable[google.cloud.spanner_admin_database_v1.types.backup.ListBackupsResponse]], request: google.cloud.spanner_admin_database_v1.types.backup.ListBackupsRequest, response: google.cloud.spanner_admin_database_v1.types.backup.ListBackupsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_backups
requests.This class thinly wraps an initial
google.cloud.spanner_admin_database_v1.types.ListBackupsResponse
object, and provides an__aiter__
method to iterate through itsbackups
field.If there are more pages, the
__aiter__
method will make additionalListBackups
requests and continue to iterate through thebackups
field on the corresponding responses.All the usual
google.cloud.spanner_admin_database_v1.types.ListBackupsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.spanner_admin_database_v1.types.ListBackupsRequest) – The initial request object.
response (google.cloud.spanner_admin_database_v1.types.ListBackupsResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- class google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupsPager(method: Callable[[...], google.cloud.spanner_admin_database_v1.types.backup.ListBackupsResponse], request: google.cloud.spanner_admin_database_v1.types.backup.ListBackupsRequest, response: google.cloud.spanner_admin_database_v1.types.backup.ListBackupsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_backups
requests.This class thinly wraps an initial
google.cloud.spanner_admin_database_v1.types.ListBackupsResponse
object, and provides an__iter__
method to iterate through itsbackups
field.If there are more pages, the
__iter__
method will make additionalListBackups
requests and continue to iterate through thebackups
field on the corresponding responses.All the usual
google.cloud.spanner_admin_database_v1.types.ListBackupsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.spanner_admin_database_v1.types.ListBackupsRequest) – The initial request object.
response (google.cloud.spanner_admin_database_v1.types.ListBackupsResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- class google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseOperationsAsyncPager(method: Callable[[...], Awaitable[google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseOperationsResponse]], request: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseOperationsRequest, response: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseOperationsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_database_operations
requests.This class thinly wraps an initial
google.cloud.spanner_admin_database_v1.types.ListDatabaseOperationsResponse
object, and provides an__aiter__
method to iterate through itsoperations
field.If there are more pages, the
__aiter__
method will make additionalListDatabaseOperations
requests and continue to iterate through theoperations
field on the corresponding responses.All the usual
google.cloud.spanner_admin_database_v1.types.ListDatabaseOperationsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.spanner_admin_database_v1.types.ListDatabaseOperationsRequest) – The initial request object.
response (google.cloud.spanner_admin_database_v1.types.ListDatabaseOperationsResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- class google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseOperationsPager(method: Callable[[...], google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseOperationsResponse], request: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseOperationsRequest, response: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseOperationsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_database_operations
requests.This class thinly wraps an initial
google.cloud.spanner_admin_database_v1.types.ListDatabaseOperationsResponse
object, and provides an__iter__
method to iterate through itsoperations
field.If there are more pages, the
__iter__
method will make additionalListDatabaseOperations
requests and continue to iterate through theoperations
field on the corresponding responses.All the usual
google.cloud.spanner_admin_database_v1.types.ListDatabaseOperationsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.spanner_admin_database_v1.types.ListDatabaseOperationsRequest) – The initial request object.
response (google.cloud.spanner_admin_database_v1.types.ListDatabaseOperationsResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- class google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabasesAsyncPager(method: Callable[[...], Awaitable[google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabasesResponse]], request: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabasesRequest, response: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabasesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_databases
requests.This class thinly wraps an initial
google.cloud.spanner_admin_database_v1.types.ListDatabasesResponse
object, and provides an__aiter__
method to iterate through itsdatabases
field.If there are more pages, the
__aiter__
method will make additionalListDatabases
requests and continue to iterate through thedatabases
field on the corresponding responses.All the usual
google.cloud.spanner_admin_database_v1.types.ListDatabasesResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.spanner_admin_database_v1.types.ListDatabasesRequest) – The initial request object.
response (google.cloud.spanner_admin_database_v1.types.ListDatabasesResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- class google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabasesPager(method: Callable[[...], google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabasesResponse], request: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabasesRequest, response: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabasesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_databases
requests.This class thinly wraps an initial
google.cloud.spanner_admin_database_v1.types.ListDatabasesResponse
object, and provides an__iter__
method to iterate through itsdatabases
field.If there are more pages, the
__iter__
method will make additionalListDatabases
requests and continue to iterate through thedatabases
field on the corresponding responses.All the usual
google.cloud.spanner_admin_database_v1.types.ListDatabasesResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.spanner_admin_database_v1.types.ListDatabasesRequest) – The initial request object.
response (google.cloud.spanner_admin_database_v1.types.ListDatabasesResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.