minos.networks.brokers.collections.queues.database.impl

Classes

DatabaseBrokerQueue	Database Broker Queue class.
DatabaseBrokerQueueBuilder	Database Broker Queue Builder class.

class DatabaseBrokerQueue

Bases: BrokerQueue, DatabaseMixin[GenericBrokerQueueDatabaseOperationFactory], Generic[GenericBrokerQueueDatabaseOperationFactory]

Database Broker Queue class.

__init__(*args, retry=None, records=None, database_key=None, **kwargs)

Parameters

• retry (Optional[int]) –

• records (Optional[int]) –

• database_key (Optional[tuple[str]]) –

property retry: int

Get the retry value.

Returns

A int value.

property records: int

Get the records value.

Returns

A int value.

property already_destroyed: bool

Already Destroy getter.

Returns

A boolean value.

property already_setup: bool

Already Setup getter.

Returns

A boolean value.

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_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.

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

Get the database pool.

Returns

A DatabaseClientPool object.

async dequeue()

Dequeue method.

Return type

BrokerMessage

async destroy()

Destroy miscellaneous repository things.

Returns

This method does not return anything.

Return type

None

async enqueue(message)

Enqueue method.

Parameters

message (BrokerMessage) –

Return type

None

async execute_on_database(operation)

Submit an Operation.

Parameters

operation (DatabaseOperation) – The operation to be executed.

Returns

This method does not return anything.

Return type

None

async execute_on_database_and_fetch_all(operation, streaming_mode=None)

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_and_fetch_one(operation)

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

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 DatabaseBrokerQueueBuilder

Bases: Builder

Database Broker Queue Builder class.

__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)

Set config.

Parameters

config (Config) – The config to be set.

Returns

This method return the builder instance.

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