Cloud Spanner V1 API - Class Google::Cloud::Spanner::V1::CommitRequest (v0.13.0)

Reference documentation and code samples for the Cloud Spanner V1 API class Google::Cloud::Spanner::V1::CommitRequest.

The request for Commit.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#mutations

def mutations() -> ::Array<::Google::Cloud::Spanner::V1::Mutation>
Returns
  • (::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.

#mutations=

def mutations=(value) -> ::Array<::Google::Cloud::Spanner::V1::Mutation>
Parameter
  • value (::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
  • (::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.

#request_options

def request_options() -> ::Google::Cloud::Spanner::V1::RequestOptions
Returns

#request_options=

def request_options=(value) -> ::Google::Cloud::Spanner::V1::RequestOptions
Parameter
Returns

#return_commit_stats

def return_commit_stats() -> ::Boolean
Returns
  • (::Boolean) — If true, then statistics related to the transaction will be included in the CommitResponse. Default value is false.

#return_commit_stats=

def return_commit_stats=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If true, then statistics related to the transaction will be included in the CommitResponse. Default value is false.
Returns
  • (::Boolean) — If true, then statistics related to the transaction will be included in the CommitResponse. Default value is false.

#session

def session() -> ::String
Returns
  • (::String) — Required. The session in which the transaction to be committed is running.

#session=

def session=(value) -> ::String
Parameter
  • value (::String) — Required. The session in which the transaction to be committed is running.
Returns
  • (::String) — Required. The session in which the transaction to be committed is running.

#single_use_transaction

def single_use_transaction() -> ::Google::Cloud::Spanner::V1::TransactionOptions
Returns
  • (::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.

#single_use_transaction=

def single_use_transaction=(value) -> ::Google::Cloud::Spanner::V1::TransactionOptions
Parameter
  • value (::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.
Returns
  • (::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.

#transaction_id

def transaction_id() -> ::String
Returns
  • (::String) — Commit a previously-started transaction.

#transaction_id=

def transaction_id=(value) -> ::String
Parameter
  • value (::String) — Commit a previously-started transaction.
Returns
  • (::String) — Commit a previously-started transaction.