Google.Cloud.Spanner.Data - Class SpannerTransactionOptions (5.1.0)

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

Options that may be applied to a transaction after creation, usually before committing the transaction or before executing the first transactional statement.

Creates an instance of SpannerTransactionOptions with default values.

Creates an instance of SpannerTransactionOptions with the same values as other.

The priority to use for the Commit() and similar overloads. For command execution priority, use Priority. This value will be ignored by read-only transactions.

The wait time, in seconds, before terminating the attempt to Commit() or Rollback() and generating an error. May be null, in which case, a transaction using these options will default to the commit timeout defined on its connection string. A value of '0' normally indicates that no timeout should be used (wait an infinite amount of time). However, if you specify AllowImmediateTimeouts=true in the connection string, '0' will cause a timeout that expires immediately. This is normally used only for testing purposes.

Specifies how resources are treated when Dispose(bool) is called. Defaults to Default. For a pooled transaction, Default will cause transactional resources to be sent back into a shared pool for re-use. For a detached transaction the default behaviour is to do nothing with transactional resources. If set to CloseResources all transactional resource will be closed. A detached transaction must have one process choose CloseResources to avoid leaks of transactional resources. Changes to this value will be ignored after the transaction has been disposed.

Specifies whether this transaction should request commit statistics from the backend and log these. If unset, the value set on the SpannerConnection of this transaction will be used.

The maximum amount of time the commit may be delayed server side for batching with other commits. The bigger the delay, the better the throughput (QPS), but at the expense of commit latency. If set to Zero, commit batching is disabled. May be null, in which case commits will continue to be batched as they had been before this configuration option was made available to Spanner API consumers. May be set to any value between Zero and 500ms. Cannot be modified after commit or rollback has been called on the transaction.

The transaction tag to use for SpannerTransaction This value will be ignored by read-only transactions. Changes to this value will be ignored by the transaction after it has executed statements.