orionis.foundation.config.cache.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.

class documentation

Represent the configuration entity for a Redis cache store.

Method	`__post_init__`	Validate the Redis configuration after initialization.
Method	`__validateDb`	Validate the `db` property.
Method	`__validateDriver`	Validate the `driver` property.
Method	`__validateEndpoint`	Validate the `endpoint` property.
Method	`__validatePassword`	Validate the `password` property.
Method	`__validatePort`	Validate the `port` property.
Instance Variable	`db`	Redis database index. Resolved from the `REDIS_DB` environment variable or defaults to `0`.
Instance Variable	`driver`	The driver type. Defaults to `'redis'`.
Instance Variable	`endpoint`	Redis host address. Resolved from the `REDIS_HOST` environment variable or defaults to `'127.0.0.1'`.
Instance Variable	`password`	Redis password. Resolved from the `REDIS_PASSWORD` environment variable or defaults to `None`.
Instance Variable	`port`	Redis port number. Resolved from the `REDIS_PORT` environment variable or defaults to `6379`.

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

overrides orionis.support.entities.BaseEntity.__post_init__

Validate the Redis 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.

Validate the db property.

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

def __validateDriver(self): (source) ¶

Validate the driver property.

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

def __validateEndpoint(self): (source) ¶

Validate the endpoint property.

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

Raises
`TypeError`	If `endpoint` is neither a string nor `None`.

def __validatePassword(self): (source) ¶

Validate the password property.

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

Raises
`TypeError`	If `password` is neither a string nor `None`.

Validate the port property.

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

Redis database index. Resolved from the REDIS_DB environment variable or defaults to 0.

The driver type. Defaults to 'redis'.

Redis host address. Resolved from the REDIS_HOST environment variable or defaults to '127.0.0.1'.

Redis password. Resolved from the REDIS_PASSWORD environment variable or defaults to None.

Redis port number. Resolved from the REDIS_PORT environment variable or defaults to 6379.