UpdateDatabaseDdlRequest
class UpdateDatabaseDdlRequest extends Message
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.
Protobuf type Google\Spanner\Admin\Database\V1\UpdateDatabaseDdlRequest
Methods
No description
Required. The database to update.
Required. The database to update.
DDL statements to be applied to the database.
DDL statements to be applied to the database.
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].
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].
Details
at line 67
__construct()
at line 78
string
getDatabase()
Required. The database to update.
Generated from protobuf field string database = 1;
at line 89
setDatabase(string $var)
Required. The database to update.
Generated from protobuf field string database = 1;
at line 101
RepeatedField
getStatements()
DDL statements to be applied to the database.
Generated from protobuf field repeated string statements = 2;
at line 112
setStatements(array|RepeatedField $var)
DDL statements to be applied to the database.
Generated from protobuf field repeated string statements = 2;
at line 140
string
getOperationId()
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
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.
Generated from protobuf field string operation_id = 3;
at line 167
setOperationId(string $var)
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
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.
Generated from protobuf field string operation_id = 3;