Class tigrbl.session.abc.SessionABC

tigrbl.session.abc.SessionABC

Bases: ABC

Authoritative Tigrbl session interface.

All concrete sessions MUST be natively transactional and implement the methods below. This ABC is intentionally minimal and backend-agnostic.

begin abstractmethod async

begin()

Open a native transaction for this session.

Source code in tigrbl/session/abc.py

@abstractmethod
async def begin(self) -> None:
    """Open a native transaction for this session."""

commit abstractmethod async

commit()

Commit the current transaction.

Source code in tigrbl/session/abc.py

@abstractmethod
async def commit(self) -> None:
    """Commit the current transaction."""

rollback abstractmethod async

rollback()

Rollback the current transaction.

Source code in tigrbl/session/abc.py

@abstractmethod
async def rollback(self) -> None:
    """Rollback the current transaction."""

in_transaction abstractmethod

in_transaction()

Return True iff a transaction is currently open.

Source code in tigrbl/session/abc.py

@abstractmethod
def in_transaction(self) -> bool:
    """Return True iff a transaction is currently open."""

get abstractmethod async

get(model, ident)

Fetch one instance by primary key (model, ident).

Source code in tigrbl/session/abc.py

@abstractmethod
async def get(self, model: type, ident: Any) -> Any | None:
    """Fetch one instance by primary key (model, ident)."""

add abstractmethod

add(obj)

Stage a new/dirty object for persistence.

Source code in tigrbl/session/abc.py

@abstractmethod
def add(self, obj: Any) -> None:
    """Stage a new/dirty object for persistence."""

delete abstractmethod async

delete(obj)

Stage an object for deletion.

Source code in tigrbl/session/abc.py

@abstractmethod
async def delete(self, obj: Any) -> None:
    """Stage an object for deletion."""

flush abstractmethod async

flush()

Flush staged changes to the underlying store (still in TX).

Source code in tigrbl/session/abc.py

@abstractmethod
async def flush(self) -> None:
    """Flush staged changes to the underlying store (still in TX)."""

refresh abstractmethod async

refresh(obj)

Refresh the object from the store (respecting the current TX view).

Source code in tigrbl/session/abc.py

@abstractmethod
async def refresh(self, obj: Any) -> None:
    """Refresh the object from the store (respecting the current TX view)."""

execute abstractmethod async

execute(stmt)

Execute a backend-native statement.

The result (if any) SHOULD provide a minimal facade compatible with: - .scalars().all() - .scalar_one() to ease integration with higher-level helpers.

Source code in tigrbl/session/abc.py

@abstractmethod
async def execute(self, stmt: Any) -> Any:
    """
    Execute a backend-native statement.

    The result (if any) SHOULD provide a minimal facade compatible with:
      - .scalars().all()
      - .scalar_one()
    to ease integration with higher-level helpers.
    """

close abstractmethod async

close()

Release underlying resources (connections, cursors, etc.).

Source code in tigrbl/session/abc.py

@abstractmethod
async def close(self) -> None:
    """Release underlying resources (connections, cursors, etc.)."""

run_sync abstractmethod async

run_sync(fn)

Execute a callback against the underlying native handle.

Presence of this method also acts as the "async session" marker for code paths that need to distinguish sync-vs-async sessions.

Source code in tigrbl/session/abc.py

@abstractmethod
async def run_sync(self, fn: Callable[[Any], Any]) -> Any:
    """
    Execute a callback against the underlying native handle.

    Presence of this method also acts as the "async session" marker for code
    paths that need to distinguish sync-vs-async sessions.
    """