GitHub

TransactionOptions

API reference for TransactionOptions.

How a driver runs its transactions.

  • acquire_connection(restore): the connection of an outermost transaction; it runs masked, so wrap the wait in restore. Its scope closes with the transaction.
  • begin(conn, statement): start one (statement is the BeginTransaction provided, if any)
  • savepoint / rollback_savepoint / release_savepoint: nested levels (release_savepoint is optional)
  • commit, rollback; on_commit_failure cleans up the connection when COMMIT fails

Attributes

AttributeTypeDescription
transaction_servicetype[TransactionConnection]
span_attributestuple[tuple[str, object], ...]
acquire_connectionCallable[[Restore], Effect[Connection, SqlError, Scope]]
beginCallable[[Connection, str | None], Effect[None, SqlError]]
savepointLevelControl
commitControl
rollbackControl
rollback_savepointLevelControl
release_savepointLevelControl | None = None
on_commit_failureControl | None = None

Functions

__init__

__init__(*, transaction_service, span_attributes, acquire_connection, begin, savepoint, commit, rollback, rollback_savepoint, release_savepoint=None, on_commit_failure=None) -> None
ParameterTypeDescription
transaction_servicetype[TransactionConnection]
span_attributestuple[tuple[str, object], ...]
acquire_connectionCallable[[Restore], Effect[Connection, SqlError, Scope]]
beginCallable[[Connection, str | None], Effect[None, SqlError]]
savepointLevelControl
commitControl
rollbackControl
rollback_savepointLevelControl
release_savepointLevelControl | None = None
on_commit_failureControl | None = None