Cloud Spanner V1 Client - Class BatchWriteRequest (1.84.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class BatchWriteRequest.

The request for BatchWrite.

Generated from protobuf message google.spanner.v1.BatchWriteRequest

Namespace

Google \ Cloud \ Spanner \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ session string

Required. The session in which the batch request is to be run.
↳ request_options Google\Cloud\Spanner\V1\RequestOptions

Common options for this request.
↳ mutation_groups array<Google\Cloud\Spanner\V1\BatchWriteRequest\MutationGroup>

Required. The groups of mutations to be applied.
↳ exclude_txn_from_change_streams bool

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.

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getRequestOptions

Common options for this request.

Returns
Type Description
Google\Cloud\Spanner\V1\RequestOptions|null

hasRequestOptions

clearRequestOptions

setRequestOptions

Common options for this request.

Parameter
Name Description
var Google\Cloud\Spanner\V1\RequestOptions
Returns
Type Description
$this

getMutationGroups

Required. The groups of mutations to be applied.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setMutationGroups

Required. The groups of mutations to be applied.

Parameter
Name Description
var array<Google\Cloud\Spanner\V1\BatchWriteRequest\MutationGroup>
Returns
Type Description
$this

getExcludeTxnFromChangeStreams

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
Type Description
bool

setExcludeTxnFromChangeStreams

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.
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 see Google\Cloud\Spanner\V1\SpannerClient::sessionName() for help formatting this field.
mutationGroups array<Google\Cloud\Spanner\V1\BatchWriteRequest\MutationGroup>

Required. The groups of mutations to be applied.
Returns
Type Description
Google\Cloud\Spanner\V1\BatchWriteRequest