Commits a transaction. The request includes the mutations to be applied to rows in the database.
sessions.commit
might return an ABORTED
error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If sessions.commit
returns ABORTED
, the caller should re-attempt the transaction from the beginning, re-using the same session.
On very rare occasions, sessions.commit
might return UNKNOWN
. This can happen, for example, if the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost track of the transaction outcome and we recommend that you perform another read from the database to see the state of things as they are now.
HTTP request
POST https://spanner.googleapis.com/v1/{session=projects/*/instances/*/databases/*/sessions/*}:commit
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
session |
Required. The session in which the transaction to be committed is running. Authorization requires the following IAM permission on the specified resource
|
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "mutations": [ { object ( |
Fields | |
---|---|
mutations[] |
The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list. |
returnCommitStats |
If |
maxCommitDelay |
Optional. The amount of latency this request is configured 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 commit delay value between 0 and 500 ms. A duration in seconds with up to nine fractional digits, ending with ' |
requestOptions |
Common options for this request. |
Union field transaction . Required. The transaction in which to commit. transaction can be only one of the following: |
|
transactionId |
sessions.commit a previously-started transaction. A base64-encoded string. |
singleUseTransaction |
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 |
Response body
The response for sessions.commit
.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"commitTimestamp": string,
"commitStats": {
object ( |
Fields | |
---|---|
commitTimestamp |
The Cloud Spanner timestamp at which the transaction committed. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
commitStats |
The statistics about this sessions.commit. Not returned by default. For more information, see |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/spanner.data
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
CommitStats
Additional statistics about a commit.
JSON representation |
---|
{ "mutationCount": string } |
Fields | |
---|---|
mutationCount |
The total number of mutations for the transaction. Knowing the |