Cloud Spanner V1 Client - Class ExecuteBatchDmlRequest (1.92.1)

Reference documentation and code samples for the Cloud Spanner V1 Client class ExecuteBatchDmlRequest.

The request for ExecuteBatchDml .

Generated from protobuf message google.spanner.v1.ExecuteBatchDmlRequest

Namespace

Google \ Cloud \ Spanner \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ session
string

Required. The session in which the DML statements should be performed.

↳ transaction
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.

↳ statements
array< 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.

↳ seqno
int|string

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.

↳ request_options
RequestOptions

Common options for this request.

↳ last_statements
bool

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.

getSession

Required. The session in which the DML statements should be performed.

Returns
Type
Description
string

setSession

Required. The session in which the DML statements should be performed.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getTransaction

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
Type
Description

hasTransaction

clearTransaction

setTransaction

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.

Parameter
Name
Description
Returns
Type
Description
$this

getStatements

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
Type
Description

setStatements

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.

Parameter
Name
Description
Returns
Type
Description
$this

getSeqno

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
Type
Description
int|string

setSeqno

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.

Parameter
Name
Description
var
int|string
Returns
Type
Description
$this

getRequestOptions

Common options for this request.

Returns
Type
Description

hasRequestOptions

clearRequestOptions

setRequestOptions

Common options for this request.

Parameter
Name
Description
Returns
Type
Description
$this

getLastStatements

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
Type
Description
bool

setLastStatements

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.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: