Cloud Spanner V1 Client - Class CommitRequest (1.54.2)

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

The request for Commit .

Generated from protobuf message google.spanner.v1.CommitRequest

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ session
string

Required. The session in which the transaction to be committed is running.

↳ transaction_id
string

Commit a previously-started transaction.

↳ single_use_transaction
Google\Cloud\Spanner\V1\TransactionOptions

Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the CommitRequest is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead.

↳ mutations
array< Google\Cloud\Spanner\V1\Mutation >

The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.

↳ return_commit_stats
bool

If true , then statistics related to the transaction will be included in the CommitResponse . Default value is false .

↳ request_options
Google\Cloud\Spanner\V1\RequestOptions

Common options for this request.

getSession

Required. The session in which the transaction to be committed is running.

Generated from protobuf field string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
Type
Description
string

setSession

Required. The session in which the transaction to be committed is running.

Generated from protobuf field string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getTransactionId

Commit a previously-started transaction.

Generated from protobuf field bytes transaction_id = 2;

Returns
Type
Description
string

hasTransactionId

setTransactionId

Commit a previously-started transaction.

Generated from protobuf field bytes transaction_id = 2;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getSingleUseTransaction

Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the CommitRequest is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead.

Generated from protobuf field .google.spanner.v1.TransactionOptions single_use_transaction = 3;

Returns
Type
Description

hasSingleUseTransaction

setSingleUseTransaction

Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the CommitRequest is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead.

Generated from protobuf field .google.spanner.v1.TransactionOptions single_use_transaction = 3;

Parameter
Name
Description
Returns
Type
Description
$this

getMutations

The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.

Generated from protobuf field repeated .google.spanner.v1.Mutation mutations = 4;

Returns
Type
Description
Google\Protobuf\Internal\RepeatedField

setMutations

The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.

Generated from protobuf field repeated .google.spanner.v1.Mutation mutations = 4;

Parameter
Name
Description
Returns
Type
Description
$this

getReturnCommitStats

If true , then statistics related to the transaction will be included in the CommitResponse . Default value is false .

Generated from protobuf field bool return_commit_stats = 5;

Returns
Type
Description
bool

setReturnCommitStats

If true , then statistics related to the transaction will be included in the CommitResponse . Default value is false .

Generated from protobuf field bool return_commit_stats = 5;

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getRequestOptions

Common options for this request.

Generated from protobuf field .google.spanner.v1.RequestOptions request_options = 6;

Returns
Type
Description

hasRequestOptions

clearRequestOptions

setRequestOptions

Common options for this request.

Generated from protobuf field .google.spanner.v1.RequestOptions request_options = 6;

Parameter
Name
Description
Returns
Type
Description
$this

getTransaction

Returns
Type
Description
string
Design a Mobile Site
View Site in Mobile | Classic
Share by: