Cloud Spanner V1 Client - Class BeginTransactionRequest (2.6.0)

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

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.
`↳ routing_hint`	`RoutingHint` Optional. Makes the Spanner requests location-aware if present. It gives the server hints that can be used to route the request to an appropriate server, potentially significantly decreasing latency and improving throughput. To achieve improved performance, most fields must be filled in with accurate values.

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.

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

Parameter
Name	Description
`var`	`Mutation`

Returns
Type	Description
`$this`

getRoutingHint

Optional. Makes the Spanner requests location-aware if present.

It gives the server hints that can be used to route the request to an appropriate server, potentially significantly decreasing latency and improving throughput. To achieve improved performance, most fields must be filled in with accurate values.

Returns
Type	Description
`RoutingHint\|null`

hasRoutingHint

clearRoutingHint

setRoutingHint