Cloud Spanner V1 Client - Class TransactionOptions (1.106.0)

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

Methods

__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 `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource.
`↳ partitioned_dml`	`TransactionOptions\PartitionedDml` Partitioned DML transaction. Authorization to begin a Partitioned DML transaction requires `spanner.databases.beginPartitionedDmlTransaction` permission on the `session` resource.
`↳ read_only`	`TransactionOptions\PBReadOnly` Transaction does not write. Authorization to begin a read-only transaction requires `spanner.databases.beginReadOnlyTransaction` permission on the `session` resource.
`↳ exclude_txn_from_change_streams`	`bool` 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 to `true`, 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 to `false`, then the updates made within this transaction are recorded in the change stream. When `exclude_txn_from_change_streams` is set to `false` or not set, modifications from this transaction are recorded in all change streams that are tracking columns modified by these transactions. The `exclude_txn_from_change_streams` option can only be specified for read-write or partitioned DML transactions, otherwise the API returns an `INVALID_ARGUMENT` error.
`↳ 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 to true, 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 to false, then the updates made within this transaction are recorded in the change stream. When exclude_txn_from_change_streams is set to false or not set, modifications from this transaction are recorded in all change streams that are tracking columns modified by these transactions. The exclude_txn_from_change_streams option can only be specified for read-write or partitioned DML transactions, otherwise the API returns an INVALID_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 to true, 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 to false, then the updates made within this transaction are recorded in the change stream. When exclude_txn_from_change_streams is set to false or not set, modifications from this transaction are recorded in all change streams that are tracking columns modified by these transactions. The exclude_txn_from_change_streams option can only be specified for read-write or partitioned DML transactions, otherwise the API returns an INVALID_ARGUMENT error.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getIsolationLevel

Isolation level for the transaction.

Returns
Type	Description
`int`	Enum of type IsolationLevel.

setIsolationLevel

Isolation level for the transaction.

Parameter
Name	Description
`var`	`int` Enum of type IsolationLevel.

Returns
Type	Description
`$this`

getMode

Returns
Type	Description
`string`