Google Cloud Spanner Database Administration v1 API - Class UpdateDatabaseDdlRequest (5.0.0-beta04) 

public sealed class UpdateDatabaseDdlRequest : IMessage<UpdateDatabaseDdlRequest>, IEquatable<UpdateDatabaseDdlRequest>, IDeepCloneable<UpdateDatabaseDdlRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Spanner Database Administration v1 API 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][google.longrunning.Operations] API to monitor progress. See the [operation_id][google.spanner.admin.database.v1.UpdateDatabaseDdlRequest.operation_id] field for more details.

Inheritance

object > UpdateDatabaseDdlRequest

Namespace

Google.Cloud.Spanner.Admin.Database.V1

Assembly

Google.Cloud.Spanner.Admin.Database.V1.dll

Constructors

UpdateDatabaseDdlRequest()

public UpdateDatabaseDdlRequest()

UpdateDatabaseDdlRequest(UpdateDatabaseDdlRequest)

public UpdateDatabaseDdlRequest(UpdateDatabaseDdlRequest other)
Parameter
Name Description
other UpdateDatabaseDdlRequest

Properties

Database

public string Database { get; set; }

Required. The database to update.

Property Value
Type Description
string

DatabaseAsDatabaseName

public DatabaseName DatabaseAsDatabaseName { get; set; }

Google.Cloud.Spanner.Common.V1.DatabaseName-typed view over the Database resource name property.

Property Value
Type Description
Google.Cloud.Spanner.Common.V1.DatabaseName

OperationId

public string OperationId { get; set; }

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.

Property Value
Type Description
string

ProtoDescriptors

public ByteString ProtoDescriptors { get; set; }

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.

Property Value
Type Description
ByteString

Statements

public RepeatedField<string> Statements { get; }

Required. DDL statements to be applied to the database.

Property Value
Type Description
RepeatedFieldstring