orionis.database.contracts.IConnectionManager

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.

Explore modules View classes

class documentation

class IConnectionManager(ABC): (source)

Known subclasses: orionis.database.ConnectionManager

View In Hierarchy

Undocumented

Method	`addConnection`	Register or replace a named connection configuration at runtime.
Method	`configFor`	Retrieve the configuration for a named connection.
Method	`connection`	Resolve the connection registered under the given name.
Async Method	`disconnect`	Dispose one or all cached connections.
Method	`getDefaultName`	Return the name of the default connection.
Method	`hasConnection`	Report whether a connection configuration exists.
Method	`setDefaultName`	Change the default connection name.
Class Variable	`__slots__`	Undocumented

@abstractmethod

def addConnection(self, name: str, config: dict[str, Any]): (source) ¶

overridden in orionis.database.ConnectionManager

A live connection built from a previous configuration keeps serving until disconnect is called for that name.

Parameters
name:`str`	Connection name to register.
config:`dict`	Driver configuration for the connection.

Returns
`None`	This method does not return a value.

Raises
`ValueError`	If the name is empty.
`TypeError`	If the configuration is not a mapping.

@abstractmethod

def configFor(self, name: str | None = None) -> dict[str, Any]: (source) ¶

overridden in orionis.database.ConnectionManager

Retrieve the configuration for a named connection.

Parameters
name:`str or None, optional`	Connection name as declared in the database configuration, or `None` for the default connection.

Returns
`dict`	The driver configuration for the connection.

Raises
`ConnectionNotFoundException`	If the connection is not declared in the configuration.

@abstractmethod

def connection(self, name: str | None = None) -> IConnection: (source) ¶

overridden in orionis.database.ConnectionManager

Resolve the connection registered under the given name.

The connection is built on first access and cached for reuse.

Parameters
name:`str or None, optional`	Connection name as declared in the database configuration, or `None` for the default connection.

Returns
`IConnection`	Connection bound to its configuration.

Raises
`ConnectionNotFoundException`	If the connection is not declared in the configuration.

@abstractmethod

async def disconnect(self, name: str | None = None): (source) ¶

overridden in orionis.database.ConnectionManager

Dispose one or all cached connections.

Parameters
name:`str or None, optional`	Connection to dispose, or `None` to dispose every cached connection.

Returns
`None`	This method does not return a value.

@abstractmethod

def getDefaultName(self) -> str: (source) ¶

overridden in orionis.database.ConnectionManager

Return the name of the default connection.

Returns
`str`	Default connection name as configured.

@abstractmethod

def hasConnection(self, name: str) -> bool: (source) ¶

overridden in orionis.database.ConnectionManager

Report whether a connection configuration exists.

Parameters
name:`str`	Connection name to look up.

Returns
`bool`	`True` when the configuration is registered.

@abstractmethod

def setDefaultName(self, name: str): (source) ¶

overridden in orionis.database.ConnectionManager

Change the default connection name.

Parameters
name:`str`	Connection name to use as the default; must already be declared in the configuration.

Returns
`None`	This method does not return a value.

Raises
`ConnectionNotFoundException`	If the connection is not declared in the configuration.

__slots__: tuple = (source) ¶

overridden in orionis.database.ConnectionManager

Undocumented