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 \ V1Methods
__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. |
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 | |
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 | |