Reference documentation and code samples for the Cloud Spanner V1 Client class BeginTransactionRequest.
The request for BeginTransaction.
Generated from protobuf message google.spanner.v1.BeginTransactionRequest
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 transaction runs. |
↳ options |
Google\Cloud\Spanner\V1\TransactionOptions
Required. Options for the new transaction. |
↳ request_options |
Google\Cloud\Spanner\V1\RequestOptions
Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct will not do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead. |
↳ mutation_key |
Google\Cloud\Spanner\V1\Mutation
Optional. Required for read-write transactions on a multiplexed session that commit mutations but do not perform any reads or queries. Clients should randomly select one of the mutations from the mutation set and send it as a part of this request. This feature is not yet supported and will result in an UNIMPLEMENTED error. |
getSession
Required. The session in which the transaction runs.
Returns | |
---|---|
Type | Description |
string |
setSession
Required. The session in which the transaction runs.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getOptions
Required. Options for the new transaction.
Returns | |
---|---|
Type | Description |
Google\Cloud\Spanner\V1\TransactionOptions|null |
hasOptions
clearOptions
setOptions
Required. Options for the new transaction.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Spanner\V1\TransactionOptions
|
Returns | |
---|---|
Type | Description |
$this |
getRequestOptions
Common options for this request.
Priority is ignored for this request. Setting the priority in this request_options struct will not do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead.
Returns | |
---|---|
Type | Description |
Google\Cloud\Spanner\V1\RequestOptions|null |
hasRequestOptions
clearRequestOptions
setRequestOptions
Common options for this request.
Priority is ignored for this request. Setting the priority in this request_options struct will not do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Spanner\V1\RequestOptions
|
Returns | |
---|---|
Type | Description |
$this |
getMutationKey
Optional. Required for read-write transactions on a multiplexed session that commit mutations but do not perform any reads or queries. Clients should randomly select one of the mutations from the mutation set and send it as a part of this request.
This feature is not yet supported and will result in an UNIMPLEMENTED error.
Returns | |
---|---|
Type | Description |
Google\Cloud\Spanner\V1\Mutation|null |
hasMutationKey
clearMutationKey
setMutationKey
Optional. Required for read-write transactions on a multiplexed session that commit mutations but do not perform any reads or queries. Clients should randomly select one of the mutations from the mutation set and send it as a part of this request.
This feature is not yet supported and will result in an UNIMPLEMENTED error.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Spanner\V1\Mutation
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameters | |
---|---|
Name | Description |
session |
string
Required. The session in which the transaction runs. Please see Google\Cloud\Spanner\V1\SpannerClient::sessionName() for help formatting this field. |
options |
Google\Cloud\Spanner\V1\TransactionOptions
Required. Options for the new transaction. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Spanner\V1\BeginTransactionRequest |