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 \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ id |
string
|
↳ read_timestamp |
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. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: |
↳ precommit_token |
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. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction. |
↳ cache_update |
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 |
getId
id may be used to identify the transaction in subsequent
Read,
ExecuteSql,
Commit, or
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,
ExecuteSql,
Commit, or
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.
A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
Example: "2014-10-02T15:01:23.045123456Z".
| Returns | |
|---|---|
| Type | Description |
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.
A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
Example: "2014-10-02T15:01:23.045123456Z".
| Parameter | |
|---|---|
| Name | Description |
var |
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.
The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction.
| Returns | |
|---|---|
| Type | Description |
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.
The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction.
| Parameter | |
|---|---|
| Name | Description |
var |
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 |
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 |
CacheUpdate
|
| Returns | |
|---|---|
| Type | Description |
$this |
|