- 1.103.0 (latest)
- 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 TransactionOptions.
Options to use for transactions.
Generated from protobuf message google.spanner.v1.TransactionOptions
Namespace
Google \ Cloud \ Spanner \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ read_write |
TransactionOptions\ReadWrite
Transaction may write. Authorization to begin a read-write transaction requires |
↳ partitioned_dml |
TransactionOptions\PartitionedDml
Partitioned DML transaction. Authorization to begin a Partitioned DML transaction requires |
↳ read_only |
TransactionOptions\PBReadOnly
Transaction does not write. Authorization to begin a read-only transaction requires |
↳ exclude_txn_from_change_streams |
bool
When |
↳ isolation_level |
int
Isolation level for the transaction. |
getReadWrite
Transaction may write.
Authorization to begin a read-write transaction requires
spanner.databases.beginOrRollbackReadWriteTransaction
permission
on the session
resource.
Returns | |
---|---|
Type | Description |
TransactionOptions\ReadWrite|null |
hasReadWrite
setReadWrite
Transaction may write.
Authorization to begin a read-write transaction requires
spanner.databases.beginOrRollbackReadWriteTransaction
permission
on the session
resource.
Parameter | |
---|---|
Name | Description |
var |
TransactionOptions\ReadWrite
|
Returns | |
---|---|
Type | Description |
$this |
getPartitionedDml
Partitioned DML transaction.
Authorization to begin a Partitioned DML transaction requires
spanner.databases.beginPartitionedDmlTransaction
permission
on the session
resource.
Returns | |
---|---|
Type | Description |
TransactionOptions\PartitionedDml|null |
hasPartitionedDml
setPartitionedDml
Partitioned DML transaction.
Authorization to begin a Partitioned DML transaction requires
spanner.databases.beginPartitionedDmlTransaction
permission
on the session
resource.
Parameter | |
---|---|
Name | Description |
var |
TransactionOptions\PartitionedDml
|
Returns | |
---|---|
Type | Description |
$this |
getReadOnly
Transaction does not write.
Authorization to begin a read-only transaction requires
spanner.databases.beginReadOnlyTransaction
permission
on the session
resource.
Returns | |
---|---|
Type | Description |
TransactionOptions\PBReadOnly|null |
hasReadOnly
setReadOnly
Transaction does not write.
Authorization to begin a read-only transaction requires
spanner.databases.beginReadOnlyTransaction
permission
on the session
resource.
Parameter | |
---|---|
Name | Description |
var |
TransactionOptions\PBReadOnly
|
Returns | |
---|---|
Type | Description |
$this |
getExcludeTxnFromChangeStreams
When exclude_txn_from_change_streams
is set to true
, it prevents read
or write transactions from being tracked in change streams.
- If the DDL option
allow_txn_exclusion
is set totrue
, then the updates made within this transaction aren't recorded in the change stream. - If you don't set the DDL option
allow_txn_exclusion
or if it's set tofalse
, then the updates made within this transaction are recorded in the change stream. Whenexclude_txn_from_change_streams
is set tofalse
or not set, modifications from this transaction are recorded in all change streams that are tracking columns modified by these transactions. Theexclude_txn_from_change_streams
option can only be specified for read-write or partitioned DML transactions, otherwise the API returns anINVALID_ARGUMENT
error.
Returns | |
---|---|
Type | Description |
bool |
setExcludeTxnFromChangeStreams
When exclude_txn_from_change_streams
is set to true
, it prevents read
or write transactions from being tracked in change streams.
- If the DDL option
allow_txn_exclusion
is set totrue
, then the updates made within this transaction aren't recorded in the change stream. - If you don't set the DDL option
allow_txn_exclusion
or if it's set tofalse
, then the updates made within this transaction are recorded in the change stream. Whenexclude_txn_from_change_streams
is set tofalse
or not set, modifications from this transaction are recorded in all change streams that are tracking columns modified by these transactions. Theexclude_txn_from_change_streams
option can only be specified for read-write or partitioned DML transactions, otherwise the API returns anINVALID_ARGUMENT
error.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
getIsolationLevel
Isolation level for the transaction.
Returns | |
---|---|
Type | Description |
int |
setIsolationLevel
Isolation level for the transaction.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getMode
Returns | |
---|---|
Type | Description |
string |