Package Methods (3.46.0)

Summary of entries of Methods for spanner.

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient

DatabaseAdminAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.spanner_admin_database_v1.services.database_admin.transports.base.DatabaseAdminTransport, typing.Callable[[...], google.cloud.spanner_admin_database_v1.services.database_admin.transports.base.DatabaseAdminTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the database admin async client.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.backup_path

backup_path(project: str, instance: str, backup: str) -> str

Returns a fully-qualified backup string.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.backup_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.cancel_operation

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.common_billing_account_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.common_folder_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.common_location_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.common_organization_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.common_project_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.copy_backup

copy_backup(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.backup.CopyBackupRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    backup_id: typing.Optional[str] = None,
    source_backup: typing.Optional[str] = None,
    expire_time: typing.Optional[google.protobuf.timestamp_pb2.Timestamp] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Starts copying a Cloud Spanner Backup.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.copy_backup

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.create_backup

create_backup(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.backup.CreateBackupRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    backup: typing.Optional[
        google.cloud.spanner_admin_database_v1.types.backup.Backup
    ] = None,
    backup_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Starts creating a new Cloud Spanner Backup.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.create_backup

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.create_database

create_database(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.spanner_database_admin.CreateDatabaseRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    create_statement: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Creates a new Cloud Spanner database and starts to prepare it for serving.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.create_database

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.crypto_key_path

crypto_key_path(project: str, location: str, key_ring: str, crypto_key: str) -> str

Returns a fully-qualified crypto_key string.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.crypto_key_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.crypto_key_version_path

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.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.crypto_key_version_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.database_path

database_path(project: str, instance: str, database: str) -> str

Returns a fully-qualified database string.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.database_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.database_role_path

database_role_path(project: str, instance: str, database: str, role: str) -> str

Returns a fully-qualified database_role string.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.database_role_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.delete_backup

delete_backup(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.backup.DeleteBackupRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

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

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.delete_backup

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.delete_operation

delete_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.DeleteOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a long-running operation.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.delete_operation

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.drop_database

drop_database(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.spanner_database_admin.DropDatabaseRequest,
            dict,
        ]
    ] = None,
    *,
    database: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Drops (aka deletes) a Cloud Spanner database.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.drop_database

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

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

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.from_service_account_file

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

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

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.from_service_account_info

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

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

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.from_service_account_json

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_backup

get_backup(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.backup.GetBackupRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_admin_database_v1.types.backup.Backup

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

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_backup

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_database

get_database(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.spanner_database_admin.GetDatabaseRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_admin_database_v1.types.spanner_database_admin.Database

Gets the state of a Cloud Spanner database.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_database

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_database_ddl

get_database_ddl(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.spanner_database_admin.GetDatabaseDdlRequest,
            dict,
        ]
    ] = None,
    *,
    database: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.spanner_admin_database_v1.types.spanner_database_admin.GetDatabaseDdlResponse
)

Returns the schema of a Cloud Spanner database as a list of formatted DDL statements.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_database_ddl

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_iam_policy

get_iam_policy(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy

Gets the access control policy for a database or backup resource.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_iam_policy

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

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

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_operation

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.spanner_admin_database_v1.services.database_admin.transports.base.DatabaseAdminTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_transport_class

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.instance_path

instance_path(project: str, instance: str) -> str

Returns a fully-qualified instance string.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.instance_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.list_backup_operations

list_backup_operations(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.backup.ListBackupOperationsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupOperationsAsyncPager
)

Lists the backup [long-running operations][google.longrunning.Operation] in the given instance.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.list_backup_operations

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.list_backups

list_backups(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.backup.ListBackupsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupsAsyncPager
)

Lists completed and pending backups.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.list_backups

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.list_database_operations

list_database_operations(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseOperationsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseOperationsAsyncPager
)

Lists database longrunning-operations][google.longrunning.Operation].

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.list_database_operations

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.list_database_roles

list_database_roles(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseRolesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseRolesAsyncPager
)

Lists Cloud Spanner database roles.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.list_database_roles

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.list_databases

list_databases(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabasesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabasesAsyncPager
)

Lists Cloud Spanner databases.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.list_databases

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.list_operations

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_backup_path

parse_backup_path(path: str) -> typing.Dict[str, str]

Parses a backup path into its component segments.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_backup_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_common_billing_account_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_common_folder_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_common_location_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_common_organization_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_common_project_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_crypto_key_path

parse_crypto_key_path(path: str) -> typing.Dict[str, str]

Parses a crypto_key path into its component segments.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_crypto_key_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_crypto_key_version_path

parse_crypto_key_version_path(path: str) -> typing.Dict[str, str]

Parses a crypto_key_version path into its component segments.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_crypto_key_version_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_database_path

parse_database_path(path: str) -> typing.Dict[str, str]

Parses a database path into its component segments.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_database_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_database_role_path

parse_database_role_path(path: str) -> typing.Dict[str, str]

Parses a database_role path into its component segments.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_database_role_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_instance_path

parse_instance_path(path: str) -> typing.Dict[str, str]

Parses a instance path into its component segments.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_instance_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.restore_database

restore_database(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.spanner_database_admin.RestoreDatabaseRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    database_id: typing.Optional[str] = None,
    backup: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Create a new database by restoring from a completed backup.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.restore_database

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.set_iam_policy

set_iam_policy(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy

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

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.set_iam_policy

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.test_iam_permissions

test_iam_permissions(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    permissions: typing.Optional[typing.MutableSequence[str]] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

Returns permissions that the caller has on the specified database or backup resource.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.test_iam_permissions

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.update_backup

update_backup(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.backup.UpdateBackupRequest,
            dict,
        ]
    ] = None,
    *,
    backup: typing.Optional[
        google.cloud.spanner_admin_database_v1.types.backup.Backup
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_admin_database_v1.types.backup.Backup

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

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.update_backup

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.update_database

update_database(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.spanner_database_admin.UpdateDatabaseRequest,
            dict,
        ]
    ] = None,
    *,
    database: typing.Optional[
        google.cloud.spanner_admin_database_v1.types.spanner_database_admin.Database
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Updates a Cloud Spanner database.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.update_database

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.update_database_ddl

update_database_ddl(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.spanner_database_admin.UpdateDatabaseDdlRequest,
            dict,
        ]
    ] = None,
    *,
    database: typing.Optional[str] = None,
    statements: typing.Optional[typing.MutableSequence[str]] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.update_database_ddl

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient

DatabaseAdminClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.spanner_admin_database_v1.services.database_admin.transports.base.DatabaseAdminTransport, typing.Callable[[...], google.cloud.spanner_admin_database_v1.services.database_admin.transports.base.DatabaseAdminTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the database admin client.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.exit

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.exit

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.backup_path

backup_path(project: str, instance: str, backup: str) -> str

Returns a fully-qualified backup string.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.backup_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.cancel_operation

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.common_billing_account_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.common_folder_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.common_location_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.common_organization_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.common_project_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.copy_backup

copy_backup(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.backup.CopyBackupRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    backup_id: typing.Optional[str] = None,
    source_backup: typing.Optional[str] = None,
    expire_time: typing.Optional[google.protobuf.timestamp_pb2.Timestamp] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Starts copying a Cloud Spanner Backup.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.copy_backup

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.create_backup

create_backup(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.backup.CreateBackupRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    backup: typing.Optional[
        google.cloud.spanner_admin_database_v1.types.backup.Backup
    ] = None,
    backup_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Starts creating a new Cloud Spanner Backup.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.create_backup

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.create_database

create_database(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.spanner_database_admin.CreateDatabaseRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    create_statement: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Creates a new Cloud Spanner database and starts to prepare it for serving.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.create_database

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.crypto_key_path

crypto_key_path(project: str, location: str, key_ring: str, crypto_key: str) -> str

Returns a fully-qualified crypto_key string.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.crypto_key_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.crypto_key_version_path

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.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.crypto_key_version_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.database_path

database_path(project: str, instance: str, database: str) -> str

Returns a fully-qualified database string.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.database_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.database_role_path

database_role_path(project: str, instance: str, database: str, role: str) -> str

Returns a fully-qualified database_role string.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.database_role_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.delete_backup

delete_backup(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.backup.DeleteBackupRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

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

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.delete_backup

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.delete_operation

delete_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.DeleteOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a long-running operation.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.delete_operation

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.drop_database

drop_database(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.spanner_database_admin.DropDatabaseRequest,
            dict,
        ]
    ] = None,
    *,
    database: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Drops (aka deletes) a Cloud Spanner database.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.drop_database

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

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

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.from_service_account_file

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

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

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.from_service_account_info

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

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

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.from_service_account_json

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_backup

get_backup(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.backup.GetBackupRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_admin_database_v1.types.backup.Backup

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

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_backup

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_database

get_database(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.spanner_database_admin.GetDatabaseRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_admin_database_v1.types.spanner_database_admin.Database

Gets the state of a Cloud Spanner database.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_database

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_database_ddl

get_database_ddl(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.spanner_database_admin.GetDatabaseDdlRequest,
            dict,
        ]
    ] = None,
    *,
    database: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.spanner_admin_database_v1.types.spanner_database_admin.GetDatabaseDdlResponse
)

Returns the schema of a Cloud Spanner database as a list of formatted DDL statements.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_database_ddl

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_iam_policy

get_iam_policy(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy

Gets the access control policy for a database or backup resource.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_iam_policy

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_mtls_endpoint_and_cert_source

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_operation

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.instance_path

instance_path(project: str, instance: str) -> str

Returns a fully-qualified instance string.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.instance_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.list_backup_operations

list_backup_operations(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.backup.ListBackupOperationsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupOperationsPager
)

Lists the backup [long-running operations][google.longrunning.Operation] in the given instance.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.list_backup_operations

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.list_backups

list_backups(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.backup.ListBackupsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupsPager
)

Lists completed and pending backups.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.list_backups

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.list_database_operations

list_database_operations(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseOperationsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseOperationsPager
)

Lists database longrunning-operations][google.longrunning.Operation].

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.list_database_operations

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.list_database_roles

list_database_roles(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseRolesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseRolesPager
)

Lists Cloud Spanner database roles.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.list_database_roles

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.list_databases

list_databases(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabasesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabasesPager
)

Lists Cloud Spanner databases.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.list_databases

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.list_operations

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_backup_path

parse_backup_path(path: str) -> typing.Dict[str, str]

Parses a backup path into its component segments.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_backup_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_common_billing_account_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_common_folder_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_common_location_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_common_organization_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_common_project_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_crypto_key_path

parse_crypto_key_path(path: str) -> typing.Dict[str, str]

Parses a crypto_key path into its component segments.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_crypto_key_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_crypto_key_version_path

parse_crypto_key_version_path(path: str) -> typing.Dict[str, str]

Parses a crypto_key_version path into its component segments.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_crypto_key_version_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_database_path

parse_database_path(path: str) -> typing.Dict[str, str]

Parses a database path into its component segments.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_database_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_database_role_path

parse_database_role_path(path: str) -> typing.Dict[str, str]

Parses a database_role path into its component segments.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_database_role_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_instance_path

parse_instance_path(path: str) -> typing.Dict[str, str]

Parses a instance path into its component segments.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.parse_instance_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.restore_database

restore_database(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.spanner_database_admin.RestoreDatabaseRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    database_id: typing.Optional[str] = None,
    backup: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Create a new database by restoring from a completed backup.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.restore_database

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.set_iam_policy

set_iam_policy(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy

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

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.set_iam_policy

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.test_iam_permissions

test_iam_permissions(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    permissions: typing.Optional[typing.MutableSequence[str]] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

Returns permissions that the caller has on the specified database or backup resource.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.test_iam_permissions

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.update_backup

update_backup(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.backup.UpdateBackupRequest,
            dict,
        ]
    ] = None,
    *,
    backup: typing.Optional[
        google.cloud.spanner_admin_database_v1.types.backup.Backup
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_admin_database_v1.types.backup.Backup

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

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.update_backup

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.update_database

update_database(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.spanner_database_admin.UpdateDatabaseRequest,
            dict,
        ]
    ] = None,
    *,
    database: typing.Optional[
        google.cloud.spanner_admin_database_v1.types.spanner_database_admin.Database
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Updates a Cloud Spanner database.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.update_database

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.update_database_ddl

update_database_ddl(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_database_v1.types.spanner_database_admin.UpdateDatabaseDdlRequest,
            dict,
        ]
    ] = None,
    *,
    database: typing.Optional[str] = None,
    statements: typing.Optional[typing.MutableSequence[str]] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.update_database_ddl

google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupOperationsAsyncPager

ListBackupOperationsAsyncPager(
    method: typing.Callable[
        [...],
        typing.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: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupOperationsAsyncPager

google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupOperationsPager

ListBackupOperationsPager(
    method: typing.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: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupOperationsPager

google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupsAsyncPager

ListBackupsAsyncPager(
    method: typing.Callable[
        [...],
        typing.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: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupsAsyncPager

google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupsPager

ListBackupsPager(
    method: typing.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: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListBackupsPager

google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseOperationsAsyncPager

ListDatabaseOperationsAsyncPager(
    method: typing.Callable[
        [...],
        typing.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: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseOperationsAsyncPager

google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseOperationsPager

ListDatabaseOperationsPager(
    method: typing.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: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseOperationsPager

google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseRolesAsyncPager

ListDatabaseRolesAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseRolesResponse
        ],
    ],
    request: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseRolesRequest,
    response: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseRolesResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseRolesAsyncPager

google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseRolesPager

ListDatabaseRolesPager(
    method: typing.Callable[
        [...],
        google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseRolesResponse,
    ],
    request: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseRolesRequest,
    response: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabaseRolesResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabaseRolesPager

google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabasesAsyncPager

ListDatabasesAsyncPager(
    method: typing.Callable[
        [...],
        typing.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: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabasesAsyncPager

google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabasesPager

ListDatabasesPager(
    method: typing.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: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.spanner_admin_database_v1.services.database_admin.pagers.ListDatabasesPager

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient

InstanceAdminAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.spanner_admin_instance_v1.services.instance_admin.transports.base.InstanceAdminTransport, typing.Callable[[...], google.cloud.spanner_admin_instance_v1.services.instance_admin.transports.base.InstanceAdminTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the instance admin async client.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.common_billing_account_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.common_folder_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.common_location_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.common_organization_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.common_project_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.create_instance

create_instance(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.CreateInstanceRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    instance_id: typing.Optional[str] = None,
    instance: typing.Optional[
        google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.Instance
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Creates an instance and begins preparing it to begin serving.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.create_instance

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.create_instance_config

create_instance_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.CreateInstanceConfigRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    instance_config: typing.Optional[
        google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.InstanceConfig
    ] = None,
    instance_config_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Creates an instance config and begins preparing it to be used.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.create_instance_config

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.create_instance_partition

create_instance_partition(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.CreateInstancePartitionRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    instance_partition: typing.Optional[
        google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.InstancePartition
    ] = None,
    instance_partition_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Creates an instance partition and begins preparing it to be used.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.create_instance_partition

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.delete_instance

delete_instance(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.DeleteInstanceRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes an instance.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.delete_instance

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.delete_instance_config

delete_instance_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.DeleteInstanceConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes the instance config.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.delete_instance_config

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.delete_instance_partition

delete_instance_partition(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.DeleteInstancePartitionRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes an existing instance partition.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.delete_instance_partition

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

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

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.from_service_account_file

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

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

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.from_service_account_info

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

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

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.from_service_account_json

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.get_iam_policy

get_iam_policy(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy

Gets the access control policy for an instance resource.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.get_iam_policy

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.get_instance

get_instance(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.GetInstanceRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.Instance

Gets information about a particular instance.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.get_instance

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.get_instance_config

get_instance_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.GetInstanceConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.InstanceConfig

Gets information about a particular instance configuration.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.get_instance_config

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.get_instance_partition

get_instance_partition(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.GetInstancePartitionRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.InstancePartition
)

Gets information about a particular instance partition.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.get_instance_partition

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

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

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.spanner_admin_instance_v1.services.instance_admin.transports.base.InstanceAdminTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.get_transport_class

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.instance_config_path

instance_config_path(project: str, instance_config: str) -> str

Returns a fully-qualified instance_config string.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.instance_config_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.instance_partition_path

instance_partition_path(
    project: str, instance: str, instance_partition: str
) -> str

Returns a fully-qualified instance_partition string.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.instance_partition_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.instance_path

instance_path(project: str, instance: str) -> str

Returns a fully-qualified instance string.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.instance_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.list_instance_config_operations

list_instance_config_operations(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigOperationsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstanceConfigOperationsAsyncPager
)

Lists the user-managed instance config [long-running operations][google.longrunning.Operation] in the given project.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.list_instance_config_operations

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.list_instance_configs

list_instance_configs(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstanceConfigsAsyncPager
)

Lists the supported instance configurations for a given project.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.list_instance_configs

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.list_instance_partition_operations

list_instance_partition_operations(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancePartitionOperationsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancePartitionOperationsAsyncPager
)

Lists instance partition [long-running operations][google.longrunning.Operation] in the given instance.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.list_instance_partition_operations

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.list_instance_partitions

list_instance_partitions(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancePartitionsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancePartitionsAsyncPager
)

Lists all instance partitions for the given instance.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.list_instance_partitions

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.list_instances

list_instances(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancesAsyncPager
)

Lists all instances in the given project.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.list_instances

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.parse_common_billing_account_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.parse_common_folder_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.parse_common_location_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.parse_common_organization_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.parse_common_project_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.parse_instance_config_path

parse_instance_config_path(path: str) -> typing.Dict[str, str]

Parses a instance_config path into its component segments.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.parse_instance_config_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.parse_instance_partition_path

parse_instance_partition_path(path: str) -> typing.Dict[str, str]

Parses a instance_partition path into its component segments.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.parse_instance_partition_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.parse_instance_path

parse_instance_path(path: str) -> typing.Dict[str, str]

Parses a instance path into its component segments.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.parse_instance_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.set_iam_policy

set_iam_policy(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy

Sets the access control policy on an instance resource.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.set_iam_policy

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.test_iam_permissions

test_iam_permissions(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    permissions: typing.Optional[typing.MutableSequence[str]] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

Returns permissions that the caller has on the specified instance resource.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.test_iam_permissions

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.update_instance

update_instance(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.UpdateInstanceRequest,
            dict,
        ]
    ] = None,
    *,
    instance: typing.Optional[
        google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.Instance
    ] = None,
    field_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Updates an instance, and begins allocating or releasing resources as requested.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.update_instance

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.update_instance_config

update_instance_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.UpdateInstanceConfigRequest,
            dict,
        ]
    ] = None,
    *,
    instance_config: typing.Optional[
        google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.InstanceConfig
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Updates an instance config.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.update_instance_config

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.update_instance_partition

update_instance_partition(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.UpdateInstancePartitionRequest,
            dict,
        ]
    ] = None,
    *,
    instance_partition: typing.Optional[
        google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.InstancePartition
    ] = None,
    field_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Updates an instance partition, and begins allocating or releasing resources as requested.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminAsyncClient.update_instance_partition

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient

InstanceAdminClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.spanner_admin_instance_v1.services.instance_admin.transports.base.InstanceAdminTransport, typing.Callable[[...], google.cloud.spanner_admin_instance_v1.services.instance_admin.transports.base.InstanceAdminTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the instance admin client.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.exit

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.exit

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.common_billing_account_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.common_folder_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.common_location_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.common_organization_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.common_project_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.create_instance

create_instance(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.CreateInstanceRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    instance_id: typing.Optional[str] = None,
    instance: typing.Optional[
        google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.Instance
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Creates an instance and begins preparing it to begin serving.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.create_instance

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.create_instance_config

create_instance_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.CreateInstanceConfigRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    instance_config: typing.Optional[
        google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.InstanceConfig
    ] = None,
    instance_config_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Creates an instance config and begins preparing it to be used.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.create_instance_config

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.create_instance_partition

create_instance_partition(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.CreateInstancePartitionRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    instance_partition: typing.Optional[
        google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.InstancePartition
    ] = None,
    instance_partition_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Creates an instance partition and begins preparing it to be used.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.create_instance_partition

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.delete_instance

delete_instance(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.DeleteInstanceRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes an instance.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.delete_instance

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.delete_instance_config

delete_instance_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.DeleteInstanceConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes the instance config.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.delete_instance_config

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.delete_instance_partition

delete_instance_partition(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.DeleteInstancePartitionRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes an existing instance partition.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.delete_instance_partition

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

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

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.from_service_account_file

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

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

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.from_service_account_info

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

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

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.from_service_account_json

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.get_iam_policy

get_iam_policy(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy

Gets the access control policy for an instance resource.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.get_iam_policy

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.get_instance

get_instance(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.GetInstanceRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.Instance

Gets information about a particular instance.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.get_instance

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.get_instance_config

get_instance_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.GetInstanceConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.InstanceConfig

Gets information about a particular instance configuration.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.get_instance_config

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.get_instance_partition

get_instance_partition(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.GetInstancePartitionRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.InstancePartition
)

Gets information about a particular instance partition.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.get_instance_partition

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.get_mtls_endpoint_and_cert_source

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.instance_config_path

instance_config_path(project: str, instance_config: str) -> str

Returns a fully-qualified instance_config string.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.instance_config_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.instance_partition_path

instance_partition_path(
    project: str, instance: str, instance_partition: str
) -> str

Returns a fully-qualified instance_partition string.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.instance_partition_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.instance_path

instance_path(project: str, instance: str) -> str

Returns a fully-qualified instance string.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.instance_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.list_instance_config_operations

list_instance_config_operations(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigOperationsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstanceConfigOperationsPager
)

Lists the user-managed instance config [long-running operations][google.longrunning.Operation] in the given project.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.list_instance_config_operations

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.list_instance_configs

list_instance_configs(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstanceConfigsPager
)

Lists the supported instance configurations for a given project.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.list_instance_configs

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.list_instance_partition_operations

list_instance_partition_operations(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancePartitionOperationsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancePartitionOperationsPager
)

Lists instance partition [long-running operations][google.longrunning.Operation] in the given instance.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.list_instance_partition_operations

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.list_instance_partitions

list_instance_partitions(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancePartitionsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancePartitionsPager
)

Lists all instance partitions for the given instance.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.list_instance_partitions

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.list_instances

list_instances(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancesPager
)

Lists all instances in the given project.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.list_instances

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.parse_common_billing_account_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.parse_common_folder_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.parse_common_location_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.parse_common_organization_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.parse_common_project_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.parse_instance_config_path

parse_instance_config_path(path: str) -> typing.Dict[str, str]

Parses a instance_config path into its component segments.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.parse_instance_config_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.parse_instance_partition_path

parse_instance_partition_path(path: str) -> typing.Dict[str, str]

Parses a instance_partition path into its component segments.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.parse_instance_partition_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.parse_instance_path

parse_instance_path(path: str) -> typing.Dict[str, str]

Parses a instance path into its component segments.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.parse_instance_path

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.set_iam_policy

set_iam_policy(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy

Sets the access control policy on an instance resource.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.set_iam_policy

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.test_iam_permissions

test_iam_permissions(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]
    ] = None,
    *,
    resource: typing.Optional[str] = None,
    permissions: typing.Optional[typing.MutableSequence[str]] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

Returns permissions that the caller has on the specified instance resource.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.test_iam_permissions

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.update_instance

update_instance(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.UpdateInstanceRequest,
            dict,
        ]
    ] = None,
    *,
    instance: typing.Optional[
        google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.Instance
    ] = None,
    field_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Updates an instance, and begins allocating or releasing resources as requested.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.update_instance

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.update_instance_config

update_instance_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.UpdateInstanceConfigRequest,
            dict,
        ]
    ] = None,
    *,
    instance_config: typing.Optional[
        google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.InstanceConfig
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Updates an instance config.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.update_instance_config

google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.update_instance_partition

update_instance_partition(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.UpdateInstancePartitionRequest,
            dict,
        ]
    ] = None,
    *,
    instance_partition: typing.Optional[
        google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.InstancePartition
    ] = None,
    field_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Updates an instance partition, and begins allocating or releasing resources as requested.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.InstanceAdminClient.update_instance_partition

google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstanceConfigOperationsAsyncPager

ListInstanceConfigOperationsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigOperationsResponse
        ],
    ],
    request: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigOperationsRequest,
    response: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigOperationsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstanceConfigOperationsAsyncPager

google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstanceConfigOperationsPager

ListInstanceConfigOperationsPager(
    method: typing.Callable[
        [...],
        google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigOperationsResponse,
    ],
    request: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigOperationsRequest,
    response: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigOperationsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstanceConfigOperationsPager

google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstanceConfigsAsyncPager

ListInstanceConfigsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigsResponse
        ],
    ],
    request: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigsRequest,
    response: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstanceConfigsAsyncPager

google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstanceConfigsPager

ListInstanceConfigsPager(
    method: typing.Callable[
        [...],
        google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigsResponse,
    ],
    request: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigsRequest,
    response: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstanceConfigsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstanceConfigsPager

google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancePartitionOperationsAsyncPager

ListInstancePartitionOperationsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancePartitionOperationsResponse
        ],
    ],
    request: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancePartitionOperationsRequest,
    response: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancePartitionOperationsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancePartitionOperationsAsyncPager

google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancePartitionOperationsPager

ListInstancePartitionOperationsPager(
    method: typing.Callable[
        [...],
        google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancePartitionOperationsResponse,
    ],
    request: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancePartitionOperationsRequest,
    response: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancePartitionOperationsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancePartitionOperationsPager

google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancePartitionsAsyncPager

ListInstancePartitionsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancePartitionsResponse
        ],
    ],
    request: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancePartitionsRequest,
    response: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancePartitionsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancePartitionsAsyncPager

google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancePartitionsPager

ListInstancePartitionsPager(
    method: typing.Callable[
        [...],
        google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancePartitionsResponse,
    ],
    request: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancePartitionsRequest,
    response: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancePartitionsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancePartitionsPager

google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancesAsyncPager

ListInstancesAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancesResponse
        ],
    ],
    request: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancesRequest,
    response: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancesResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancesAsyncPager

google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancesPager

ListInstancesPager(
    method: typing.Callable[
        [...],
        google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancesResponse,
    ],
    request: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancesRequest,
    response: google.cloud.spanner_admin_instance_v1.types.spanner_instance_admin.ListInstancesResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.spanner_admin_instance_v1.services.instance_admin.pagers.ListInstancesPager

google.cloud.spanner_v1.batch.Batch.enter

__enter__()

Begin with block.

See more: google.cloud.spanner_v1.batch.Batch.enter

google.cloud.spanner_v1.batch.Batch.exit

__exit__(exc_type, exc_val, exc_tb)

End with block.

See more: google.cloud.spanner_v1.batch.Batch.exit

google.cloud.spanner_v1.batch.Batch.commit

commit(return_commit_stats=False, request_options=None, max_commit_delay=None)

Commit mutations to the database.

See more: google.cloud.spanner_v1.batch.Batch.commit

google.cloud.spanner_v1.batch.MutationGroups.batch_write

batch_write(request_options=None)

Executes batch_write.

See more: google.cloud.spanner_v1.batch.MutationGroups.batch_write

google.cloud.spanner_v1.batch.MutationGroups.group

group()

Returns a new MutationGroup to which mutations can be added.

See more: google.cloud.spanner_v1.batch.MutationGroups.group

google.cloud.spanner_v1.client.Client.copy

copy()

Make a copy of this client.

See more: google.cloud.spanner_v1.client.Client.copy

google.cloud.spanner_v1.client.Client.instance

instance(
    instance_id,
    configuration_name=None,
    display_name=None,
    node_count=None,
    labels=None,
    processing_units=None,
)

Factory to create a instance associated with this client.

See more: google.cloud.spanner_v1.client.Client.instance

google.cloud.spanner_v1.client.Client.list_instance_configs

list_instance_configs(page_size=None)

List available instance configurations for the client's project.

See more: google.cloud.spanner_v1.client.Client.list_instance_configs

google.cloud.spanner_v1.client.Client.list_instances

list_instances(filter_="", page_size=None)

List instances for the client's project.

See more: google.cloud.spanner_v1.client.Client.list_instances

google.cloud.spanner_v1.database.BatchCheckout.enter

__enter__()

Begin with block.

See more: google.cloud.spanner_v1.database.BatchCheckout.enter

google.cloud.spanner_v1.database.BatchCheckout.exit

__exit__(exc_type, exc_val, exc_tb)

End with block.

See more: google.cloud.spanner_v1.database.BatchCheckout.exit

google.cloud.spanner_v1.database.BatchSnapshot.close

close()

Clean up underlying session.

See more: google.cloud.spanner_v1.database.BatchSnapshot.close

google.cloud.spanner_v1.database.BatchSnapshot.execute_sql

execute_sql(*args, **kw)

Convenience method: perform query operation via snapshot.

See more: google.cloud.spanner_v1.database.BatchSnapshot.execute_sql

google.cloud.spanner_v1.database.BatchSnapshot.from_dict

from_dict(database, mapping)

Reconstruct an instance from a mapping.

See more: google.cloud.spanner_v1.database.BatchSnapshot.from_dict

google.cloud.spanner_v1.database.BatchSnapshot.generate_query_batches

generate_query_batches(
    sql,
    params=None,
    param_types=None,
    partition_size_bytes=None,
    max_partitions=None,
    query_options=None,
    data_boost_enabled=False,
    directed_read_options=None,
    *,
    retry=_MethodDefault._DEFAULT_VALUE,
    timeout=_MethodDefault._DEFAULT_VALUE
)

Start a partitioned query operation.

See more: google.cloud.spanner_v1.database.BatchSnapshot.generate_query_batches

google.cloud.spanner_v1.database.BatchSnapshot.generate_read_batches

generate_read_batches(
    table,
    columns,
    keyset,
    index="",
    partition_size_bytes=None,
    max_partitions=None,
    data_boost_enabled=False,
    directed_read_options=None,
    *,
    retry=_MethodDefault._DEFAULT_VALUE,
    timeout=_MethodDefault._DEFAULT_VALUE
)

Start a partitioned batch read operation.

See more: google.cloud.spanner_v1.database.BatchSnapshot.generate_read_batches

google.cloud.spanner_v1.database.BatchSnapshot.process

process(batch)

Process a single, partitioned query or read.

See more: google.cloud.spanner_v1.database.BatchSnapshot.process

google.cloud.spanner_v1.database.BatchSnapshot.process_query_batch

process_query_batch(
    batch, *, retry=_MethodDefault._DEFAULT_VALUE, timeout=_MethodDefault._DEFAULT_VALUE
)

Process a single, partitioned query.

See more: google.cloud.spanner_v1.database.BatchSnapshot.process_query_batch

google.cloud.spanner_v1.database.BatchSnapshot.process_read_batch

process_read_batch(
    batch, *, retry=_MethodDefault._DEFAULT_VALUE, timeout=_MethodDefault._DEFAULT_VALUE
)

Process a single, partitioned read.

See more: google.cloud.spanner_v1.database.BatchSnapshot.process_read_batch

google.cloud.spanner_v1.database.BatchSnapshot.read

read(*args, **kw)

Convenience method: perform read operation via snapshot.

See more: google.cloud.spanner_v1.database.BatchSnapshot.read

google.cloud.spanner_v1.database.BatchSnapshot.run_partitioned_query

run_partitioned_query(
    sql,
    params=None,
    param_types=None,
    partition_size_bytes=None,
    max_partitions=None,
    query_options=None,
    data_boost_enabled=False,
)

Start a partitioned query operation to get list of partitions and then executes each partition on a separate thread .

See more: google.cloud.spanner_v1.database.BatchSnapshot.run_partitioned_query

google.cloud.spanner_v1.database.BatchSnapshot.to_dict

to_dict()

Return state as a dictionary.

See more: google.cloud.spanner_v1.database.BatchSnapshot.to_dict

google.cloud.spanner_v1.database.Database.batch

batch(request_options=None, max_commit_delay=None)

Return an object which wraps a batch.

See more: google.cloud.spanner_v1.database.Database.batch

google.cloud.spanner_v1.database.Database.batch_snapshot

batch_snapshot(
    read_timestamp=None, exact_staleness=None, session_id=None, transaction_id=None
)

Return an object which wraps a batch read / query.

See more: google.cloud.spanner_v1.database.Database.batch_snapshot

google.cloud.spanner_v1.database.Database.create

create()

Create this database within its instance.

See more: google.cloud.spanner_v1.database.Database.create

google.cloud.spanner_v1.database.Database.drop

drop()

Drop this database.

See more: google.cloud.spanner_v1.database.Database.drop

google.cloud.spanner_v1.database.Database.execute_partitioned_dml

execute_partitioned_dml(
    dml, params=None, param_types=None, query_options=None, request_options=None
)

Execute a partitionable DML statement.

See more: google.cloud.spanner_v1.database.Database.execute_partitioned_dml

google.cloud.spanner_v1.database.Database.exists

exists()

Test whether this database exists.

See more: google.cloud.spanner_v1.database.Database.exists

google.cloud.spanner_v1.database.Database.from_pb

from_pb(database_pb, instance, pool=None)

Creates an instance of this class from a protobuf.

See more: google.cloud.spanner_v1.database.Database.from_pb

google.cloud.spanner_v1.database.Database.get_iam_policy

get_iam_policy(policy_version=None)

Gets the access control policy for a database resource.

See more: google.cloud.spanner_v1.database.Database.get_iam_policy

google.cloud.spanner_v1.database.Database.is_optimized

is_optimized()

Test whether this database has finished optimizing.

See more: google.cloud.spanner_v1.database.Database.is_optimized

google.cloud.spanner_v1.database.Database.is_ready

is_ready()

Test whether this database is ready for use.

See more: google.cloud.spanner_v1.database.Database.is_ready

google.cloud.spanner_v1.database.Database.list_database_operations

list_database_operations(filter_="", page_size=None)

List database operations for the database.

See more: google.cloud.spanner_v1.database.Database.list_database_operations

google.cloud.spanner_v1.database.Database.list_database_roles

list_database_roles(page_size=None)

Lists Cloud Spanner database roles.

See more: google.cloud.spanner_v1.database.Database.list_database_roles

google.cloud.spanner_v1.database.Database.list_tables

list_tables(schema="_default")

List tables within the database.

See more: google.cloud.spanner_v1.database.Database.list_tables

google.cloud.spanner_v1.database.Database.mutation_groups

mutation_groups()

Return an object which wraps a mutation_group.

See more: google.cloud.spanner_v1.database.Database.mutation_groups

google.cloud.spanner_v1.database.Database.reload

reload()

Reload this database.

See more: google.cloud.spanner_v1.database.Database.reload

google.cloud.spanner_v1.database.Database.restore

restore(source)

Restore from a backup to this database.

See more: google.cloud.spanner_v1.database.Database.restore

google.cloud.spanner_v1.database.Database.run_in_transaction

run_in_transaction(func, *args, **kw)

Perform a unit of work in a transaction, retrying on abort.

See more: google.cloud.spanner_v1.database.Database.run_in_transaction

google.cloud.spanner_v1.database.Database.session

session(labels=None, database_role=None)

Factory to create a session for this database.

See more: google.cloud.spanner_v1.database.Database.session

google.cloud.spanner_v1.database.Database.set_iam_policy

set_iam_policy(policy)

Sets the access control policy on a database resource.

See more: google.cloud.spanner_v1.database.Database.set_iam_policy

google.cloud.spanner_v1.database.Database.snapshot

snapshot(**kw)

Return an object which wraps a snapshot.

See more: google.cloud.spanner_v1.database.Database.snapshot

google.cloud.spanner_v1.database.Database.table

table(table_id)

Factory to create a table object within this database.

See more: google.cloud.spanner_v1.database.Database.table

google.cloud.spanner_v1.database.Database.update

update(fields)

Update this database.

See more: google.cloud.spanner_v1.database.Database.update

google.cloud.spanner_v1.database.Database.update_ddl

update_ddl(ddl_statements, operation_id="")

Update DDL for this database.

See more: google.cloud.spanner_v1.database.Database.update_ddl

google.cloud.spanner_v1.database.MutationGroupsCheckout.enter

__enter__()

Begin with block.

See more: google.cloud.spanner_v1.database.MutationGroupsCheckout.enter

google.cloud.spanner_v1.database.MutationGroupsCheckout.exit

__exit__(exc_type, exc_val, exc_tb)

End with block.

See more: google.cloud.spanner_v1.database.MutationGroupsCheckout.exit

google.cloud.spanner_v1.database.SnapshotCheckout.enter

__enter__()

Begin with block.

See more: google.cloud.spanner_v1.database.SnapshotCheckout.enter

google.cloud.spanner_v1.database.SnapshotCheckout.exit

__exit__(exc_type, exc_val, exc_tb)

End with block.

See more: google.cloud.spanner_v1.database.SnapshotCheckout.exit

google.cloud.spanner_v1.instance.Instance.backup

backup(
    backup_id, database="", expire_time=None, version_time=None, encryption_config=None
)

Factory to create a backup within this instance.

See more: google.cloud.spanner_v1.instance.Instance.backup

google.cloud.spanner_v1.instance.Instance.copy

copy()

Make a copy of this instance.

See more: google.cloud.spanner_v1.instance.Instance.copy

google.cloud.spanner_v1.instance.Instance.copy_backup

copy_backup(backup_id, source_backup, expire_time=None, encryption_config=None)

Factory to create a copy backup within this instance.

See more: google.cloud.spanner_v1.instance.Instance.copy_backup

google.cloud.spanner_v1.instance.Instance.create

create()

Create this instance.

See more: google.cloud.spanner_v1.instance.Instance.create

google.cloud.spanner_v1.instance.Instance.database

database(
    database_id,
    ddl_statements=(),
    pool=None,
    logger=None,
    encryption_config=None,
    database_dialect=DatabaseDialect.DATABASE_DIALECT_UNSPECIFIED,
    database_role=None,
    enable_drop_protection=False,
    enable_interceptors_in_tests=False,
)

Factory to create a database within this instance.

See more: google.cloud.spanner_v1.instance.Instance.database

google.cloud.spanner_v1.instance.Instance.delete

delete()

Mark an instance and all of its databases for permanent deletion.

See more: google.cloud.spanner_v1.instance.Instance.delete

google.cloud.spanner_v1.instance.Instance.exists

exists()

Test whether this instance exists.

See more: google.cloud.spanner_v1.instance.Instance.exists

google.cloud.spanner_v1.instance.Instance.from_pb

from_pb(instance_pb, client)

Creates an instance from a protobuf.

See more: google.cloud.spanner_v1.instance.Instance.from_pb

google.cloud.spanner_v1.instance.Instance.list_backup_operations

list_backup_operations(filter_="", page_size=None)

List backup operations for the instance.

See more: google.cloud.spanner_v1.instance.Instance.list_backup_operations

google.cloud.spanner_v1.instance.Instance.list_backups

list_backups(filter_="", page_size=None)

List backups for the instance.

See more: google.cloud.spanner_v1.instance.Instance.list_backups

google.cloud.spanner_v1.instance.Instance.list_database_operations

list_database_operations(filter_="", page_size=None)

List database operations for the instance.

See more: google.cloud.spanner_v1.instance.Instance.list_database_operations

google.cloud.spanner_v1.instance.Instance.list_databases

list_databases(page_size=None)

List databases for the instance.

See more: google.cloud.spanner_v1.instance.Instance.list_databases

google.cloud.spanner_v1.instance.Instance.reload

reload()

Reload the metadata for this instance.

See more: google.cloud.spanner_v1.instance.Instance.reload

google.cloud.spanner_v1.instance.Instance.update

update()

Update this instance.

See more: google.cloud.spanner_v1.instance.Instance.update

google.cloud.spanner_v1.keyset.KeyRange.eq

__eq__(other)

Compare by serialized state.

See more: google.cloud.spanner_v1.keyset.KeyRange.eq

google.cloud.spanner_v1.keyset.KeySet.eq

__eq__(other)

Compare by serialized state.

See more: google.cloud.spanner_v1.keyset.KeySet.eq

google.cloud.spanner_v1.pool.AbstractSessionPool.bind

bind(database)

Associate the pool with a database.

See more: google.cloud.spanner_v1.pool.AbstractSessionPool.bind

google.cloud.spanner_v1.pool.AbstractSessionPool.clear

clear()

Delete all sessions in the pool.

See more: google.cloud.spanner_v1.pool.AbstractSessionPool.clear

google.cloud.spanner_v1.pool.AbstractSessionPool.get

get()

Check a session out from the pool.

See more: google.cloud.spanner_v1.pool.AbstractSessionPool.get

google.cloud.spanner_v1.pool.AbstractSessionPool.put

put(session)

Return a session to the pool.

See more: google.cloud.spanner_v1.pool.AbstractSessionPool.put

google.cloud.spanner_v1.pool.AbstractSessionPool.session

session(**kwargs)

Check out a session from the pool.

See more: google.cloud.spanner_v1.pool.AbstractSessionPool.session

google.cloud.spanner_v1.pool.BurstyPool.bind

bind(database)

Associate the pool with a database.

See more: google.cloud.spanner_v1.pool.BurstyPool.bind

google.cloud.spanner_v1.pool.BurstyPool.clear

clear()

Delete all sessions in the pool.

See more: google.cloud.spanner_v1.pool.BurstyPool.clear

google.cloud.spanner_v1.pool.BurstyPool.get

get()

Check a session out from the pool.

See more: google.cloud.spanner_v1.pool.BurstyPool.get

google.cloud.spanner_v1.pool.BurstyPool.put

put(session)

Return a session to the pool.

See more: google.cloud.spanner_v1.pool.BurstyPool.put

google.cloud.spanner_v1.pool.FixedSizePool.bind

bind(database)

Associate the pool with a database.

See more: google.cloud.spanner_v1.pool.FixedSizePool.bind

google.cloud.spanner_v1.pool.FixedSizePool.clear

clear()

Delete all sessions in the pool.

See more: google.cloud.spanner_v1.pool.FixedSizePool.clear

google.cloud.spanner_v1.pool.FixedSizePool.get

get(timeout=None)

Check a session out from the pool.

See more: google.cloud.spanner_v1.pool.FixedSizePool.get

google.cloud.spanner_v1.pool.FixedSizePool.put

put(session)

Return a session to the pool.

See more: google.cloud.spanner_v1.pool.FixedSizePool.put

google.cloud.spanner_v1.pool.PingingPool.bind

bind(database)

Associate the pool with a database.

See more: google.cloud.spanner_v1.pool.PingingPool.bind

google.cloud.spanner_v1.pool.PingingPool.clear

clear()

Delete all sessions in the pool.

See more: google.cloud.spanner_v1.pool.PingingPool.clear

google.cloud.spanner_v1.pool.PingingPool.get

get(timeout=None)

Check a session out from the pool.

See more: google.cloud.spanner_v1.pool.PingingPool.get

google.cloud.spanner_v1.pool.PingingPool.ping

ping()

Refresh maybe-expired sessions in the pool.

See more: google.cloud.spanner_v1.pool.PingingPool.ping

google.cloud.spanner_v1.pool.PingingPool.put

put(session)

Return a session to the pool.

See more: google.cloud.spanner_v1.pool.PingingPool.put

google.cloud.spanner_v1.pool.TransactionPingingPool

TransactionPingingPool(
    size=10, default_timeout=10, ping_interval=3000, labels=None, database_role=None
)

This throws a deprecation warning on initialization.

See more: google.cloud.spanner_v1.pool.TransactionPingingPool

google.cloud.spanner_v1.pool.TransactionPingingPool.begin_pending_transactions

begin_pending_transactions()

Begin all transactions for sessions added to the pool.

See more: google.cloud.spanner_v1.pool.TransactionPingingPool.begin_pending_transactions

google.cloud.spanner_v1.pool.TransactionPingingPool.bind

bind(database)

Associate the pool with a database.

See more: google.cloud.spanner_v1.pool.TransactionPingingPool.bind

google.cloud.spanner_v1.pool.TransactionPingingPool.put

put(session)

Return a session to the pool.

See more: google.cloud.spanner_v1.pool.TransactionPingingPool.put

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient

SpannerAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.spanner_v1.services.spanner.transports.base.SpannerTransport, typing.Callable[[...], google.cloud.spanner_v1.services.spanner.transports.base.SpannerTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the spanner async client.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.batch_create_sessions

batch_create_sessions(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_v1.types.spanner.BatchCreateSessionsRequest, dict
        ]
    ] = None,
    *,
    database: typing.Optional[str] = None,
    session_count: typing.Optional[int] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_v1.types.spanner.BatchCreateSessionsResponse

Creates multiple new sessions.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.batch_create_sessions

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.batch_write

batch_write(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.BatchWriteRequest, dict]
    ] = None,
    *,
    session: typing.Optional[str] = None,
    mutation_groups: typing.Optional[
        typing.MutableSequence[
            google.cloud.spanner_v1.types.spanner.BatchWriteRequest.MutationGroup
        ]
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Awaitable[
    typing.AsyncIterable[google.cloud.spanner_v1.types.spanner.BatchWriteResponse]
]

Batches the supplied mutation groups in a collection of efficient transactions.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.batch_write

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.begin_transaction

begin_transaction(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_v1.types.spanner.BeginTransactionRequest, dict
        ]
    ] = None,
    *,
    session: typing.Optional[str] = None,
    options: typing.Optional[
        google.cloud.spanner_v1.types.transaction.TransactionOptions
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_v1.types.transaction.Transaction

Begins a new transaction.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.begin_transaction

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.commit

commit(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.CommitRequest, dict]
    ] = None,
    *,
    session: typing.Optional[str] = None,
    transaction_id: typing.Optional[bytes] = None,
    mutations: typing.Optional[
        typing.MutableSequence[google.cloud.spanner_v1.types.mutation.Mutation]
    ] = None,
    single_use_transaction: typing.Optional[
        google.cloud.spanner_v1.types.transaction.TransactionOptions
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_v1.types.commit_response.CommitResponse

Commits a transaction.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.commit

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.common_billing_account_path

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.common_folder_path

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.common_location_path

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.common_organization_path

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.common_project_path

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.create_session

create_session(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.CreateSessionRequest, dict]
    ] = None,
    *,
    database: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_v1.types.spanner.Session

Creates a new session.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.create_session

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.database_path

database_path(project: str, instance: str, database: str) -> str

Returns a fully-qualified database string.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.database_path

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.delete_session

delete_session(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.DeleteSessionRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Ends a session, releasing server resources associated with it.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.delete_session

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.execute_batch_dml

execute_batch_dml(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.ExecuteBatchDmlRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_v1.types.spanner.ExecuteBatchDmlResponse

Executes a batch of SQL DML statements.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.execute_batch_dml

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.execute_sql

execute_sql(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.ExecuteSqlRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_v1.types.result_set.ResultSet

Executes an SQL statement, returning all results in a single reply.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.execute_sql

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.execute_streaming_sql

execute_streaming_sql(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.ExecuteSqlRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Awaitable[
    typing.AsyncIterable[google.cloud.spanner_v1.types.result_set.PartialResultSet]
]

Like ExecuteSql][google.spanner.v1.Spanner.ExecuteSql], except returns the result set as a stream.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.execute_streaming_sql

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

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

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.from_service_account_file

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

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

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.from_service_account_info

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

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

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.from_service_account_json

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

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

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.get_session

get_session(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.GetSessionRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_v1.types.spanner.Session

Gets a session.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.get_session

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.spanner_v1.services.spanner.transports.base.SpannerTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.get_transport_class

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.list_sessions

list_sessions(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.ListSessionsRequest, dict]
    ] = None,
    *,
    database: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_v1.services.spanner.pagers.ListSessionsAsyncPager

Lists all sessions in a given database.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.list_sessions

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.parse_common_billing_account_path

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.parse_common_folder_path

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.parse_common_location_path

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.parse_common_organization_path

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.parse_common_project_path

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.parse_database_path

parse_database_path(path: str) -> typing.Dict[str, str]

Parses a database path into its component segments.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.parse_database_path

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.parse_session_path

parse_session_path(path: str) -> typing.Dict[str, str]

Parses a session path into its component segments.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.parse_session_path

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.partition_query

partition_query(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.PartitionQueryRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_v1.types.spanner.PartitionResponse

Creates a set of partition tokens that can be used to execute a query operation in parallel.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.partition_query

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.partition_read

partition_read(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.PartitionReadRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_v1.types.spanner.PartitionResponse

Creates a set of partition tokens that can be used to execute a read operation in parallel.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.partition_read

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.read

read(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.ReadRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_v1.types.result_set.ResultSet

Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql][google.spanner.v1.Spanner.ExecuteSql].

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.read

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.rollback

rollback(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.RollbackRequest, dict]
    ] = None,
    *,
    session: typing.Optional[str] = None,
    transaction_id: typing.Optional[bytes] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Rolls back a transaction, releasing any locks it holds.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.rollback

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.session_path

session_path(project: str, instance: str, database: str, session: str) -> str

Returns a fully-qualified session string.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.session_path

google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.streaming_read

streaming_read(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.ReadRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Awaitable[
    typing.AsyncIterable[google.cloud.spanner_v1.types.result_set.PartialResultSet]
]

Like Read][google.spanner.v1.Spanner.Read], except returns the result set as a stream.

See more: google.cloud.spanner_v1.services.spanner.SpannerAsyncClient.streaming_read

google.cloud.spanner_v1.services.spanner.SpannerClient

SpannerClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.spanner_v1.services.spanner.transports.base.SpannerTransport, typing.Callable[[...], google.cloud.spanner_v1.services.spanner.transports.base.SpannerTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the spanner client.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient

google.cloud.spanner_v1.services.spanner.SpannerClient.exit

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.exit

google.cloud.spanner_v1.services.spanner.SpannerClient.batch_create_sessions

batch_create_sessions(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_v1.types.spanner.BatchCreateSessionsRequest, dict
        ]
    ] = None,
    *,
    database: typing.Optional[str] = None,
    session_count: typing.Optional[int] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_v1.types.spanner.BatchCreateSessionsResponse

Creates multiple new sessions.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.batch_create_sessions

google.cloud.spanner_v1.services.spanner.SpannerClient.batch_write

batch_write(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.BatchWriteRequest, dict]
    ] = None,
    *,
    session: typing.Optional[str] = None,
    mutation_groups: typing.Optional[
        typing.MutableSequence[
            google.cloud.spanner_v1.types.spanner.BatchWriteRequest.MutationGroup
        ]
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Iterable[google.cloud.spanner_v1.types.spanner.BatchWriteResponse]

Batches the supplied mutation groups in a collection of efficient transactions.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.batch_write

google.cloud.spanner_v1.services.spanner.SpannerClient.begin_transaction

begin_transaction(
    request: typing.Optional[
        typing.Union[
            google.cloud.spanner_v1.types.spanner.BeginTransactionRequest, dict
        ]
    ] = None,
    *,
    session: typing.Optional[str] = None,
    options: typing.Optional[
        google.cloud.spanner_v1.types.transaction.TransactionOptions
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_v1.types.transaction.Transaction

Begins a new transaction.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.begin_transaction

google.cloud.spanner_v1.services.spanner.SpannerClient.commit

commit(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.CommitRequest, dict]
    ] = None,
    *,
    session: typing.Optional[str] = None,
    transaction_id: typing.Optional[bytes] = None,
    mutations: typing.Optional[
        typing.MutableSequence[google.cloud.spanner_v1.types.mutation.Mutation]
    ] = None,
    single_use_transaction: typing.Optional[
        google.cloud.spanner_v1.types.transaction.TransactionOptions
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_v1.types.commit_response.CommitResponse

Commits a transaction.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.commit

google.cloud.spanner_v1.services.spanner.SpannerClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.common_billing_account_path

google.cloud.spanner_v1.services.spanner.SpannerClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.common_folder_path

google.cloud.spanner_v1.services.spanner.SpannerClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.common_location_path

google.cloud.spanner_v1.services.spanner.SpannerClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.common_organization_path

google.cloud.spanner_v1.services.spanner.SpannerClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.common_project_path

google.cloud.spanner_v1.services.spanner.SpannerClient.create_session

create_session(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.CreateSessionRequest, dict]
    ] = None,
    *,
    database: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_v1.types.spanner.Session

Creates a new session.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.create_session

google.cloud.spanner_v1.services.spanner.SpannerClient.database_path

database_path(project: str, instance: str, database: str) -> str

Returns a fully-qualified database string.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.database_path

google.cloud.spanner_v1.services.spanner.SpannerClient.delete_session

delete_session(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.DeleteSessionRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Ends a session, releasing server resources associated with it.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.delete_session

google.cloud.spanner_v1.services.spanner.SpannerClient.execute_batch_dml

execute_batch_dml(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.ExecuteBatchDmlRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_v1.types.spanner.ExecuteBatchDmlResponse

Executes a batch of SQL DML statements.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.execute_batch_dml

google.cloud.spanner_v1.services.spanner.SpannerClient.execute_sql

execute_sql(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.ExecuteSqlRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_v1.types.result_set.ResultSet

Executes an SQL statement, returning all results in a single reply.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.execute_sql

google.cloud.spanner_v1.services.spanner.SpannerClient.execute_streaming_sql

execute_streaming_sql(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.ExecuteSqlRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Iterable[google.cloud.spanner_v1.types.result_set.PartialResultSet]

Like ExecuteSql][google.spanner.v1.Spanner.ExecuteSql], except returns the result set as a stream.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.execute_streaming_sql

google.cloud.spanner_v1.services.spanner.SpannerClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

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

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.from_service_account_file

google.cloud.spanner_v1.services.spanner.SpannerClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

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

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.from_service_account_info

google.cloud.spanner_v1.services.spanner.SpannerClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

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

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.from_service_account_json

google.cloud.spanner_v1.services.spanner.SpannerClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.get_mtls_endpoint_and_cert_source

google.cloud.spanner_v1.services.spanner.SpannerClient.get_session

get_session(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.GetSessionRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_v1.types.spanner.Session

Gets a session.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.get_session

google.cloud.spanner_v1.services.spanner.SpannerClient.list_sessions

list_sessions(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.ListSessionsRequest, dict]
    ] = None,
    *,
    database: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_v1.services.spanner.pagers.ListSessionsPager

Lists all sessions in a given database.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.list_sessions

google.cloud.spanner_v1.services.spanner.SpannerClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.parse_common_billing_account_path

google.cloud.spanner_v1.services.spanner.SpannerClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.parse_common_folder_path

google.cloud.spanner_v1.services.spanner.SpannerClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.parse_common_location_path

google.cloud.spanner_v1.services.spanner.SpannerClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.parse_common_organization_path

google.cloud.spanner_v1.services.spanner.SpannerClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.parse_common_project_path

google.cloud.spanner_v1.services.spanner.SpannerClient.parse_database_path

parse_database_path(path: str) -> typing.Dict[str, str]

Parses a database path into its component segments.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.parse_database_path

google.cloud.spanner_v1.services.spanner.SpannerClient.parse_session_path

parse_session_path(path: str) -> typing.Dict[str, str]

Parses a session path into its component segments.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.parse_session_path

google.cloud.spanner_v1.services.spanner.SpannerClient.partition_query

partition_query(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.PartitionQueryRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_v1.types.spanner.PartitionResponse

Creates a set of partition tokens that can be used to execute a query operation in parallel.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.partition_query

google.cloud.spanner_v1.services.spanner.SpannerClient.partition_read

partition_read(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.PartitionReadRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_v1.types.spanner.PartitionResponse

Creates a set of partition tokens that can be used to execute a read operation in parallel.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.partition_read

google.cloud.spanner_v1.services.spanner.SpannerClient.read

read(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.ReadRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.spanner_v1.types.result_set.ResultSet

Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql][google.spanner.v1.Spanner.ExecuteSql].

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.read

google.cloud.spanner_v1.services.spanner.SpannerClient.rollback

rollback(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.RollbackRequest, dict]
    ] = None,
    *,
    session: typing.Optional[str] = None,
    transaction_id: typing.Optional[bytes] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Rolls back a transaction, releasing any locks it holds.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.rollback

google.cloud.spanner_v1.services.spanner.SpannerClient.session_path

session_path(project: str, instance: str, database: str, session: str) -> str

Returns a fully-qualified session string.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.session_path

google.cloud.spanner_v1.services.spanner.SpannerClient.streaming_read

streaming_read(
    request: typing.Optional[
        typing.Union[google.cloud.spanner_v1.types.spanner.ReadRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> typing.Iterable[google.cloud.spanner_v1.types.result_set.PartialResultSet]

Like Read][google.spanner.v1.Spanner.Read], except returns the result set as a stream.

See more: google.cloud.spanner_v1.services.spanner.SpannerClient.streaming_read

google.cloud.spanner_v1.services.spanner.pagers.ListSessionsAsyncPager

ListSessionsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[google.cloud.spanner_v1.types.spanner.ListSessionsResponse],
    ],
    request: google.cloud.spanner_v1.types.spanner.ListSessionsRequest,
    response: google.cloud.spanner_v1.types.spanner.ListSessionsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.spanner_v1.services.spanner.pagers.ListSessionsAsyncPager

google.cloud.spanner_v1.services.spanner.pagers.ListSessionsPager

ListSessionsPager(
    method: typing.Callable[
        [...], google.cloud.spanner_v1.types.spanner.ListSessionsResponse
    ],
    request: google.cloud.spanner_v1.types.spanner.ListSessionsRequest,
    response: google.cloud.spanner_v1.types.spanner.ListSessionsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.spanner_v1.services.spanner.pagers.ListSessionsPager

google.cloud.spanner_v1.session.Session.batch

batch()

Factory to create a batch for this session.

See more: google.cloud.spanner_v1.session.Session.batch

google.cloud.spanner_v1.session.Session.create

create()

Create this session, bound to its database.

See more: google.cloud.spanner_v1.session.Session.create

google.cloud.spanner_v1.session.Session.delete

delete()

Delete this session.

See more: google.cloud.spanner_v1.session.Session.delete

google.cloud.spanner_v1.session.Session.execute_sql

execute_sql(
    sql,
    params=None,
    param_types=None,
    query_mode=None,
    query_options=None,
    request_options=None,
    retry=_MethodDefault._DEFAULT_VALUE,
    timeout=_MethodDefault._DEFAULT_VALUE,
)

Perform an ExecuteStreamingSql API request.

See more: google.cloud.spanner_v1.session.Session.execute_sql

google.cloud.spanner_v1.session.Session.exists

exists()

Test for the existence of this session.

See more: google.cloud.spanner_v1.session.Session.exists

google.cloud.spanner_v1.session.Session.ping

ping()

Ping the session to keep it alive by executing "SELECT 1".

See more: google.cloud.spanner_v1.session.Session.ping

google.cloud.spanner_v1.session.Session.read

read(table, columns, keyset, index="", limit=0)

Perform a StreamingRead API request for rows in a table.

See more: google.cloud.spanner_v1.session.Session.read

google.cloud.spanner_v1.session.Session.run_in_transaction

run_in_transaction(func, *args, **kw)

Perform a unit of work in a transaction, retrying on abort.

See more: google.cloud.spanner_v1.session.Session.run_in_transaction

google.cloud.spanner_v1.session.Session.snapshot

snapshot(**kw)

Create a snapshot to perform a set of reads with shared staleness.

See more: google.cloud.spanner_v1.session.Session.snapshot

google.cloud.spanner_v1.session.Session.transaction

transaction()

Create a transaction to perform a set of reads with shared staleness.

See more: google.cloud.spanner_v1.session.Session.transaction

google.cloud.spanner_v1.snapshot.Snapshot.begin

begin()

Begin a read-only transaction on the database.

See more: google.cloud.spanner_v1.snapshot.Snapshot.begin

google.cloud.spanner_v1.snapshot.Snapshot.execute_sql

execute_sql(
    sql,
    params=None,
    param_types=None,
    query_mode=None,
    query_options=None,
    request_options=None,
    partition=None,
    retry=_MethodDefault._DEFAULT_VALUE,
    timeout=_MethodDefault._DEFAULT_VALUE,
    data_boost_enabled=False,
    directed_read_options=None,
)

Perform an ExecuteStreamingSql API request.

See more: google.cloud.spanner_v1.snapshot.Snapshot.execute_sql

google.cloud.spanner_v1.snapshot.Snapshot.partition_query

partition_query(
    sql,
    params=None,
    param_types=None,
    partition_size_bytes=None,
    max_partitions=None,
    *,
    retry=_MethodDefault._DEFAULT_VALUE,
    timeout=_MethodDefault._DEFAULT_VALUE
)

Perform a PartitionQuery API request.

See more: google.cloud.spanner_v1.snapshot.Snapshot.partition_query

google.cloud.spanner_v1.snapshot.Snapshot.partition_read

partition_read(
    table,
    columns,
    keyset,
    index="",
    partition_size_bytes=None,
    max_partitions=None,
    *,
    retry=_MethodDefault._DEFAULT_VALUE,
    timeout=_MethodDefault._DEFAULT_VALUE
)

Perform a PartitionRead API request for rows in a table.

See more: google.cloud.spanner_v1.snapshot.Snapshot.partition_read

google.cloud.spanner_v1.snapshot.Snapshot.read

read(
    table,
    columns,
    keyset,
    index="",
    limit=0,
    partition=None,
    request_options=None,
    data_boost_enabled=False,
    directed_read_options=None,
    *,
    retry=_MethodDefault._DEFAULT_VALUE,
    timeout=_MethodDefault._DEFAULT_VALUE
)

Perform a StreamingRead API request for rows in a table.

See more: google.cloud.spanner_v1.snapshot.Snapshot.read

google.cloud.spanner_v1.streamed.StreamedResultSet.one

one()

Return exactly one result, or raise an exception.

See more: google.cloud.spanner_v1.streamed.StreamedResultSet.one

google.cloud.spanner_v1.streamed.StreamedResultSet.one_or_none

one_or_none()

Return exactly one result, or None if there are no results.

See more: google.cloud.spanner_v1.streamed.StreamedResultSet.one_or_none

google.cloud.spanner_v1.streamed.StreamedResultSet.to_dict_list

to_dict_list()

Return the result of a query as a list of dictionaries.

See more: google.cloud.spanner_v1.streamed.StreamedResultSet.to_dict_list

google.cloud.spanner_v1.table.Table.exists

exists()

Test whether this table exists.

See more: google.cloud.spanner_v1.table.Table.exists

google.cloud.spanner_v1.table.Table.reload

reload()

Reload this table.

See more: google.cloud.spanner_v1.table.Table.reload

google.cloud.spanner_v1.transaction.Transaction.enter

__enter__()

Begin with block.

See more: google.cloud.spanner_v1.transaction.Transaction.enter

google.cloud.spanner_v1.transaction.Transaction.exit

__exit__(exc_type, exc_val, exc_tb)

End with block.

See more: google.cloud.spanner_v1.transaction.Transaction.exit

google.cloud.spanner_v1.transaction.Transaction.batch_update

batch_update(
    statements,
    request_options=None,
    *,
    retry=_MethodDefault._DEFAULT_VALUE,
    timeout=_MethodDefault._DEFAULT_VALUE
)

Perform a batch of DML statements via an ExecuteBatchDml request.

See more: google.cloud.spanner_v1.transaction.Transaction.batch_update

google.cloud.spanner_v1.transaction.Transaction.begin

begin()

Begin a transaction on the database.

See more: google.cloud.spanner_v1.transaction.Transaction.begin

google.cloud.spanner_v1.transaction.Transaction.commit

commit(return_commit_stats=False, request_options=None, max_commit_delay=None)

Commit mutations to the database.

See more: google.cloud.spanner_v1.transaction.Transaction.commit

google.cloud.spanner_v1.transaction.Transaction.delete

delete(table, keyset)

Delete one or more table rows.

See more: google.cloud.spanner_v1.transaction.Transaction.delete

google.cloud.spanner_v1.transaction.Transaction.execute_sql

execute_sql(
    sql,
    params=None,
    param_types=None,
    query_mode=None,
    query_options=None,
    request_options=None,
    partition=None,
    retry=_MethodDefault._DEFAULT_VALUE,
    timeout=_MethodDefault._DEFAULT_VALUE,
    data_boost_enabled=False,
    directed_read_options=None,
)

Perform an ExecuteStreamingSql API request.

See more: google.cloud.spanner_v1.transaction.Transaction.execute_sql

google.cloud.spanner_v1.transaction.Transaction.execute_update

execute_update(
    dml,
    params=None,
    param_types=None,
    query_mode=None,
    query_options=None,
    request_options=None,
    *,
    retry=_MethodDefault._DEFAULT_VALUE,
    timeout=_MethodDefault._DEFAULT_VALUE
)

Perform an ExecuteSql API request with DML.

See more: google.cloud.spanner_v1.transaction.Transaction.execute_update

google.cloud.spanner_v1.transaction.Transaction.insert

insert(table, columns, values)

Insert one or more new table rows.

See more: google.cloud.spanner_v1.transaction.Transaction.insert

google.cloud.spanner_v1.transaction.Transaction.insert_or_update

insert_or_update(table, columns, values)

Insert/update one or more table rows.

See more: google.cloud.spanner_v1.transaction.Transaction.insert_or_update

google.cloud.spanner_v1.transaction.Transaction.partition_query

partition_query(
    sql,
    params=None,
    param_types=None,
    partition_size_bytes=None,
    max_partitions=None,
    *,
    retry=_MethodDefault._DEFAULT_VALUE,
    timeout=_MethodDefault._DEFAULT_VALUE
)

Perform a PartitionQuery API request.

See more: google.cloud.spanner_v1.transaction.Transaction.partition_query

google.cloud.spanner_v1.transaction.Transaction.partition_read

partition_read(
    table,
    columns,
    keyset,
    index="",
    partition_size_bytes=None,
    max_partitions=None,
    *,
    retry=_MethodDefault._DEFAULT_VALUE,
    timeout=_MethodDefault._DEFAULT_VALUE
)

Perform a PartitionRead API request for rows in a table.

See more: google.cloud.spanner_v1.transaction.Transaction.partition_read

google.cloud.spanner_v1.transaction.Transaction.read

read(
    table,
    columns,
    keyset,
    index="",
    limit=0,
    partition=None,
    request_options=None,
    data_boost_enabled=False,
    directed_read_options=None,
    *,
    retry=_MethodDefault._DEFAULT_VALUE,
    timeout=_MethodDefault._DEFAULT_VALUE
)

Perform a StreamingRead API request for rows in a table.

See more: google.cloud.spanner_v1.transaction.Transaction.read

google.cloud.spanner_v1.transaction.Transaction.replace

replace(table, columns, values)

Replace one or more table rows.

See more: google.cloud.spanner_v1.transaction.Transaction.replace

google.cloud.spanner_v1.transaction.Transaction.rollback

rollback()

Roll back a transaction on the database.

See more: google.cloud.spanner_v1.transaction.Transaction.rollback

google.cloud.spanner_v1.transaction.Transaction.update

update(table, columns, values)

Update one or more existing table rows.

See more: google.cloud.spanner_v1.transaction.Transaction.update

Package Methods (3.46.0)

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.backup_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.cancel_operation

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.common_billing_account_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.common_folder_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.common_location_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.common_organization_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.common_project_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.copy_backup

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.create_backup

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.create_database

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.crypto_key_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.crypto_key_version_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.database_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.database_role_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.delete_backup

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.delete_operation

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.drop_database

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.from_service_account_file

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.from_service_account_info

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.from_service_account_json

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_backup

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_database

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_database_ddl

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_iam_policy

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_operation

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.get_transport_class

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.instance_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.list_backup_operations

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.list_backups

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.list_database_operations

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.list_database_roles

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.list_databases

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.list_operations

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_backup_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_common_billing_account_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_common_folder_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_common_location_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_common_organization_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_common_project_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_crypto_key_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_crypto_key_version_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_database_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_database_role_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.parse_instance_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.restore_database

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.set_iam_policy

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.test_iam_permissions

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.update_backup

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.update_database

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminAsyncClient.update_database_ddl

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.__exit__

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.backup_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.cancel_operation

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.common_billing_account_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.common_folder_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.common_location_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.common_organization_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.common_project_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.copy_backup

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.create_backup

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.create_database

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.crypto_key_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.crypto_key_version_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.database_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.database_role_path

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.delete_backup

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.delete_operation

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.drop_database

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.from_service_account_file

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.from_service_account_info

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.from_service_account_json

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_backup

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_database

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_database_ddl

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_iam_policy

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.get_mtls_endpoint_and_cert_source

google.cloud.spanner_admin_database_v1.services.database_admin.DatabaseAdminClient.exit