Cloud Spanner V1 API - Class Google::Cloud::Spanner::V1::ExecuteBatchDmlRequest (v1.3.0)

Reference documentation and code samples for the Cloud Spanner V1 API class Google::Cloud::Spanner::V1::ExecuteBatchDmlRequest.

The request for ExecuteBatchDml.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#last_statements

def last_statements() -> ::Boolean
Returns
  • (::Boolean) — Optional. If set to true, this request marks the end of the transaction. The transaction should be committed or aborted after these statements execute, and attempts to execute any other requests against this transaction (including reads and queries) will be rejected.

    Setting this option may cause some error reporting to be deferred until commit time (e.g. validation of unique constraints). Given this, successful execution of statements should not be assumed until a subsequent Commit call completes successfully.

#last_statements=

def last_statements=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. If set to true, this request marks the end of the transaction. The transaction should be committed or aborted after these statements execute, and attempts to execute any other requests against this transaction (including reads and queries) will be rejected.

    Setting this option may cause some error reporting to be deferred until commit time (e.g. validation of unique constraints). Given this, successful execution of statements should not be assumed until a subsequent Commit call completes successfully.

Returns
  • (::Boolean) — Optional. If set to true, this request marks the end of the transaction. The transaction should be committed or aborted after these statements execute, and attempts to execute any other requests against this transaction (including reads and queries) will be rejected.

    Setting this option may cause some error reporting to be deferred until commit time (e.g. validation of unique constraints). Given this, successful execution of statements should not be assumed until a subsequent Commit call completes successfully.

#request_options

def request_options() -> ::Google::Cloud::Spanner::V1::RequestOptions
Returns

#request_options=

def request_options=(value) -> ::Google::Cloud::Spanner::V1::RequestOptions
Parameter
Returns

#seqno

def seqno() -> ::Integer
Returns
  • (::Integer) — Required. A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed.

    The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution.

#seqno=

def seqno=(value) -> ::Integer
Parameter
  • value (::Integer) — Required. A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed.

    The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution.

Returns
  • (::Integer) — Required. A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed.

    The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution.

#session

def session() -> ::String
Returns
  • (::String) — Required. The session in which the DML statements should be performed.

#session=

def session=(value) -> ::String
Parameter
  • value (::String) — Required. The session in which the DML statements should be performed.
Returns
  • (::String) — Required. The session in which the DML statements should be performed.

#statements

def statements() -> ::Array<::Google::Cloud::Spanner::V1::ExecuteBatchDmlRequest::Statement>
Returns
  • (::Array<::Google::Cloud::Spanner::V1::ExecuteBatchDmlRequest::Statement>) — Required. The list of statements to execute in this batch. Statements are executed serially, such that the effects of statement i are visible to statement i+1. Each statement must be a DML statement. Execution stops at the first failed statement; the remaining statements are not executed.

    Callers must provide at least one statement.

#statements=

def statements=(value) -> ::Array<::Google::Cloud::Spanner::V1::ExecuteBatchDmlRequest::Statement>
Parameter
  • value (::Array<::Google::Cloud::Spanner::V1::ExecuteBatchDmlRequest::Statement>) — Required. The list of statements to execute in this batch. Statements are executed serially, such that the effects of statement i are visible to statement i+1. Each statement must be a DML statement. Execution stops at the first failed statement; the remaining statements are not executed.

    Callers must provide at least one statement.

Returns
  • (::Array<::Google::Cloud::Spanner::V1::ExecuteBatchDmlRequest::Statement>) — Required. The list of statements to execute in this batch. Statements are executed serially, such that the effects of statement i are visible to statement i+1. Each statement must be a DML statement. Execution stops at the first failed statement; the remaining statements are not executed.

    Callers must provide at least one statement.

#transaction

def transaction() -> ::Google::Cloud::Spanner::V1::TransactionSelector
Returns
  • (::Google::Cloud::Spanner::V1::TransactionSelector) — Required. The transaction to use. Must be a read-write transaction.

    To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction.

#transaction=

def transaction=(value) -> ::Google::Cloud::Spanner::V1::TransactionSelector
Parameter
  • value (::Google::Cloud::Spanner::V1::TransactionSelector) — Required. The transaction to use. Must be a read-write transaction.

    To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction.

Returns
  • (::Google::Cloud::Spanner::V1::TransactionSelector) — Required. The transaction to use. Must be a read-write transaction.

    To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction.