Required. A CREATE DATABASE statement, which specifies the ID of the new database. The database ID must conform to the regular expression [a-z][a-z0-9_\-]*[a-z0-9] and be between 2 and 30 characters in length. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks (:literal:```).

CustomHttpPattern

API documentation for spanner_admin_database_v1.types.CustomHttpPattern class.

Database

A Cloud Spanner database.

Output only. The current database state.

Output only. Applicable only for restored databases. Contains information about the restore source.

DeleteOperationRequest

API documentation for spanner_admin_database_v1.types.DeleteOperationRequest class.

DescriptorProto

API documentation for spanner_admin_database_v1.types.DescriptorProto class.

DropDatabaseRequest

The request for [DropDatabase][google.spanner.admin.database.v1.Databa seAdmin.DropDatabase].

Empty

API documentation for spanner_admin_database_v1.types.Empty class.

EnumDescriptorProto

API documentation for spanner_admin_database_v1.types.EnumDescriptorProto class.

EnumOptions

API documentation for spanner_admin_database_v1.types.EnumOptions class.

EnumValueDescriptorProto

API documentation for spanner_admin_database_v1.types.EnumValueDescriptorProto class.

EnumValueOptions

API documentation for spanner_admin_database_v1.types.EnumValueOptions class.

ExtensionRangeOptions

API documentation for spanner_admin_database_v1.types.ExtensionRangeOptions class.

FieldDescriptorProto

API documentation for spanner_admin_database_v1.types.FieldDescriptorProto class.

FieldOptions

API documentation for spanner_admin_database_v1.types.FieldOptions class.

FileDescriptorProto

API documentation for spanner_admin_database_v1.types.FileDescriptorProto class.

FileDescriptorSet

API documentation for spanner_admin_database_v1.types.FileDescriptorSet class.

FileOptions

API documentation for spanner_admin_database_v1.types.FileOptions class.

GeneratedCodeInfo

API documentation for spanner_admin_database_v1.types.GeneratedCodeInfo class.

GetDatabaseDdlRequest

The request for [GetDatabaseDdl][google.spanner.admin.database.v1.Data baseAdmin.GetDatabaseDdl].

GetDatabaseDdlResponse

The response for [GetDatabaseDdl][google.spanner.admin.database.v1.Dat abaseAdmin.GetDatabaseDdl].

GetDatabaseRequest

The request for [GetDatabase][google.spanner.admin.database.v1.Databas eAdmin.GetDatabase].

GetIamPolicyRequest

API documentation for spanner_admin_database_v1.types.GetIamPolicyRequest class.

GetOperationRequest

API documentation for spanner_admin_database_v1.types.GetOperationRequest class.

Http

API documentation for spanner_admin_database_v1.types.Http class.

HttpRule

API documentation for spanner_admin_database_v1.types.HttpRule class.

ListDatabaseOperationsRequest

The request for [ListDatabaseOperations][google.spanner.admin.database .v1.DatabaseAdmin.ListDatabaseOperations].

An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: <, >, <=, >=, !=, =, or :. Colon : is the contains operator. Filter rules are not case sensitive. The following fields in the Operation][google.longrunning.Operation] are eligible for filtering: - name - The name of the long-running operation - done - False if the operation is in progress, else true. - metadata.@type - the type of metadata. For example, the type string for [RestoreDatabaseMetadata][g oogle.spanner.admin.database.v1.RestoreDatabaseMetadata] is type.googleapis.com/google.spanner.admin.database.v1.Restore DatabaseMetadata. - metadata.<field_name> - any field in metadata.value. - error - Error associated with the long-running operation. - response.@type - the type of response. - response.<field_name> - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: - done:true - The operation is complete. - (metadata.@type=type.googleapis.com/google.spanner.admin.datab ase.v1.RestoreDatabaseMetadata) AND (metadata.source_type:BACKUP) AND (metadata.backup_info.backup:backup_howl) AND (metadata.name:restored_howl) AND (metadata.progress.start_time < "2018-03-28T14:50:00Z") AND (error:*) - Return operations where: - The operation’s metadata type is [RestoreDatabaseMetadata][g oogle.spanner.admin.database.v1.RestoreDatabaseMetadata]. - The database is restored from a backup. - The backup name contains “backup_howl”. - The restored database’s name contains “restored_howl”. - The operation started before 2018-03-28T14:50:00Z. - The operation resulted in an error.

If non-empty, page_token should contain a [next_page_tok en][google.spanner.admin.database.v1.ListDatabaseOperationsRes ponse.next_page_token] from a previous [ListDatabaseOperatio nsResponse][google.spanner.admin.database.v1.ListDatabaseOpera tionsResponse] to the same parent and with the same filter.

ListDatabaseOperationsResponse

The response for [ListDatabaseOperations][google.spanner.admin.databas e.v1.DatabaseAdmin.ListDatabaseOperations].

\ next_page_token can be sent in a subsequent [ListDatabas eOperations][google.spanner.admin.database.v1.DatabaseAdmin.Li stDatabaseOperations] call to fetch more of the matching metadata.

ListDatabasesRequest

The request for [ListDatabases][google.spanner.admin.database.v1.Datab aseAdmin.ListDatabases].

Number of databases to be returned in the response. If 0 or less, defaults to the server’s maximum allowed page size.

ListDatabasesResponse

The response for [ListDatabases][google.spanner.admin.database.v1.Data baseAdmin.ListDatabases].

\ next_page_token can be sent in a subsequent [ListDatabas es][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabas es] call to fetch more of the matching databases.

ListOperationsRequest

API documentation for spanner_admin_database_v1.types.ListOperationsRequest class.

ListOperationsResponse

API documentation for spanner_admin_database_v1.types.ListOperationsResponse class.

MessageOptions

API documentation for spanner_admin_database_v1.types.MessageOptions class.

MethodDescriptorProto

API documentation for spanner_admin_database_v1.types.MethodDescriptorProto class.

MethodOptions

API documentation for spanner_admin_database_v1.types.MethodOptions class.

OneofDescriptorProto

API documentation for spanner_admin_database_v1.types.OneofDescriptorProto class.

OneofOptions

API documentation for spanner_admin_database_v1.types.OneofOptions class.

Operation

API documentation for spanner_admin_database_v1.types.Operation class.

OperationInfo

API documentation for spanner_admin_database_v1.types.OperationInfo class.

OptimizeRestoredDatabaseMetadata

Metadata type for the long-running operation used to track the progress of optimizations performed on a newly restored database. This long-running operation is automatically created by the system after the successful completion of a database restore, and cannot be cancelled.

The progress of the post-restore optimizations.

Policy

API documentation for spanner_admin_database_v1.types.Policy class.

PolicyDelta

API documentation for spanner_admin_database_v1.types.PolicyDelta class.

RestoreDatabaseMetadata

Metadata type for the long-running operation returned by [RestoreDatab ase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase].

The type of the restore source.

Information about the backup used to restore the database.

The time at which cancellation of this operation was received. [Operations.CancelOperation][google.longrunning.Operations.Can celOperation] starts asynchronous cancellation on a long- running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients can use [Operations.GetOperation][google.longrunning.Operations.GetOpe ration] or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error][google.longrunning.Operation.error] value with a google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED.

RestoreDatabaseRequest

The request for [RestoreDatabase][google.spanner.admin.database.v1.Dat abaseAdmin.RestoreDatabase].

Required. The id of the database to create and restore to. This database must not already exist. The database_id appended to parent forms the full database name of the form projects/<project>/instances/<instance>/databases/<data base_id>.

Name of the backup from which to restore. Values are of the form projects/<project>/instances/<instance>/backups/<backup>.

RestoreInfo

Information about the database restore.

Information about the source used to restore the database.

ServiceDescriptorProto

API documentation for spanner_admin_database_v1.types.ServiceDescriptorProto class.

ServiceOptions

API documentation for spanner_admin_database_v1.types.ServiceOptions class.

SetIamPolicyRequest

API documentation for spanner_admin_database_v1.types.SetIamPolicyRequest class.

SourceCodeInfo

API documentation for spanner_admin_database_v1.types.SourceCodeInfo class.

Status

API documentation for spanner_admin_database_v1.types.Status class.

TestIamPermissionsRequest

API documentation for spanner_admin_database_v1.types.TestIamPermissionsRequest class.

TestIamPermissionsResponse

API documentation for spanner_admin_database_v1.types.TestIamPermissionsResponse class.

Timestamp

API documentation for spanner_admin_database_v1.types.Timestamp class.

UninterpretedOption

API documentation for spanner_admin_database_v1.types.UninterpretedOption class.

UpdateDatabaseDdlMetadata

Metadata type for the operation returned by [UpdateDatabaseDdl][google .spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl].

For an update this list contains all the statements. For an individual statement, this list contains only that statement.

UpdateDatabaseDdlRequest

Enqueues the given DDL statements to be applied, in order but not necessarily all at once, to the database schema at some point (or points) in the future. The server checks that the statements are executable (syntactically valid, name tables that exist, etc.) before enqueueing them, but they may still fail upon later execution (e.g., if a statement from another batch of statements is applied first and it conflicts in some way, or if there is some data-related problem like a NULL value in a column to which NOT NULL would be added). If a statement fails, all subsequent statements in the batch are automatically cancelled. Each batch of statements is assigned a name which can be used with the Operations][google.longrunning.Operations] API to monitor progress. See the [operation_id][google.spanner.admin.database.v1.UpdateDatabase DdlRequest.operation_id] field for more details.

Required. DDL statements to be applied to the database.

WaitOperationRequest

API documentation for spanner_admin_database_v1.types.WaitOperationRequest class.