# Google Cloud Spanner Database Administration v1 API - Class UpdateDatabaseDdlRequest (5.13.0-beta07)

5.13.0-beta07 5.13.0-beta06 5.12.0 (latest) 5.11.0 5.10.0 5.9.0 5.8.0 5.7.0 5.6.0 5.5.0 5.4.0 5.3.0 5.2.0 5.1.0 5.0.0 4.6.0 4.5.0 4.4.0 4.3.0 4.2.0 4.1.0 4.0.0 3.15.1 3.14.0 3.13.0 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0

    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](https://learn.microsoft.com/dotnet/api/system.object) \> UpdateDatabaseDdlRequest

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[UpdateDatabaseDdlRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.UpdateDatabaseDdlRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[UpdateDatabaseDdlRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.UpdateDatabaseDdlRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[UpdateDatabaseDdlRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.UpdateDatabaseDdlRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.Spanner.Admin.Database.V1](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/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` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.UpdateDatabaseDdlRequest` |

## Properties

### Database

    public string Database { get; set; }

Required. The database to update.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### DatabaseAsDatabaseName

    public DatabaseName DatabaseAsDatabaseName { get; set; }

Google.Cloud.Spanner.Common.V1.DatabaseName-typed view over the [Database](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.UpdateDatabaseDdlRequest#Google_Cloud_Spanner_Admin_Database_V1_UpdateDatabaseDdlRequest_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** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### ProtoDescriptors

    public ByteString ProtoDescriptors { get; set; }

Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements.
Contains a protobuf-serialized
[google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto).
To generate it, [install](https://grpc.io/docs/protoc-installation/) 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](https://developers.google.com/protocol-buffers/docs/techniques#self-description).

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.ByteString.html` |   |

### Statements

    public RepeatedField<string> Statements { get; }

Required. DDL statements to be applied to the database.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### ThroughputMode

    public bool ThroughputMode { get; set; }

Optional. This field is exposed to be used by the Spanner Migration Tool.
For more details, see
[SMT](https://github.com/GoogleCloudPlatform/spanner-migration-tool).

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |