Cloud Spanner V1 API - Class Google::Cloud::Spanner::V1::BatchWriteRequest (v1.2.0)

Version 1.2.0

• 1.5.0 (latest)
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.2
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.2
• 0.21.0
• 0.20.1
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.1
• 0.14.1
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.1
• 0.7.4

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

The request for BatchWrite.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#exclude_txn_from_change_streams

def exclude_txn_from_change_streams() -> ::Boolean

Returns

• (::Boolean) — Optional. When exclude_txn_from_change_streams is set to true:
  • Mutations from all transactions in this batch write operation will not be recorded in change streams with DDL option allow_txn_exclusion=true that are tracking columns modified by these transactions.
  • Mutations from all transactions in this batch write operation will be recorded in change streams with DDL option allow_txn_exclusion=false or not set that are tracking columns modified by these transactions.

  When exclude_txn_from_change_streams is set to false or not set, mutations from all transactions in this batch write operation will be recorded in all change streams that are tracking columns modified by these transactions.

#exclude_txn_from_change_streams=

def exclude_txn_from_change_streams=(value) -> ::Boolean

Parameter

• value (::Boolean) — Optional. When exclude_txn_from_change_streams is set to true:
  • Mutations from all transactions in this batch write operation will not be recorded in change streams with DDL option allow_txn_exclusion=true that are tracking columns modified by these transactions.
  • Mutations from all transactions in this batch write operation will be recorded in change streams with DDL option allow_txn_exclusion=false or not set that are tracking columns modified by these transactions.

  When exclude_txn_from_change_streams is set to false or not set, mutations from all transactions in this batch write operation will be recorded in all change streams that are tracking columns modified by these transactions.

Returns

• (::Boolean) — Optional. When exclude_txn_from_change_streams is set to true:
  • Mutations from all transactions in this batch write operation will not be recorded in change streams with DDL option allow_txn_exclusion=true that are tracking columns modified by these transactions.
  • Mutations from all transactions in this batch write operation will be recorded in change streams with DDL option allow_txn_exclusion=false or not set that are tracking columns modified by these transactions.

  When exclude_txn_from_change_streams is set to false or not set, mutations from all transactions in this batch write operation will be recorded in all change streams that are tracking columns modified by these transactions.

#mutation_groups

def mutation_groups() -> ::Array<::Google::Cloud::Spanner::V1::BatchWriteRequest::MutationGroup>

Returns

• (::Array<::Google::Cloud::Spanner::V1::BatchWriteRequest::MutationGroup>) — Required. The groups of mutations to be applied.

#mutation_groups=

def mutation_groups=(value) -> ::Array<::Google::Cloud::Spanner::V1::BatchWriteRequest::MutationGroup>

Parameter

• value (::Array<::Google::Cloud::Spanner::V1::BatchWriteRequest::MutationGroup>) — Required. The groups of mutations to be applied.

Returns

• (::Array<::Google::Cloud::Spanner::V1::BatchWriteRequest::MutationGroup>) — Required. The groups of mutations to be applied.

#request_options

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

Returns

• (::Google::Cloud::Spanner::V1::RequestOptions) — Common options for this request.

#request_options=

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

Parameter

• value (::Google::Cloud::Spanner::V1::RequestOptions) — Common options for this request.

Returns

• (::Google::Cloud::Spanner::V1::RequestOptions) — Common options for this request.

#session

def session() -> ::String

Returns

• (::String) — Required. The session in which the batch request is to be run.

#session=

def session=(value) -> ::String

Parameter

• value (::String) — Required. The session in which the batch request is to be run.

Returns

• (::String) — Required. The session in which the batch request is to be run.