Cloud Spanner V1 Client - Class CommitRequest (1.76.1)

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

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

↳ max_commit_delay
Google\Protobuf\Duration

Optional. The amount of latency this request is willing to incur in order to improve throughput. If this field is not set, Spanner assumes requests are relatively latency sensitive and automatically determines an appropriate delay time. You can specify a batching delay value between 0 and 500 ms.

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

Returns
Type
Description
string

setSession

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getTransactionId

Commit a previously-started transaction.

Returns
Type
Description
string

hasTransactionId

setTransactionId

Commit a previously-started transaction.

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.

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.

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.

Returns
Type
Description

setMutations

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

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 .

Returns
Type
Description
bool

setReturnCommitStats

If true , then statistics related to the transaction will be included in the CommitResponse .

Default value is false .

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getMaxCommitDelay

Optional. The amount of latency this request is willing to incur in order to improve throughput. If this field is not set, Spanner assumes requests are relatively latency sensitive and automatically determines an appropriate delay time. You can specify a batching delay value between 0 and 500 ms.

Returns
Type
Description

hasMaxCommitDelay

clearMaxCommitDelay

setMaxCommitDelay

Optional. The amount of latency this request is willing to incur in order to improve throughput. If this field is not set, Spanner assumes requests are relatively latency sensitive and automatically determines an appropriate delay time. You can specify a batching delay value between 0 and 500 ms.

Parameter
Name
Description
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

getTransaction

Returns
Type
Description
string

static::build

Parameters
Name
Description
session
string

Required. The session in which the transaction to be committed is running. Please see Google\Cloud\Spanner\V1\SpannerClient::sessionName() for help formatting this field.

transactionId
string

Commit a previously-started transaction.

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.

Returns
Type
Description

static::buildFromSessionSingleUseTransactionMutations

Parameters
Name
Description
session
string

Required. The session in which the transaction to be committed is running. Please see Google\Cloud\Spanner\V1\SpannerClient::sessionName() for help formatting this field.

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

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