Cloud Spanner V1 Client - Class BeginTransactionRequest (1.101.0)

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

hasOptions

clearOptions

setOptions

Required. Options for the new transaction.

Parameter
Name
Description
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

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
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
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
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
Design a Mobile Site
View Site in Mobile | Classic
Share by: