minos.common.database.clients.abc

Classes

DatabaseClient

Database Client base class.

DatabaseClientBuilder

Database Client Builder class.
class DatabaseClient[source]

Bases: ABC, BuildableMixin

Database Client base class.

__init__(*args, **kwargs)[source]
async is_valid(**kwargs)[source]

Check if the instance is valid.

Returns

True if it is valid or False otherwise.

Return type

bool

async reset(**kwargs)[source]

Reset the current instance status.

Parameters

kwargs – Additional named parameters.

Returns

This method does not return anything.

Return type

None

async execute(operation)[source]

Execute an operation.

Parameters

operation (DatabaseOperation) – The operation to be executed.

Returns

This method does not return anything.

Return type

None

property lock: Optional[DatabaseLock]

Get the lock.

Returns

A DatabaseLock instance.

async fetch_one()[source]

Fetch one value.

Returns

This method does not return anything.

Return type

Any

fetch_all()[source]

Fetch all values with an asynchronous iterator.

Returns

This method does not return anything.

Return type

AsyncIterator[Any]

classmethod set_factory(base, impl)[source]

Register an operation factory implementation for an operation factory interface.

Parameters
Returns

This method does not return anything.

Return type

None

classmethod get_factory(base)[source]

Get an operation factory implementation for an operation factory interface.

Parameters

base (type[minos.common.database.operations.DatabaseOperationFactory]) – The operation factory interface.

Returns

The operation factory implementation.

Return type

DatabaseOperationFactory

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

classmethod get_builder()

Get the builder class.

Returns

A Builder instance.

Return type

Builder[Ins]

classmethod set_builder(builder)

Set a builder class.

Parameters

builder (Union[Builder[Ins], type[minos.common.builders.Builder[~Ins]]]) – The builder class to be set.

Returns

This method does not return anything.

Return type

None

async setup()

Setup miscellaneous repository things.

Returns

This method does not return anything.

Return type

None

class DatabaseClientBuilder[source]

Bases: Builder[DatabaseClient]

Database Client Builder class.

with_name(name)[source]

Set name.

Parameters

name (str) – The name to be added.

Returns

This method return the builder instance.

Return type

DatabaseClientBuilder

__init__(instance_cls=None, *args, **kwargs)
Parameters

instance_cls (Optional[type[~Instance]]) –

property already_destroyed: bool

Already Destroy getter.

Returns

A boolean value.

property already_setup: bool

Already Setup getter.

Returns

A boolean value.

build()

Build the instance.

Returns

A Instance instance.

Return type

Instance

copy()

Get a copy of the instance.

Returns

A Builder instance.

Parameters

self (type[~B]) –

Return type

B

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

classmethod new()

Get a new instance.

Returns

A Builder instance.

Return type

B

async setup()

Setup miscellaneous repository things.

Returns

This method does not return anything.

Return type

None

with_cls(cls)

Set class to be built.

Parameters

  • cls (type) – The class to be set.

  • self (B) –

Returns

This method return the builder instance.

Return type

B

with_config(config)[source]

Set config.

Parameters

config (Config) – The config to be set.

Returns

This method return the builder instance.

Return type

DatabaseClientBuilder

with_kwargs(kwargs)

Set kwargs.

Parameters

  • kwargs (dict[str, Any]) – The kwargs to be set.

  • self (B) –

Returns

This method return the builder instance.

Return type

B