Class: Google::Apis::SpannerV1::UpdateDatabaseDdlRequest

Inherits:

Object

• Object
• Google::Apis::SpannerV1::UpdateDatabaseDdlRequest

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

generated/google/apis/spanner_v1/classes.rb,
generated/google/apis/spanner_v1/representations.rb,
generated/google/apis/spanner_v1/representations.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

• #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 Method Summary

• #initialize(**args) ⇒ UpdateDatabaseDdlRequest constructor

  A new instance of UpdateDatabaseDdlRequest.

• #update!(**args) ⇒ Object

  Update properties of this object.

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ UpdateDatabaseDdlRequest

Returns a new instance of UpdateDatabaseDdlRequest

# File 'generated/google/apis/spanner_v1/classes.rb', line 3159

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#operation_id ⇒ 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: <database>/operations/<operation_id>. operation_id should be unique within the database, and must be a valid identifier: a-z*. Note that automatically-generated operation IDs always begin with an underscore. If the named operation already exists, UpdateDatabaseDdl returns ALREADY_EXISTS. Corresponds to the JSON property operationId

Returns:

• (String)

# File 'generated/google/apis/spanner_v1/classes.rb', line 3152

def operation_id
  @operation_id
end

#statements ⇒ Array<String>

DDL statements to be applied to the database. Corresponds to the JSON property statements

Returns:

• (Array<String>)

# File 'generated/google/apis/spanner_v1/classes.rb', line 3157

def statements
  @statements
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/spanner_v1/classes.rb', line 3164

def update!(**args)
  @operation_id = args[:operation_id] if args.key?(:operation_id)
  @statements = args[:statements] if args.key?(:statements)
end