Class: Google::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest

Inherits:

Object

• Object
• Google::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest

Defined in:

lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/spanner_database_admin.rb

Overview

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.

Instance Attribute Summary

• #database ⇒ String

  Required.

• #operation_id ⇒ String

  If empty, the new update request is assigned an automatically-generated operation ID.

• #statements ⇒ Array<String>

  DDL statements to be applied to the database.

Instance Attribute Details

#database ⇒ String

Returns Required. The database to update.

Returns:

• (String) —

  Required. The database to update.

# File 'lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/spanner_database_admin.rb', line 161

class UpdateDatabaseDdlRequest; end

#operation_id ⇒ String

Returns 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: +/operations/+.

+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:

• (String) —

  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: +/operations/+.

  +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+.

# File 'lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/spanner_database_admin.rb', line 161

class UpdateDatabaseDdlRequest; end

#statements ⇒ Array<String>

Returns DDL statements to be applied to the database.

Returns:

• (Array<String>) —

  DDL statements to be applied to the database.

# File 'lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/spanner_database_admin.rb', line 161

class UpdateDatabaseDdlRequest; end