ORIONIS API REFERENCE

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

class documentation

class ThreadedEngine: (source)

Constructor: ThreadedEngine(engine, name)

View In Hierarchy

Expose asynchronous checkouts without claiming a blocking driver is async.

Method __init__ Retain a lazy blocking engine without opening any connections.
Async Method begin Own a checkout and commit or roll back before returning it to the pool.
Async Method connect Open one checkout without blocking the event loop.
Async Method dispose Close idle pooled connections outside the event loop.
Class Variable __slots__ Declare the instance attribute slots reserved by this class.
Instance Variable _name Connection name used in sanitized opening errors.
Instance Variable sync_engine Blocking Core engine backed by the official connector dialect.
def __init__(self, engine: Engine, name: str = 'redshift'): (source)

Retain a lazy blocking engine without opening any connections.

Parameters
engine:sqlalchemy.engine.EngineBlocking Core engine backed by the official connector dialect.
name:str, optionalConnection name used in sanitized opening errors.
Returns
NoneNo return value.

Own a checkout and commit or roll back before returning it to the pool.

Yields
orionis.database.threaded.connection.ThreadedConnectionCheckout with an active root transaction.
async def connect(self) -> ThreadedConnection: (source)

Open one checkout without blocking the event loop.

Returns
orionis.database.threaded.connection.ThreadedConnectionConnection owning a worker until it closes.
Raises
orionis.database.QueryExceptionIf the connector cannot open the connection; driver details are omitted.
async def dispose(self): (source)

Close idle pooled connections outside the event loop.

Returns
NoneNo return value.
__slots__: tuple[str, ...] = (source)

Declare the instance attribute slots reserved by this class.

Connection name used in sanitized opening errors.

sync_engine = (source)

Blocking Core engine backed by the official connector dialect.