Class CommitRequest (3.51.0)

CommitRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The request for Commit][google.spanner.v1.Spanner.Commit].

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name Description
session str
Required. The session in which the transaction to be committed is running.
transaction_id bytes
Commit a previously-started transaction. This field is a member of oneof_ transaction.
single_use_transaction google.cloud.spanner_v1.types.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][google.spanner.v1.Spanner.BeginTransaction] and Commit][google.spanner.v1.Spanner.Commit] instead. This field is a member of oneof_ transaction.
mutations MutableSequence[google.cloud.spanner_v1.types.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][google.spanner.v1.CommitResponse.commit_stats]. Default value is false.
max_commit_delay google.protobuf.duration_pb2.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.types.RequestOptions
Common options for this request.
precommit_token google.cloud.spanner_v1.types.MultiplexedSessionPrecommitToken
Optional. If the read-write transaction was executed on a multiplexed session, the precommit token with the highest sequence number received in this transaction attempt, should be included here. Failing to do so will result in a FailedPrecondition error. This feature is not yet supported and will result in an UNIMPLEMENTED error.