orionis.foundation.config.scheduler.Redis

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 Redis(BaseEntity): (source)

View In Hierarchy

Represent the configuration entity for a Redis job store.

Method	`__post_init__`	Validate the Redis job store configuration after initialization.
Method	`__validateDb`	Validate the `db` property.
Method	`__validateDriver`	Validate the `driver` property.
Method	`__validateHost`	Validate the `host` property.
Method	`__validateKey`	Validate the `key` property.
Method	`__validatePort`	Validate the `port` property.
Method	`__validateRunTimesKey`	Validate the `run_times_key` property.
Class Variable	`password`	Undocumented
Instance Variable	`db`	Redis database index. Defaults to `0`.
Instance Variable	`driver`	The driver type. Defaults to `'redis'`.
Instance Variable	`host`	Redis host address. Defaults to `'127.0.0.1'`.
Instance Variable	`key`	Redis key used to store the serialized job definitions. Defaults to `'scheduler:tasks'`.
Instance Variable	`port`	Redis port number. Defaults to `6379`.
Instance Variable	`run_times_key`	Redis key used to store the next-run-time index for scheduled jobs. Defaults to `'scheduler:run_times'`.

Inherited from BaseEntity:

Class Method	`_cachedFieldMetadata`	Retrieve field definitions and normalized types cached by class.
Method	`getFields`	Describe field names, normalized types, defaults, and metadata.
Method	`toDict`	Convert the dataclass instance to a recursively copied dictionary.
Class Variable	`__slots__`	Undocumented

def __post_init__(self): (source) ¶

overrides orionis.support.entities.BaseEntity.__post_init__

Validate the Redis job store configuration after initialization.

Returns
`None`	Validates every field against its declared type hint.

Raises
`TypeError`	If any property does not match its expected type.
`ValueError`	If any property fails its value validation.

def __validateDb(self): (source) ¶

Validate the db property.

Returns
`None`	This method performs validation and returns None.

Raises
`TypeError`	If `db` is not an integer.
`ValueError`	If `db` is negative.

def __validateDriver(self): (source) ¶

Validate the driver property.

Returns
`None`	This method performs validation and returns None.

Raises
`TypeError`	If `driver` is not a string.
`ValueError`	If `driver` is an empty string.

def __validateHost(self): (source) ¶

Validate the host property.

Returns
`None`	This method performs validation and returns None.

Raises
`TypeError`	If `host` is not a string.
`ValueError`	If `host` is an empty string.

def __validateKey(self): (source) ¶

Validate the key property.

Returns
`None`	This method performs validation and returns None.

Raises
`TypeError`	If `key` is not a string.
`ValueError`	If `key` is an empty string.

def __validatePort(self): (source) ¶

Validate the port property.

Returns
`None`	This method performs validation and returns None.

Raises
`TypeError`	If `port` is not an integer.
`ValueError`	If `port` is not between `1` and `65535`.

def __validateRunTimesKey(self): (source) ¶

Validate the run_times_key property.

Returns
`None`	This method performs validation and returns None.

Raises
`TypeError`	If `run_times_key` is not a string.
`ValueError`	If `run_times_key` is an empty string.

password: str | None = (source) ¶

Undocumented

db: int = (source) ¶

Redis database index. Defaults to 0.

driver: str = (source) ¶

The driver type. Defaults to 'redis'.

host: str = (source) ¶

Redis host address. Defaults to '127.0.0.1'.

key: str = (source) ¶

Redis key used to store the serialized job definitions. Defaults to 'scheduler:tasks'.

port: int = (source) ¶

Redis port number. Defaults to 6379.

run_times_key: str = (source) ¶

Redis key used to store the next-run-time index for scheduled jobs. Defaults to 'scheduler:run_times'.