package google.spanner.admin.database.v1
Get desktop application:
View/edit binary Protocol Buffers messages
Cloud Spanner Database Admin API The Cloud Spanner Database Admin API can be used to create, drop, and list databases. It also enables updating the schema of pre-existing databases.
Lists Cloud Spanner databases.
message
spanner_database_admin.proto:170The request for [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].
string parent = 1
Required. The instance whose databases should be listed. Values are of the form `projects/<project>/instances/<instance>`.
int32 page_size = 3
Number of databases to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
string page_token = 4
If non-empty, `page_token` should contain a [next_page_token][google.spanner.admin.database.v1.ListDatabasesResponse.next_page_token] from a previous [ListDatabasesResponse][google.spanner.admin.database.v1.ListDatabasesResponse].
message
spanner_database_admin.proto:188The response for [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].
repeated databases = 1
Databases that matched the request.
string next_page_token = 2
`next_page_token` can be sent in a subsequent [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases] call to fetch more of the matching databases.
Creates a new Cloud Spanner database and starts to prepare it for serving. The returned [long-running operation][google.longrunning.Operation] will have a name of the format `<database_name>/operations/<operation_id>` and can be used to track preparation of the database. The [metadata][google.longrunning.Operation.metadata] field type is [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The [response][google.longrunning.Operation.response] field type is [Database][google.spanner.admin.database.v1.Database], if successful.
message
spanner_database_admin.proto:200The request for [CreateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase].
string parent = 1
Required. The name of the instance that will serve the new database. Values are of the form `projects/<project>/instances/<instance>`.
string create_statement = 2
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 (`` ` ``).
repeated string extra_statements = 3
An optional list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created.
Gets the state of a Cloud Spanner database.
message
spanner_database_admin.proto:228The request for [GetDatabase][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabase].
string name = 1
Required. The name of the requested database. Values are of the form `projects/<project>/instances/<instance>/databases/<database>`.
Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned [long-running operation][google.longrunning.Operation] will have a name of the format `<database_name>/operations/<operation_id>` and can be used to track execution of the schema change(s). The [metadata][google.longrunning.Operation.metadata] field type is [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The operation has no response.
message
spanner_database_admin.proto:250Enqueues the given DDL statements to be applied, in order but not necessarily all at once, to the database schema at some point (or points) in the future. The server checks that the statements are executable (syntactically valid, name tables that exist, etc.) before enqueueing them, but they may still fail upon later execution (e.g., if a statement from another batch of statements is applied first and it conflicts in some way, or if there is some data-related problem like a `NULL` value in a column to which `NOT NULL` would be added). If a statement fails, all subsequent statements in the batch are automatically cancelled. Each batch of statements is assigned a name which can be used with the [Operations][google.longrunning.Operations] API to monitor progress. See the [operation_id][google.spanner.admin.database.v1.UpdateDatabaseDdlRequest.operation_id] field for more details.
string database = 1
Required. The database to update.
repeated string statements = 2
DDL statements to be applied to the database.
string operation_id = 3
If empty, the new update request is assigned an automatically-generated operation ID. Otherwise, `operation_id` is used to construct the name of the resulting [Operation][google.longrunning.Operation]. Specifying an explicit operation ID simplifies determining whether the statements were executed in the event that the [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl] call is replayed, or the return value is otherwise lost: the [database][google.spanner.admin.database.v1.UpdateDatabaseDdlRequest.database] and `operation_id` fields can be combined to form the [name][google.longrunning.Operation.name] of the resulting [longrunning.Operation][google.longrunning.Operation]: `<database>/operations/<operation_id>`. `operation_id` should be unique within the database, and must be a valid identifier: `[a-z][a-z0-9_]*`. Note that automatically-generated operation IDs always begin with an underscore. If the named operation already exists, [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl] returns `ALREADY_EXISTS`.
Drops (aka deletes) a Cloud Spanner database.
message
spanner_database_admin.proto:299The request for [DropDatabase][google.spanner.admin.database.v1.DatabaseAdmin.DropDatabase].
string database = 1
Required. The database to be dropped.
Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the [Operations][google.longrunning.Operations] API.
message
spanner_database_admin.proto:306The request for [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].
string database = 1
Required. The database whose schema we wish to get.
message
spanner_database_admin.proto:313The response for [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].
repeated string statements = 1
A list of formatted DDL statements defining the schema of the database specified in the request.
Sets the access control policy on a database resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on [resource][google.iam.v1.SetIamPolicyRequest.resource].
Gets the access control policy for a database resource. Returns an empty policy if a database exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on [resource][google.iam.v1.GetIamPolicyRequest.resource].
Returns permissions that the caller has on the specified database resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions.
message
spanner_database_admin.proto:221Metadata type for the operation returned by [CreateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase].
string database = 1
The database being created.
message
spanner_database_admin.proto:143A Cloud Spanner database.
Used as response type in: DatabaseAdmin.GetDatabase
Used as field type in:
string name = 1
Required. The name of the database. Values are of the form `projects/<project>/instances/<instance>/databases/<database>`, where `<database>` is as specified in the `CREATE DATABASE` statement. This name can be passed to other API methods to identify the database.
Database.State state = 2
Output only. The current database state.
Indicates the current state of the database.
Used in:
STATE_UNSPECIFIED = 0
Not specified.
CREATING = 1
The database is still being created. Operations on the database may fail with `FAILED_PRECONDITION` in this state.
READY = 2
The database is fully created and ready for use.
message
spanner_database_admin.proto:283Metadata type for the operation returned by [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl].
string database = 1
The database being modified.
repeated string statements = 2
For an update this list contains all the statements. For an individual statement, this list contains only that statement.
repeated commit_timestamps = 3
Reports the commit timestamps of all statements that have succeeded so far, where `commit_timestamps[i]` is the commit timestamp for the statement `statements[i]`.