# Google.Cloud.Spanner.Data - Class SpannerTransactionCreationOptions (5.13.0-beta07)

5.13.0-beta07 5.13.0-beta06 5.12.0 (latest) 5.11.0 5.10.0 5.9.0 5.8.0 5.7.0 5.6.0 5.5.0 5.4.0 5.3.0 5.2.0 5.1.0 5.0.0 4.6.0 4.5.0 4.4.0 4.3.0 4.2.0 4.1.0 4.0.0 3.15.1 3.14.0 3.13.0 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0

    public sealed class SpannerTransactionCreationOptions

Reference documentation and code samples for the Google.Cloud.Spanner.Data class SpannerTransactionCreationOptions.

Options that may be provided when creating a [SpannerTransaction](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransaction).
Instances of this class are immutable.

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> SpannerTransactionCreationOptions

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.Spanner.Data](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data)

## Assembly

Google.Cloud.Spanner.Data.dll

## Properties

### ExcludeFromChangeStreams

    public bool ExcludeFromChangeStreams { get; }

Whether changes executed within this transaction are recorded in change streams or not.
This will always be false for read-only transactions.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

**Remarks** A change stream may allow or not transaction exclusion. Setting this value to true will only
have effect on change streams that allow transaction exclusion. That is, if this value is set to true
changes executed withing this transaction will be excluded from change streams that
allow transaction exclusion but will be tracked by change streams that do not explicitly
allow transaction exclusion.

### IsDetached

    public bool IsDetached { get; }

Whether these options should result in a detached transaction or in one that's tracked by a session pool.
This will always be true when [TransactionId](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions#Google_Cloud_Spanner_Data_SpannerTransactionCreationOptions_TransactionId) is set. Otherwise it will be false unless explicitly
set via [WithIsDetached(bool)](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions#Google_Cloud_Spanner_Data_SpannerTransactionCreationOptions_WithIsDetached_System_Boolean_).

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

**Remarks** Resources of transactions that are tracked by a session pool will be returned to the pool once the
transaction is committed or rolled back, for later re-use.
Alternatively, a transaction that will be shared across processes, for instance for partitioned reads,
should be detached so that resources are not returned to a local pool and attempted to be re-used there.

### IsPartitionedDml

    public bool IsPartitionedDml { get; }

Whether the resulting transaction is suitable for executing partioned DML queries.
When this is true, Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions.TransactionMode will always be [ReadWrite](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.TransactionMode#Google_Cloud_Spanner_Data_TransactionMode_ReadWrite).

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### IsSingleUse

    public bool IsSingleUse { get; }

Whether these options should result in a single-use transaction or not.
Only timestamp bound transactions may be single-use.
A read-only transaction of [MinReadTimestamp](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.TimestampBoundMode#Google_Cloud_Spanner_Data_TimestampBoundMode_MinReadTimestamp) or [MaxStaleness](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.TimestampBoundMode#Google_Cloud_Spanner_Data_TimestampBoundMode_MaxStaleness)
is always single-use.
All other transactions are not single-use by default.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### IsolationLevel

    public IsolationLevel IsolationLevel { get; }

Isolation level for a read-write transaction.
This will always be [Unspecified](https://learn.microsoft.com/dotnet/api/system.data.isolationlevel#system-data-isolationlevel-unspecified) for read-only transactions.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.data.isolationlevel` |   |

### PartitionedDml

    public static SpannerTransactionCreationOptions PartitionedDml { get; }

Options that will result in a read-write transaction suitable for executing partioned DML.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions` |   |

### ReadLockMode

    public ReadLockMode ReadLockMode { get; }

Read lock modes for the transaction.
Check Google.Cloud.Spanner.V1.TransactionOptions.Types.ReadWrite.ReadLockMode for enum values and their intended behaviours.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.ReadLockMode` |   |

### ReadOnly

    public static SpannerTransactionCreationOptions ReadOnly { get; }

Options that will result in a read-only transaction bound by [Strong](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.TimestampBound#Google_Cloud_Spanner_Data_TimestampBound_Strong).

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions` |   |

### ReadWrite

    public static SpannerTransactionCreationOptions ReadWrite { get; }

Options that will result in a read-write transaction.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions` |   |

### TimestampBound

    public TimestampBound TimestampBound { get; }

Timestamp bound settings for the transaction. May be null.
When set, the transaction will be read-only.
At most, one of [TimestampBound](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions#Google_Cloud_Spanner_Data_SpannerTransactionCreationOptions_TimestampBound) and [TransactionId](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions#Google_Cloud_Spanner_Data_SpannerTransactionCreationOptions_TransactionId) may be set.
If none of [TimestampBound](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions#Google_Cloud_Spanner_Data_SpannerTransactionCreationOptions_TimestampBound) and [TransactionId](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions#Google_Cloud_Spanner_Data_SpannerTransactionCreationOptions_TransactionId) are set,
the transaction will be a read-write transaction.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.TimestampBound` |   |

### TransactionId

    public TransactionId TransactionId { get; }

The transaction ID of an active read-only transaction to use for the transaction. May be null.
At most, one of [TimestampBound](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions#Google_Cloud_Spanner_Data_SpannerTransactionCreationOptions_TimestampBound) and [TransactionId](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions#Google_Cloud_Spanner_Data_SpannerTransactionCreationOptions_TransactionId) may be set.
If none of [TimestampBound](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions#Google_Cloud_Spanner_Data_SpannerTransactionCreationOptions_TimestampBound) and [TransactionId](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions#Google_Cloud_Spanner_Data_SpannerTransactionCreationOptions_TransactionId) are set,
the transaction will be a read-write transaction.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.TransactionId` |   |

## Methods

### ForTimestampBoundReadOnly(TimestampBound)

    public static SpannerTransactionCreationOptions ForTimestampBoundReadOnly(TimestampBound timestampBound)

Creates transaction options with the given `timestampBound` options.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `timestampBound` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.TimestampBound` The timestamp bound options to be used for the transaction. May be null, this will return [ReadOnly](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions#Google_Cloud_Spanner_Data_SpannerTransactionCreationOptions_ReadOnly). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions` |   |

### FromReadOnlyTransactionId(TransactionId)

    public static SpannerTransactionCreationOptions FromReadOnlyTransactionId(TransactionId transactionId)

Creates transaction options with the given `transactionId`.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `transactionId` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.TransactionId` The transaction ID to use for the transaction. Must not be null. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions` |   |

### WithExcludeFromChangeStreams(bool)

    public SpannerTransactionCreationOptions WithExcludeFromChangeStreams(bool excludeFromChangeStreams)

Returns a new instance identical to this one except for the value of [ExcludeFromChangeStreams](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions#Google_Cloud_Spanner_Data_SpannerTransactionCreationOptions_ExcludeFromChangeStreams).
[ExcludeFromChangeStreams](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions#Google_Cloud_Spanner_Data_SpannerTransactionCreationOptions_ExcludeFromChangeStreams) can only be true for read-write transactions.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `excludeFromChangeStreams` | `https://learn.microsoft.com/dotnet/api/system.boolean` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions` |   |

### WithIsDetached(bool)

    public SpannerTransactionCreationOptions WithIsDetached(bool isDetached)

Returns a new instance identical to this one except for the value of [IsDetached](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions#Google_Cloud_Spanner_Data_SpannerTransactionCreationOptions_IsDetached).
If [TransactionId](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions#Google_Cloud_Spanner_Data_SpannerTransactionCreationOptions_TransactionId) is set, [IsDetached](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions#Google_Cloud_Spanner_Data_SpannerTransactionCreationOptions_IsDetached) cannot be false.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `isDetached` | `https://learn.microsoft.com/dotnet/api/system.boolean` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions` |   |

### WithIsSingleUse(bool)

    public SpannerTransactionCreationOptions WithIsSingleUse(bool isSingleUse)

Returns a new instance identical to this one except for the value of [IsSingleUse](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions#Google_Cloud_Spanner_Data_SpannerTransactionCreationOptions_IsSingleUse).
[IsSingleUse](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions#Google_Cloud_Spanner_Data_SpannerTransactionCreationOptions_IsSingleUse) can only be true for timestamp bound transactions.
If timestamp bounds are of [MinReadTimestamp](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.TimestampBoundMode#Google_Cloud_Spanner_Data_TimestampBoundMode_MinReadTimestamp) or [MaxStaleness](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.TimestampBoundMode#Google_Cloud_Spanner_Data_TimestampBoundMode_MaxStaleness),
[IsSingleUse](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions#Google_Cloud_Spanner_Data_SpannerTransactionCreationOptions_IsSingleUse) cannot be false.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `isSingleUse` | `https://learn.microsoft.com/dotnet/api/system.boolean` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions` |   |

### WithIsolationLevel(IsolationLevel)

    public SpannerTransactionCreationOptions WithIsolationLevel(IsolationLevel isolationLevel)

Returns a new instance identical to this one except for the value of [IsolationLevel](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions#Google_Cloud_Spanner_Data_SpannerTransactionCreationOptions_IsolationLevel).
[IsolationLevel](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions#Google_Cloud_Spanner_Data_SpannerTransactionCreationOptions_IsolationLevel) can only be set for read-write transactions.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `isolationLevel` | `https://learn.microsoft.com/dotnet/api/system.data.isolationlevel` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions` |   |

### WithReadLockMode(ReadLockMode)

    public SpannerTransactionCreationOptions WithReadLockMode(ReadLockMode readLockMode)

Returns a new instance identical to this one except for the value of [ReadLockMode](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions#Google_Cloud_Spanner_Data_SpannerTransactionCreationOptions_ReadLockMode).
[ReadLockMode](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions#Google_Cloud_Spanner_Data_SpannerTransactionCreationOptions_ReadLockMode) can only be set for read-write transactions.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `readLockMode` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.ReadLockMode` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Spanner.Data/latest/Google.Cloud.Spanner.Data.SpannerTransactionCreationOptions` |   |