sqlalchemy.orm.session.SessionTransaction

class documentation

class SessionTransaction(_StateChange, TransactionalContext): (source)

A :class:`.Session`-level transaction. :class:`.SessionTransaction` is produced from the :meth:`_orm.Session.begin` and :meth:`_orm.Session.begin_nested` methods. It's largely an internal object that in modern use provides a context manager for session transactions. Documentation on interacting with :class:`_orm.SessionTransaction` is at: :ref:`unitofwork_transaction`. .. versionchanged:: 1.4 The scoping and API methods to work with the :class:`_orm.SessionTransaction` object directly have been simplified. .. seealso:: :ref:`unitofwork_transaction` :meth:`.Session.begin` :meth:`.Session.begin_nested` :meth:`.Session.rollback` :meth:`.Session.commit` :meth:`.Session.in_transaction` :meth:`.Session.in_nested_transaction` :meth:`.Session.get_transaction` :meth:`.Session.get_nested_transaction`

Method	`__init__`	Undocumented
Method	`close`	Undocumented
Method	`commit`	Undocumented
Method	`connection`	Undocumented
Method	`prepare`	Undocumented
Method	`rollback`	Undocumented
Instance Variable	`nested`	Indicates if this is a nested, or SAVEPOINT, transaction.
Instance Variable	`origin`	Origin of this :class:`_orm.SessionTransaction`.
Instance Variable	`session`	Undocumented
Property	`is_active`	Undocumented
Property	`parent`	The parent :class:`.SessionTransaction` of this :class:`.SessionTransaction`.
Method	`_begin`	Undocumented
Method	`_connection_for_bind`	Undocumented
Method	`_get_subject`	Undocumented
Method	`_iterate_self_and_parents`	Undocumented
Method	`_prepare_impl`	Undocumented
Method	`_raise_for_prerequisite_state`	Undocumented
Method	`_remove_snapshot`	Remove the restoration state taken before a transaction began.
Method	`_restore_snapshot`	Restore the restoration state taken before a transaction began.
Method	`_rollback_can_be_called`	indicates the object is in a state that is known to be acceptable for rollback() to be called.
Method	`_take_snapshot`	Undocumented
Method	`_transaction_is_active`	Undocumented
Method	`_transaction_is_closed`	Undocumented
Class Variable	`_rollback_exception`	Undocumented
Instance Variable	`_connections`	Undocumented
Instance Variable	`_deleted`	Undocumented
Instance Variable	`_dirty`	Undocumented
Instance Variable	`_key_switches`	Undocumented
Instance Variable	`_new`	Undocumented
Instance Variable	`_parent`	Undocumented
Instance Variable	`_previous_nested_transaction`	Undocumented
Instance Variable	`_state`	Undocumented
Property	`_is_transaction_boundary`	Undocumented

Inherited from _StateChange:

Class Method	`declare_states`	Method decorator declaring valid states.
Method	`_expect_state`	called within a method that changes states.
Class Variable	`_current_fn`	Undocumented
Instance Variable	`_next_state`	Undocumented

Inherited from TransactionalContext (via _StateChange):

Method	`__enter__`	Undocumented
Method	`__exit__`	Undocumented
Class Variable	`__slots__`	Undocumented
Class Method	`_trans_ctx_check`	Undocumented
Instance Variable	`_outer_trans_ctx`	Undocumented
Instance Variable	`_trans_subject`	Undocumented

def __init__(self, session: Session, origin: SessionTransactionOrigin, parent: Optional[SessionTransaction] = None): (source) ¶

Undocumented

@_StateChange.declare_states(_StateChangeStates.ANY, SessionTransactionState.CLOSED)
def close(self, invalidate: bool = False): (source) ¶

overrides sqlalchemy.engine.util.TransactionalContext.close

Undocumented

@_StateChange.declare_states((SessionTransactionState.ACTIVE, SessionTransactionState.PREPARED), SessionTransactionState.CLOSED)
def commit(self, _to_root: bool = False): (source) ¶

overrides sqlalchemy.engine.util.TransactionalContext.commit

Undocumented

@_StateChange.declare_states((SessionTransactionState.ACTIVE), _StateChangeStates.NO_CHANGE)
def connection(self, bindkey: Optional[Mapper[Any]], execution_options: Optional[_ExecuteOptions] = None, **kwargs: Any) -> Connection: (source) ¶

Undocumented

def prepare(self): (source) ¶

Undocumented

@_StateChange.declare_states((SessionTransactionState.ACTIVE, SessionTransactionState.DEACTIVE, SessionTransactionState.PREPARED), SessionTransactionState.CLOSED)
def rollback(self, _capture_exception: bool = False, _to_root: bool = False): (source) ¶

overrides sqlalchemy.engine.util.TransactionalContext.rollback

Undocumented

nested = (source) ¶

Indicates if this is a nested, or SAVEPOINT, transaction. When :attr:`.SessionTransaction.nested` is True, it is expected that :attr:`.SessionTransaction.parent` will be present as well, linking to the enclosing :class:`.SessionTransaction`. .. seealso:: :attr:`.SessionTransaction.origin`

origin = (source) ¶

Origin of this :class:`_orm.SessionTransaction`. Refers to a :class:`.SessionTransactionOrigin` instance which is an enumeration indicating the source event that led to constructing this :class:`_orm.SessionTransaction`. .. versionadded:: 2.0

session = (source) ¶

Undocumented

@property
is_active: bool = (source) ¶

Undocumented

@property
parent: Optional[SessionTransaction] = (source) ¶

The parent :class:`.SessionTransaction` of this :class:`.SessionTransaction`. If this attribute is ``None``, indicates this :class:`.SessionTransaction` is at the top of the stack, and corresponds to a real "COMMIT"/"ROLLBACK" block. If non-``None``, then this is either a "subtransaction" (an internal marker object used by the flush process) or a "nested" / SAVEPOINT transaction. If the :attr:`.SessionTransaction.nested` attribute is ``True``, then this is a SAVEPOINT, and if ``False``, indicates this a subtransaction. .. versionadded:: 1.0.16 - use ._parent for previous versions

@_StateChange.declare_states((SessionTransactionState.ACTIVE), _StateChangeStates.NO_CHANGE)
def _begin(self, nested: bool = False) -> SessionTransaction: (source) ¶

Undocumented

@_StateChange.declare_states((SessionTransactionState.ACTIVE), _StateChangeStates.NO_CHANGE)
def _connection_for_bind(self, bind: _SessionBind, execution_options: Optional[_ExecuteOptions]) -> Connection: (source) ¶

Undocumented

def _get_subject(self) -> Session: (source) ¶

overrides sqlalchemy.engine.util.TransactionalContext._get_subject

Undocumented

def _iterate_self_and_parents(self, upto: Optional[SessionTransaction] = None) -> Iterable[SessionTransaction]: (source) ¶

Undocumented

@_StateChange.declare_states((SessionTransactionState.ACTIVE), SessionTransactionState.PREPARED)
def _prepare_impl(self): (source) ¶

Undocumented

def _raise_for_prerequisite_state(self, operation_name: str, state: _StateChangeState) -> NoReturn: (source) ¶

overrides sqlalchemy.orm.state_changes._StateChange._raise_for_prerequisite_state

Undocumented

def _remove_snapshot(self): (source) ¶

Remove the restoration state taken before a transaction began. Corresponds to a commit.

def _restore_snapshot(self, dirty_only: bool = False): (source) ¶

Restore the restoration state taken before a transaction began. Corresponds to a rollback.

def _rollback_can_be_called(self) -> bool: (source) ¶

overrides sqlalchemy.engine.util.TransactionalContext._rollback_can_be_called

indicates the object is in a state that is known to be acceptable for rollback() to be called. This does not necessarily mean rollback() will succeed or not raise an error, just that there is currently no state detected that indicates rollback() would fail or emit warnings. It also does not mean that there's a transaction in progress, as it is usually safe to call rollback() even if no transaction is present. .. versionadded:: 1.4.28

def _take_snapshot(self): (source) ¶

Undocumented

def _transaction_is_active(self) -> bool: (source) ¶

overrides sqlalchemy.engine.util.TransactionalContext._transaction_is_active

Undocumented

def _transaction_is_closed(self) -> bool: (source) ¶

overrides sqlalchemy.engine.util.TransactionalContext._transaction_is_closed

Undocumented

_rollback_exception: Optional[BaseException] = (source) ¶

Undocumented

_connections: dict = (source) ¶

Undocumented