minos.common.database.mixins

Classes

DatabaseMixin

Database Mixin class.

class DatabaseMixin[source]

Bases: SetupMixin, Generic[GenericDatabaseOperationFactory]

Database Mixin class.

__init__(database_pool=None, pool_factory=None, database_key=None, operation_factory=None, operation_factory_cls=None, *args, **kwargs)[source]

Parameters

database_pool (Optional[DatabaseClientPool]) –
pool_factory (Optional[PoolFactory]) –
database_key (Optional[tuple[str]]) –
operation_factory (Optional[GenericDatabaseOperationFactory]) –
operation_factory_cls (Optional[type[~GenericDatabaseOperationFactory]]) –

property database_operation_factory: Optional[minos.common.database.mixins.GenericDatabaseOperationFactory]

Get the operation factory if any.

Returns: A OperationFactory if it has been set or None otherwise.

async execute_on_database_and_fetch_one(operation)[source]

Submit an Operation and get the first response.

Parameters: operation (DatabaseOperation) – The operation to be executed.
Returns: This method does not return anything.
Return type: Any

async execute_on_database_and_fetch_all(operation, streaming_mode=None)[source]

Submit an Operation and return an asynchronous iterator.

Parameters

operation (DatabaseOperation) – The operation to be executed.
streaming_mode (Optional[bool]) – If True return the values in streaming directly from the database (keep an open database connection), otherwise preloads the full set of values on memory and then retrieves them.

Returns

This method does not return anything.

Return type

AsyncIterator[tuple]

async execute_on_database(operation)[source]

Submit an Operation.

Parameters: operation (DatabaseOperation) – The operation to be executed.
Returns: This method does not return anything.
Return type: None

property database_client_cls: type[minos.common.database.clients.abc.DatabaseClient]

Get the client’s class.

Returns: A type instance that is subclass of DatabaseClient.

property database_pool: minos.common.database.pools.DatabaseClientPool

Get the database pool.

Returns: A DatabaseClientPool object.

property already_destroyed: bool

Already Destroy getter.

Returns: A boolean value.

property already_setup: bool

Already Setup getter.

Returns: A boolean value.

async destroy()

Destroy miscellaneous repository things.

Returns: This method does not return anything.
Return type: None

classmethod from_config(config=None, **kwargs)

Build a new instance from config.

Parameters

config (Optional[Union[Config, Path]]) – Config instance. If None is provided, default config is chosen.
kwargs – Additional named arguments.

Returns

A instance of the called class.

Return type

S

async setup()

Setup miscellaneous repository things.

Returns: This method does not return anything.
Return type: None