(::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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Cloud Spanner V1 API - Class Google::Cloud::Spanner::V1::BatchWriteRequest (v1.10.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.10.0 (latest)](/ruby/docs/reference/google-cloud-spanner-v1/latest/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [1.9.1](/ruby/docs/reference/google-cloud-spanner-v1/1.9.1/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [1.8.0](/ruby/docs/reference/google-cloud-spanner-v1/1.8.0/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [1.7.1](/ruby/docs/reference/google-cloud-spanner-v1/1.7.1/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [1.6.0](/ruby/docs/reference/google-cloud-spanner-v1/1.6.0/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [1.5.0](/ruby/docs/reference/google-cloud-spanner-v1/1.5.0/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [1.4.0](/ruby/docs/reference/google-cloud-spanner-v1/1.4.0/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [1.3.0](/ruby/docs/reference/google-cloud-spanner-v1/1.3.0/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [1.2.0](/ruby/docs/reference/google-cloud-spanner-v1/1.2.0/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [1.1.0](/ruby/docs/reference/google-cloud-spanner-v1/1.1.0/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [1.0.2](/ruby/docs/reference/google-cloud-spanner-v1/1.0.2/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [0.27.0](/ruby/docs/reference/google-cloud-spanner-v1/0.27.0/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [0.26.0](/ruby/docs/reference/google-cloud-spanner-v1/0.26.0/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [0.25.0](/ruby/docs/reference/google-cloud-spanner-v1/0.25.0/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [0.24.0](/ruby/docs/reference/google-cloud-spanner-v1/0.24.0/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [0.23.0](/ruby/docs/reference/google-cloud-spanner-v1/0.23.0/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [0.22.2](/ruby/docs/reference/google-cloud-spanner-v1/0.22.2/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [0.21.0](/ruby/docs/reference/google-cloud-spanner-v1/0.21.0/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [0.20.1](/ruby/docs/reference/google-cloud-spanner-v1/0.20.1/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [0.19.0](/ruby/docs/reference/google-cloud-spanner-v1/0.19.0/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [0.18.0](/ruby/docs/reference/google-cloud-spanner-v1/0.18.0/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [0.17.0](/ruby/docs/reference/google-cloud-spanner-v1/0.17.0/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [0.16.0](/ruby/docs/reference/google-cloud-spanner-v1/0.16.0/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [0.15.1](/ruby/docs/reference/google-cloud-spanner-v1/0.15.1/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [0.14.1](/ruby/docs/reference/google-cloud-spanner-v1/0.14.1/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [0.13.0](/ruby/docs/reference/google-cloud-spanner-v1/0.13.0/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [0.12.0](/ruby/docs/reference/google-cloud-spanner-v1/0.12.0/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [0.11.0](/ruby/docs/reference/google-cloud-spanner-v1/0.11.0/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [0.10.0](/ruby/docs/reference/google-cloud-spanner-v1/0.10.0/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [0.9.0](/ruby/docs/reference/google-cloud-spanner-v1/0.9.0/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [0.8.1](/ruby/docs/reference/google-cloud-spanner-v1/0.8.1/Google-Cloud-Spanner-V1-BatchWriteRequest)\n- [0.7.4](/ruby/docs/reference/google-cloud-spanner-v1/0.7.4/Google-Cloud-Spanner-V1-BatchWriteRequest) \nReference documentation and code samples for the Cloud Spanner V1 API class Google::Cloud::Spanner::V1::BatchWriteRequest.\n\nThe request for [BatchWrite](/ruby/docs/reference/google-cloud-spanner-v1/latest/Google-Cloud-Spanner-V1-Spanner-Client#Google__Cloud__Spanner__V1__Spanner__Client_batch_write_instance_ \"Google::Cloud::Spanner::V1::Spanner::Client#batch_write (method)\"). \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #exclude_txn_from_change_streams\n\n def exclude_txn_from_change_streams() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Optional. When `exclude_txn_from_change_streams` is set to `true`:\n\n\n - 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.\n - Mutations from all transactions in this batch write operation will be recorded in change streams with DDL option `allow_txn_exclusion=false or\n not set` that are tracking columns modified by these transactions.\n\n When `exclude_txn_from_change_streams` is set to `false` or not set,\n mutations from all transactions in this batch write operation will be\n recorded in all change streams that are tracking columns modified by these\n transactions.\n\n### #exclude_txn_from_change_streams=\n\n def exclude_txn_from_change_streams=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- Optional. When `exclude_txn_from_change_streams` is set to `true`:\n\n\n - 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.\n - Mutations from all transactions in this batch write operation will be recorded in change streams with DDL option `allow_txn_exclusion=false or\n not set` that are tracking columns modified by these transactions.\n\n When `exclude_txn_from_change_streams` is set to `false` or not set,\n mutations from all transactions in this batch write operation will be\n recorded in all change streams that are tracking columns modified by these\ntransactions. \n**Returns**\n\n- (::Boolean) --- Optional. When `exclude_txn_from_change_streams` is set to `true`:\n\n\n - 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.\n - Mutations from all transactions in this batch write operation will be recorded in change streams with DDL option `allow_txn_exclusion=false or\n not set` that are tracking columns modified by these transactions.\n\n When `exclude_txn_from_change_streams` is set to `false` or not set,\n mutations from all transactions in this batch write operation will be\n recorded in all change streams that are tracking columns modified by these\n transactions.\n\n### #mutation_groups\n\n def mutation_groups() -\u003e ::Array\u003c::Google::Cloud::Spanner::V1::BatchWriteRequest::MutationGroup\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::Spanner::V1::BatchWriteRequest::MutationGroup](./Google-Cloud-Spanner-V1-BatchWriteRequest-MutationGroup)\\\u003e) --- Required. The groups of mutations to be applied.\n\n### #mutation_groups=\n\n def mutation_groups=(value) -\u003e ::Array\u003c::Google::Cloud::Spanner::V1::BatchWriteRequest::MutationGroup\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Cloud::Spanner::V1::BatchWriteRequest::MutationGroup](./Google-Cloud-Spanner-V1-BatchWriteRequest-MutationGroup)\\\u003e) --- Required. The groups of mutations to be applied. \n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::Spanner::V1::BatchWriteRequest::MutationGroup](./Google-Cloud-Spanner-V1-BatchWriteRequest-MutationGroup)\\\u003e) --- Required. The groups of mutations to be applied.\n\n### #request_options\n\n def request_options() -\u003e ::Google::Cloud::Spanner::V1::RequestOptions\n\n**Returns**\n\n- ([::Google::Cloud::Spanner::V1::RequestOptions](./Google-Cloud-Spanner-V1-RequestOptions)) --- Common options for this request.\n\n### #request_options=\n\n def request_options=(value) -\u003e ::Google::Cloud::Spanner::V1::RequestOptions\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Spanner::V1::RequestOptions](./Google-Cloud-Spanner-V1-RequestOptions)) --- Common options for this request. \n**Returns**\n\n- ([::Google::Cloud::Spanner::V1::RequestOptions](./Google-Cloud-Spanner-V1-RequestOptions)) --- Common options for this request.\n\n### #session\n\n def session() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The session in which the batch request is to be run.\n\n### #session=\n\n def session=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The session in which the batch request is to be run. \n**Returns**\n\n- (::String) --- Required. The session in which the batch request is to be run."]]
