Skip to content

RedisConnectionParams

faststream.redis.schemas.types.RedisConnectionParams #

Bases: TypedDict

Connection-level parameters.

host instance-attribute #

host: str

Redis host. Extracted from URL if not set. Defaults to EMPTY.

port instance-attribute #

port: str | int

Redis port. Extracted from URL if not set. Defaults to EMPTY.

db instance-attribute #

db: str | int

Redis database number. Defaults to EMPTY.

connection_class instance-attribute #

connection_class: type[Connection]

Connection class. Defaults to EMPTY.

client_name instance-attribute #

client_name: str | None

Redis client name. Defaults to None.

health_check_interval instance-attribute #

health_check_interval: float

Health check interval. Defaults to 0.

max_connections instance-attribute #

max_connections: int | None

Max connections in pool. Defaults to None.

socket_timeout instance-attribute #

socket_timeout: float | None

Socket operation timeout. Defaults to None.

socket_connect_timeout instance-attribute #

socket_connect_timeout: float | None

Socket connection timeout. Defaults to None.

socket_read_size instance-attribute #

socket_read_size: int

Socket read buffer size. Defaults to 65536.

socket_keepalive instance-attribute #

socket_keepalive: bool

Enable TCP keepalive. Defaults to False.

socket_keepalive_options instance-attribute #

socket_keepalive_options: Mapping[int, int | bytes] | None

TCP keepalive options. Defaults to None.

socket_type instance-attribute #

socket_type: int

Socket type. Defaults to 0.

retry instance-attribute #

retry: Retry | None

Retry object. Defaults to None.

retry_on_error instance-attribute #

retry_on_error: list[Any]

List of exceptions for which you need to retry. Defaults to [].

retry_on_timeout instance-attribute #

retry_on_timeout: bool

Retry on timeout. Defaults to False.

encoding instance-attribute #

encoding: str

Encoding for data. Defaults to "utf-8".

encoding_errors instance-attribute #

encoding_errors: str

Encoding error handling. Defaults to "strict".

parser_class instance-attribute #

parser_class: type[BaseParser]

Parser class. Defaults to DefaultParser.

encoder_class instance-attribute #

encoder_class: type[Encoder]

Encoder class. Defaults to Encoder.