# Cloud Spanner V1 Client - Class Transaction (2.9.0)

2.9.0 (latest) 2.8.1 2.7.0 2.6.1 2.5.1 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 Transaction.

A transaction.

Generated from protobuf message `google.spanner.v1.Transaction`

## Namespace

Google \\ Cloud \\ Spanner \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ id` | `string` `id` may be used to identify the transaction in subsequent [Read](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.Client.SpannerClient#_Google_Cloud_Spanner_V1_Client_SpannerClient__read__), [ExecuteSql](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.Client.SpannerClient#_Google_Cloud_Spanner_V1_Client_SpannerClient__executeSql__), [Commit](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.Client.SpannerClient#_Google_Cloud_Spanner_V1_Client_SpannerClient__commit__), or [Rollback](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.Client.SpannerClient#_Google_Cloud_Spanner_V1_Client_SpannerClient__rollback__) calls. Single-use read-only transactions do not have IDs, because single-use transactions do not support multiple requests. |
| `↳ read_timestamp` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` For snapshot read-only transactions, the read timestamp chosen for the transaction. Not returned by default: see [TransactionOptions.ReadOnly.return_read_timestamp](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.TransactionOptions.PBReadOnly#_Google_Cloud_Spanner_V1_TransactionOptions_PBReadOnly__getReturnReadTimestamp__). A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`. |
| `↳ precommit_token` | `https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.MultiplexedSessionPrecommitToken` A precommit token is included in the response of a BeginTransaction request if the read-write transaction is on a multiplexed session and a mutation_key was specified in the [BeginTransaction](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.BeginTransactionRequest). The precommit token with the highest sequence number from this transaction attempt should be passed to the [Commit](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.Client.SpannerClient#_Google_Cloud_Spanner_V1_Client_SpannerClient__commit__) request for this transaction. |
| `↳ cache_update` | `https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.CacheUpdate` Optional. A cache update expresses a set of changes the client should incorporate into its location cache. The client should discard the changes if they are older than the data it already has. This data can be obtained in response to requests that included a `RoutingHint` field, but may also be obtained by explicit location-fetching RPCs which may be added in the future. |

### getId

`id` may be used to identify the transaction in subsequent
[Read](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.Client.SpannerClient#_Google_Cloud_Spanner_V1_Client_SpannerClient__read__),
[ExecuteSql](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.Client.SpannerClient#_Google_Cloud_Spanner_V1_Client_SpannerClient__executeSql__),
[Commit](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.Client.SpannerClient#_Google_Cloud_Spanner_V1_Client_SpannerClient__commit__), or
[Rollback](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.Client.SpannerClient#_Google_Cloud_Spanner_V1_Client_SpannerClient__rollback__) calls.

Single-use read-only transactions do not have IDs, because
single-use transactions do not support multiple requests.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setId

`id` may be used to identify the transaction in subsequent
[Read](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.Client.SpannerClient#_Google_Cloud_Spanner_V1_Client_SpannerClient__read__),
[ExecuteSql](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.Client.SpannerClient#_Google_Cloud_Spanner_V1_Client_SpannerClient__executeSql__),
[Commit](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.Client.SpannerClient#_Google_Cloud_Spanner_V1_Client_SpannerClient__commit__), or
[Rollback](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.Client.SpannerClient#_Google_Cloud_Spanner_V1_Client_SpannerClient__rollback__) calls.

Single-use read-only transactions do not have IDs, because
single-use transactions do not support multiple requests.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getReadTimestamp

For snapshot read-only transactions, the read timestamp chosen
for the transaction. Not returned by default: see
[TransactionOptions.ReadOnly.return_read_timestamp](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.TransactionOptions.PBReadOnly#_Google_Cloud_Spanner_V1_TransactionOptions_PBReadOnly__getReturnReadTimestamp__).

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
Example: `"2014-10-02T15:01:23.045123456Z"`.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasReadTimestamp

### clearReadTimestamp

### setReadTimestamp

For snapshot read-only transactions, the read timestamp chosen
for the transaction. Not returned by default: see
[TransactionOptions.ReadOnly.return_read_timestamp](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.TransactionOptions.PBReadOnly#_Google_Cloud_Spanner_V1_TransactionOptions_PBReadOnly__getReturnReadTimestamp__).

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
Example: `"2014-10-02T15:01:23.045123456Z"`.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPrecommitToken

A precommit token is included in the response of a BeginTransaction
request if the read-write transaction is on a multiplexed session and
a mutation_key was specified in the
[BeginTransaction](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.BeginTransactionRequest).

The precommit token with the highest sequence number from this transaction
attempt should be passed to the [Commit](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.Client.SpannerClient#_Google_Cloud_Spanner_V1_Client_SpannerClient__commit__)
request for this transaction.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.MultiplexedSessionPrecommitToken|null` |   |

### hasPrecommitToken

### clearPrecommitToken

### setPrecommitToken

A precommit token is included in the response of a BeginTransaction
request if the read-write transaction is on a multiplexed session and
a mutation_key was specified in the
[BeginTransaction](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.BeginTransactionRequest).

The precommit token with the highest sequence number from this transaction
attempt should be passed to the [Commit](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.Client.SpannerClient#_Google_Cloud_Spanner_V1_Client_SpannerClient__commit__)
request for this transaction.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.MultiplexedSessionPrecommitToken` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getCacheUpdate

Optional. A cache update expresses a set of changes the client should
incorporate into its location cache. The client should discard the changes
if they are older than the data it already has. This data can be obtained
in response to requests that included a `RoutingHint` field, but may also
be obtained by explicit location-fetching RPCs which may be added in the
future.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.CacheUpdate|null` |   |

### hasCacheUpdate

### clearCacheUpdate

### setCacheUpdate

Optional. A cache update expresses a set of changes the client should
incorporate into its location cache. The client should discard the changes
if they are older than the data it already has. This data can be obtained
in response to requests that included a `RoutingHint` field, but may also
be obtained by explicit location-fetching RPCs which may be added in the
future.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/V1.CacheUpdate` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |