Optional. Whenexclude_txn_from_change_streamsis set totrue: * * Mutations from all transactions in this batch write operation will not be recorded in change streams with DDL optionallow_txn_exclusion=truethat are tracking columns modified by these transactions. * * Mutations from all transactions in this batch write operation will be recorded in change streams with DDL optionallow_txn_exclusion=false or not setthat are tracking columns modified by these transactions. Whenexclude_txn_from_change_streamsis set tofalseor 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.
getSession
Required. The session in which the batch request is to be run.
Returns
Type
Description
string
setSession
Required. The session in which the batch request is to be run.
Optional. Whenexclude_txn_from_change_streamsis set totrue:
Mutations from all transactions in this batch write operation will not
be recorded in change streams with DDL optionallow_txn_exclusion=truethat are tracking columns modified by these transactions.
Mutations from all transactions in this batch write operation will be
recorded in change streams with DDL optionallow_txn_exclusion=false or
not setthat are tracking columns modified by these transactions.
Whenexclude_txn_from_change_streamsis set tofalseor 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
Type
Description
bool
setExcludeTxnFromChangeStreams
Optional. Whenexclude_txn_from_change_streamsis set totrue:
Mutations from all transactions in this batch write operation will not
be recorded in change streams with DDL optionallow_txn_exclusion=truethat are tracking columns modified by these transactions.
Mutations from all transactions in this batch write operation will be
recorded in change streams with DDL optionallow_txn_exclusion=false or
not setthat are tracking columns modified by these transactions.
Whenexclude_txn_from_change_streamsis set tofalseor 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.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
static::build
Parameters
Name
Description
session
string
Required. The session in which the batch request is to be run. Please seeSpannerClient::sessionName()for help formatting this field.
[[["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-09-04 UTC."],[],[],null,["# Cloud Spanner V1 Client - Class BatchWriteRequest (1.104.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.104.0 (latest)](/php/docs/reference/cloud-spanner/latest/V1.BatchWriteRequest)\n- [1.103.0](/php/docs/reference/cloud-spanner/1.103.0/V1.BatchWriteRequest)\n- [1.102.0](/php/docs/reference/cloud-spanner/1.102.0/V1.BatchWriteRequest)\n- [1.101.0](/php/docs/reference/cloud-spanner/1.101.0/V1.BatchWriteRequest)\n- [1.100.0](/php/docs/reference/cloud-spanner/1.100.0/V1.BatchWriteRequest)\n- [1.98.0](/php/docs/reference/cloud-spanner/1.98.0/V1.BatchWriteRequest)\n- [1.97.0](/php/docs/reference/cloud-spanner/1.97.0/V1.BatchWriteRequest)\n- [1.96.0](/php/docs/reference/cloud-spanner/1.96.0/V1.BatchWriteRequest)\n- [1.95.0](/php/docs/reference/cloud-spanner/1.95.0/V1.BatchWriteRequest)\n- [1.94.0](/php/docs/reference/cloud-spanner/1.94.0/V1.BatchWriteRequest)\n- [1.93.1](/php/docs/reference/cloud-spanner/1.93.1/V1.BatchWriteRequest)\n- [1.92.1](/php/docs/reference/cloud-spanner/1.92.1/V1.BatchWriteRequest)\n- [1.91.0](/php/docs/reference/cloud-spanner/1.91.0/V1.BatchWriteRequest)\n- [1.90.0](/php/docs/reference/cloud-spanner/1.90.0/V1.BatchWriteRequest)\n- [1.89.0](/php/docs/reference/cloud-spanner/1.89.0/V1.BatchWriteRequest)\n- [1.88.0](/php/docs/reference/cloud-spanner/1.88.0/V1.BatchWriteRequest)\n- [1.87.0](/php/docs/reference/cloud-spanner/1.87.0/V1.BatchWriteRequest)\n- [1.86.0](/php/docs/reference/cloud-spanner/1.86.0/V1.BatchWriteRequest)\n- [1.85.0](/php/docs/reference/cloud-spanner/1.85.0/V1.BatchWriteRequest)\n- [1.84.0](/php/docs/reference/cloud-spanner/1.84.0/V1.BatchWriteRequest)\n- [1.83.0](/php/docs/reference/cloud-spanner/1.83.0/V1.BatchWriteRequest)\n- [1.82.0](/php/docs/reference/cloud-spanner/1.82.0/V1.BatchWriteRequest)\n- [1.81.0](/php/docs/reference/cloud-spanner/1.81.0/V1.BatchWriteRequest)\n- [1.80.0](/php/docs/reference/cloud-spanner/1.80.0/V1.BatchWriteRequest)\n- [1.79.0](/php/docs/reference/cloud-spanner/1.79.0/V1.BatchWriteRequest)\n- [1.78.0](/php/docs/reference/cloud-spanner/1.78.0/V1.BatchWriteRequest)\n- [1.77.0](/php/docs/reference/cloud-spanner/1.77.0/V1.BatchWriteRequest)\n- [1.76.1](/php/docs/reference/cloud-spanner/1.76.1/V1.BatchWriteRequest)\n- [1.68.0](/php/docs/reference/cloud-spanner/1.68.0/V1.BatchWriteRequest)\n- [1.67.0](/php/docs/reference/cloud-spanner/1.67.0/V1.BatchWriteRequest)\n- [1.66.0](/php/docs/reference/cloud-spanner/1.66.0/V1.BatchWriteRequest)\n- [1.65.0](/php/docs/reference/cloud-spanner/1.65.0/V1.BatchWriteRequest)\n- [1.64.0](/php/docs/reference/cloud-spanner/1.64.0/V1.BatchWriteRequest)\n- [1.63.2](/php/docs/reference/cloud-spanner/1.63.2/V1.BatchWriteRequest)\n- [1.62.1](/php/docs/reference/cloud-spanner/1.62.1/V1.BatchWriteRequest)\n- [1.61.0](/php/docs/reference/cloud-spanner/1.61.0/V1.BatchWriteRequest)\n- [1.60.0](/php/docs/reference/cloud-spanner/1.60.0/V1.BatchWriteRequest)\n- [1.59.0](/php/docs/reference/cloud-spanner/1.59.0/V1.BatchWriteRequest)\n- [1.58.4](/php/docs/reference/cloud-spanner/1.58.4/V1.BatchWriteRequest)\n- [1.57.0](/php/docs/reference/cloud-spanner/1.57.0/V1.BatchWriteRequest)\n- [1.56.0](/php/docs/reference/cloud-spanner/1.56.0/V1.BatchWriteRequest)\n- [1.55.0](/php/docs/reference/cloud-spanner/1.55.0/V1.BatchWriteRequest)\n- [1.54.2](/php/docs/reference/cloud-spanner/1.54.2/V1.BatchWriteRequest) \nReference documentation and code samples for the Cloud Spanner V1 Client class BatchWriteRequest.\n\nThe request for BatchWrite.\n\nGenerated from protobuf message `google.spanner.v1.BatchWriteRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Spanner \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getSession\n\nRequired. The session in which the batch request is to be run.\n\n### setSession\n\nRequired. The session in which the batch request is to be run.\n\n### getRequestOptions\n\nCommon options for this request.\n\n### hasRequestOptions\n\n### clearRequestOptions\n\n### setRequestOptions\n\nCommon options for this request.\n\n### getMutationGroups\n\nRequired. The groups of mutations to be applied.\n\n### setMutationGroups\n\nRequired. The groups of mutations to be applied.\n\n### 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\n\u003c!-- --\u003e\n\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. 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.\n\n### setExcludeTxnFromChangeStreams\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\n\u003c!-- --\u003e\n\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. 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.\n\n### static::build"]]
