minos.common.database.pools

Classes

DatabaseClientPool	Database Client Pool class.
DatabaseLockPool	Database Lock Pool class.

class DatabaseClientPool

Bases: Pool[DatabaseClient]

Database Client Pool class.

__init__(client_builder, *args, **kwargs)

Parameters

client_builder (DatabaseClientBuilder) –

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

Get the instance’s class.

Returns

A type instance that is subclass of DatabaseClient.

property client_builder: minos.common.database.clients.abc.DatabaseClientBuilder

Get the client builder class.

Returns

A DatabaseClientBuilder instance.

acquire(*args, **kwargs)

Acquire a new instance wrapped on an asynchronous context manager.

Parameters

• args – Additional positional arguments.

• kwargs – Additional named arguments.

Returns

An asynchronous context manager.

Return type

AsyncContextManager[P]

property already_destroyed: bool

Already Destroy getter.

Returns

A boolean value.

property already_setup: bool

Already Setup getter.

Returns

A boolean value.

async close(timeout=None)

Parameters

timeout (Optional[Union[int, float]]) –

Return type

None

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

class DatabaseLockPool

Bases: LockPool, DatabaseClientPool

Database Lock Pool class.

acquire(key, *args, **kwargs)

Acquire a new lock.

Parameters

key (Hashable) – The key to be used for locking.

Returns

A DatabaseLock instance.

Return type

DatabaseLock

__init__(client_builder, *args, **kwargs)

Parameters

client_builder (DatabaseClientBuilder) –

property already_destroyed: bool

Already Destroy getter.

Returns

A boolean value.

property already_setup: bool

Already Setup getter.

Returns

A boolean value.

property client_builder: minos.common.database.clients.abc.DatabaseClientBuilder

Get the client builder class.

Returns

A DatabaseClientBuilder instance.

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

Get the instance’s class.

Returns

A type instance that is subclass of DatabaseClient.

async close(timeout=None)

Parameters

timeout (Optional[Union[int, float]]) –

Return type

None

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