Cloud Spanner V1 Client - Class BeginTransactionRequest (2.5.1)

2.5.1 (latest) 2.5.0 2.4.1 2.3.0 2.2.0 2.1.0 2.0.1-RC1 1.106.0 1.105.1 1.104.1 1.103.0 1.102.0 1.101.0 1.100.0 1.98.0 1.97.0 1.96.0 1.95.0 1.94.0 1.93.1 1.92.1 1.91.0 1.90.0 1.89.0 1.88.0 1.87.0 1.86.0 1.85.0 1.84.0 1.83.0 1.82.0 1.81.0 1.80.0 1.79.0 1.78.0 1.77.0 1.76.1 1.68.0 1.67.0 1.66.0 1.65.0 1.64.0 1.63.2 1.62.1 1.61.0 1.60.0 1.59.0 1.58.4 1.57.0 1.56.0 1.55.0 1.54.2

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 \ V1

Methods

__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	TransactionOptions Required. Options for the new transaction.
↳ request_options	RequestOptions Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct doesn't 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	Mutation Optional. Required for read-write transactions on a multiplexed session that commit mutations but don't perform any reads or queries. You must randomly select one of the mutations from the mutation set and send it as a part of this request.

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
TransactionOptions|null

hasOptions

clearOptions

setOptions

Required. Options for the new transaction.

Parameter
Name	Description
var	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 doesn't 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
RequestOptions|null

hasRequestOptions

clearRequestOptions

setRequestOptions

Common options for this request.

Priority is ignored for this request. Setting the priority in this request_options struct doesn't 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	RequestOptions

Returns
Type	Description
$this

getMutationKey

Optional. Required for read-write transactions on a multiplexed session that commit mutations but don't perform any reads or queries. You must randomly select one of the mutations from the mutation set and send it as a part of this request.

Returns
Type	Description
Mutation|null

hasMutationKey

clearMutationKey

setMutationKey

Optional. Required for read-write transactions on a multiplexed session that commit mutations but don't perform any reads or queries. You must randomly select one of the mutations from the mutation set and send it as a part of this request.

Parameter
Name	Description
var	Mutation

Returns
Type	Description
$this

static::build

Parameters
Name	Description
session	string Required. The session in which the transaction runs. Please see SpannerClient::sessionName() for help formatting this field.
options	TransactionOptions Required. Options for the new transaction.

Returns
Type	Description
BeginTransactionRequest