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,["# Interface BatchWriteRequestOrBuilder (6.98.1)\n\nVersion latestkeyboard_arrow_down\n\n- [6.98.1 (latest)](/java/docs/reference/google-cloud-spanner/latest/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.98.0](/java/docs/reference/google-cloud-spanner/6.98.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.97.1](/java/docs/reference/google-cloud-spanner/6.97.1/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.96.1](/java/docs/reference/google-cloud-spanner/6.96.1/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.95.1](/java/docs/reference/google-cloud-spanner/6.95.1/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.94.0](/java/docs/reference/google-cloud-spanner/6.94.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.93.0](/java/docs/reference/google-cloud-spanner/6.93.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.89.0](/java/docs/reference/google-cloud-spanner/6.89.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.88.0](/java/docs/reference/google-cloud-spanner/6.88.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.87.0](/java/docs/reference/google-cloud-spanner/6.87.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.86.0](/java/docs/reference/google-cloud-spanner/6.86.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.85.0](/java/docs/reference/google-cloud-spanner/6.85.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.83.0](/java/docs/reference/google-cloud-spanner/6.83.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.82.0](/java/docs/reference/google-cloud-spanner/6.82.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.80.1](/java/docs/reference/google-cloud-spanner/6.80.1/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.79.0](/java/docs/reference/google-cloud-spanner/6.79.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.77.0](/java/docs/reference/google-cloud-spanner/6.77.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.74.1](/java/docs/reference/google-cloud-spanner/6.74.1/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.72.0](/java/docs/reference/google-cloud-spanner/6.72.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.71.0](/java/docs/reference/google-cloud-spanner/6.71.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.69.0](/java/docs/reference/google-cloud-spanner/6.69.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.68.0](/java/docs/reference/google-cloud-spanner/6.68.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.66.0](/java/docs/reference/google-cloud-spanner/6.66.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.65.1](/java/docs/reference/google-cloud-spanner/6.65.1/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.62.0](/java/docs/reference/google-cloud-spanner/6.62.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.60.0](/java/docs/reference/google-cloud-spanner/6.60.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.58.0](/java/docs/reference/google-cloud-spanner/6.58.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.57.0](/java/docs/reference/google-cloud-spanner/6.57.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.56.0](/java/docs/reference/google-cloud-spanner/6.56.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.55.0](/java/docs/reference/google-cloud-spanner/6.55.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.54.0](/java/docs/reference/google-cloud-spanner/6.54.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.53.0](/java/docs/reference/google-cloud-spanner/6.53.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.52.1](/java/docs/reference/google-cloud-spanner/6.52.1/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.51.0](/java/docs/reference/google-cloud-spanner/6.51.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.50.1](/java/docs/reference/google-cloud-spanner/6.50.1/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.49.0](/java/docs/reference/google-cloud-spanner/6.49.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.25.1](/java/docs/reference/google-cloud-spanner/6.25.1/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.24.0](/java/docs/reference/google-cloud-spanner/6.24.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.23.4](/java/docs/reference/google-cloud-spanner/6.23.4/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.22.0](/java/docs/reference/google-cloud-spanner/6.22.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.21.2](/java/docs/reference/google-cloud-spanner/6.21.2/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.20.0](/java/docs/reference/google-cloud-spanner/6.20.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.19.1](/java/docs/reference/google-cloud-spanner/6.19.1/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.18.0](/java/docs/reference/google-cloud-spanner/6.18.0/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.17.4](/java/docs/reference/google-cloud-spanner/6.17.4/com.google.spanner.v1.BatchWriteRequestOrBuilder)\n- [6.14.1](/java/docs/reference/google-cloud-spanner/6.14.1/com.google.spanner.v1.BatchWriteRequestOrBuilder) \n\n public interface BatchWriteRequestOrBuilder extends MessageOrBuilder\n\nImplements\n----------\n\n[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)\n\nMethods\n-------\n\n### getExcludeTxnFromChangeStreams()\n\n public abstract boolean getExcludeTxnFromChangeStreams()\n\nOptional. When `exclude_txn_from_change_streams` is set to `true`:\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\n 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`bool exclude_txn_from_change_streams = 5 [(.google.api.field_behavior) = OPTIONAL];\n`\n\n### getMutationGroups(int index)\n\n public abstract BatchWriteRequest.MutationGroup getMutationGroups(int index)\n\nRequired. The groups of mutations to be applied.\n\n`\nrepeated .google.spanner.v1.BatchWriteRequest.MutationGroup mutation_groups = 4 [(.google.api.field_behavior) = REQUIRED];\n`\n\n### getMutationGroupsCount()\n\n public abstract int getMutationGroupsCount()\n\nRequired. The groups of mutations to be applied.\n\n`\nrepeated .google.spanner.v1.BatchWriteRequest.MutationGroup mutation_groups = 4 [(.google.api.field_behavior) = REQUIRED];\n`\n\n### getMutationGroupsList()\n\n public abstract List\u003cBatchWriteRequest.MutationGroup\u003e getMutationGroupsList()\n\nRequired. The groups of mutations to be applied.\n\n`\nrepeated .google.spanner.v1.BatchWriteRequest.MutationGroup mutation_groups = 4 [(.google.api.field_behavior) = REQUIRED];\n`\n\n### getMutationGroupsOrBuilder(int index)\n\n public abstract BatchWriteRequest.MutationGroupOrBuilder getMutationGroupsOrBuilder(int index)\n\nRequired. The groups of mutations to be applied.\n\n`\nrepeated .google.spanner.v1.BatchWriteRequest.MutationGroup mutation_groups = 4 [(.google.api.field_behavior) = REQUIRED];\n`\n\n### getMutationGroupsOrBuilderList()\n\n public abstract List\u003c? extends BatchWriteRequest.MutationGroupOrBuilder\u003e getMutationGroupsOrBuilderList()\n\nRequired. The groups of mutations to be applied.\n\n`\nrepeated .google.spanner.v1.BatchWriteRequest.MutationGroup mutation_groups = 4 [(.google.api.field_behavior) = REQUIRED];\n`\n\n### getRequestOptions()\n\n public abstract RequestOptions getRequestOptions()\n\nCommon options for this request.\n\n`.google.spanner.v1.RequestOptions request_options = 3;`\n\n### getRequestOptionsOrBuilder()\n\n public abstract RequestOptionsOrBuilder getRequestOptionsOrBuilder()\n\nCommon options for this request.\n\n`.google.spanner.v1.RequestOptions request_options = 3;`\n\n### getSession()\n\n public abstract String getSession()\n\nRequired. The session in which the batch request is to be run.\n\n`\nstring session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }\n`\n\n### getSessionBytes()\n\n public abstract ByteString getSessionBytes()\n\nRequired. The session in which the batch request is to be run.\n\n`\nstring session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }\n`\n\n### hasRequestOptions()\n\n public abstract boolean hasRequestOptions()\n\nCommon options for this request.\n\n`.google.spanner.v1.RequestOptions request_options = 3;`"]]
