Reference documentation and code samples for the Cloud Spanner V1 Client class 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 API to monitor progress. See the operation_id field for more details.
Generated from protobuf message google.spanner.admin.database.v1.UpdateDatabaseDdlRequest
Namespace
Google \ Cloud \ Spanner \ Admin \ Database \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ database |
string
Required. The database to update. |
↳ statements |
array
Required. DDL statements to be applied to the database. |
↳ operation_id |
string
If empty, the new update request is assigned an automatically-generated operation ID. Otherwise, |
↳ proto_descriptors |
string
Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements. Contains a protobuf-serialized google.protobuf.FileDescriptorSet. To generate it, install and run |
getDatabase
Required. The database to update.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDatabase
Required. The database to update.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStatements
Required. DDL statements to be applied to the database.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setStatements
Required. DDL statements to be applied to the database.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
Specifying an explicit operation ID simplifies determining
whether the statements were executed in the event that the
UpdateDatabaseDdl
call is replayed, or the return value is otherwise lost: the
database
and operation_id fields can be combined to form the
name of the resulting
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
returns ALREADY_EXISTS.
| Returns | |
|---|---|
| Type | Description |
string |
|
setOperationId
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.
Specifying an explicit operation ID simplifies determining
whether the statements were executed in the event that the
UpdateDatabaseDdl
call is replayed, or the return value is otherwise lost: the
database
and operation_id fields can be combined to form the
name of the resulting
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
returns ALREADY_EXISTS.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProtoDescriptors
Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements.
Contains a protobuf-serialized
google.protobuf.FileDescriptorSet.
To generate it, install and
run protoc with --include_imports and --descriptor_set_out. For example,
to generate for moon/shot/app.proto, run
$protoc --proto_path=/app_path --proto_path=/lib_path \
--include_imports \
--descriptor_set_out=descriptors.data \
moon/shot/app.proto
For more details, see protobuffer self description.
| Returns | |
|---|---|
| Type | Description |
string |
|
setProtoDescriptors
Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements.
Contains a protobuf-serialized
google.protobuf.FileDescriptorSet.
To generate it, install and
run protoc with --include_imports and --descriptor_set_out. For example,
to generate for moon/shot/app.proto, run
$protoc --proto_path=/app_path --proto_path=/lib_path \
--include_imports \
--descriptor_set_out=descriptors.data \
moon/shot/app.proto
For more details, see protobuffer self description.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
database |
string
Required. The database to update. Please see DatabaseAdminClient::databaseName() for help formatting this field. |
statements |
string[]
Required. DDL statements to be applied to the database. |
| Returns | |
|---|---|
| Type | Description |
UpdateDatabaseDdlRequest |
|