- 3.50.0 (latest)
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.1
- 3.39.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.1
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.27.1
- 3.26.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.2
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.1
- 3.14.1
- 3.13.0
- 3.12.1
- 3.11.1
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.0
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.0
- 2.1.1
- 2.0.0
- 1.19.3
- 1.18.0
- 1.17.1
- 1.16.0
- 1.15.1
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
UpdateDatabaseDdlRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Enqueues the given DDL statements to be applied, in order but not
necessarily all at once, to the database schema at some point (or
points) in the future. The server checks that the statements are
executable (syntactically valid, name tables that exist, etc.)
before enqueueing them, but they may still fail upon later execution
(e.g., if a statement from another batch of statements is applied
first and it conflicts in some way, or if there is some data-related
problem like a NULL
value in a column to which NOT NULL
would be added). If a statement fails, all subsequent statements in
the batch are automatically cancelled.
Each batch of statements is assigned a name which can be used with
the Operations][google.longrunning.Operations]
API to monitor
progress. See the
operation_id][google.spanner.admin.database.v1.UpdateDatabaseDdlRequest.operation_id]
field for more details.
Attributes | |
---|---|
Name | Description |
database |
str
Required. The database to update. |
statements |
Sequence[str]
Required. DDL statements to be applied to the database. |
operation_id |
str
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] :
.
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 .
|