Reference documentation and code samples for the Cloud Spanner Database Admin V1 API class Google::Cloud::Spanner::Admin::Database::V1::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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#database
def database() -> ::String- (::String) — Required. The database to update.
#database=
def database=(value) -> ::String- value (::String) — Required. The database to update.
- (::String) — Required. The database to update.
#operation_id
def operation_id() -> ::String-
(::String) — If empty, the new update request is assigned an
automatically-generated operation ID. Otherwise,
operation_idis 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_idfields can be combined to form the name of the resulting longrunning.Operation:<database>/operations/<operation_id>.operation_idshould 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 returnsALREADY_EXISTS.
#operation_id=
def operation_id=(value) -> ::String-
value (::String) — If empty, the new update request is assigned an
automatically-generated operation ID. Otherwise,
operation_idis 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_idfields can be combined to form the name of the resulting longrunning.Operation:<database>/operations/<operation_id>.operation_idshould 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 returnsALREADY_EXISTS.
-
(::String) — If empty, the new update request is assigned an
automatically-generated operation ID. Otherwise,
operation_idis 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_idfields can be combined to form the name of the resulting longrunning.Operation:<database>/operations/<operation_id>.operation_idshould 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 returnsALREADY_EXISTS.
#statements
def statements() -> ::Array<::String>- (::Array<::String>) — Required. DDL statements to be applied to the database.
#statements=
def statements=(value) -> ::Array<::String>- value (::Array<::String>) — Required. DDL statements to be applied to the database.
- (::Array<::String>) — Required. DDL statements to be applied to the database.