Exceptions

coredis.exceptions

Authentication & Authorization

exception AuthenticationFailureError

Raised when authentication parameters were provided but were invalid

exception AuthenticationRequiredError

Raised when authentication parameters are required but not provided

exception AuthorizationError

Base class for authorization errors

Cluster Errors

exception RedisClusterError

Base exception for the RedisCluster client

exception AskError(resp: str)

Error indicated ASK error received from cluster.

When a slot is set as MIGRATING, the node will accept all queries that pertain to this hash slot, but only if the key in question exists, otherwise the query is forwarded using a -ASK redirection to the node that is target of the migration.

src node: MIGRATING to dst node

get > ASK error ask dst node > ASKING command

dst node: IMPORTING from src node

asking command only affects next command any op will be allowed after asking command

exception ClusterCrossSlotError(message: str | None = None, command: bytes | None = None, keys: tuple[RedisValueT, ...] | None = None)

Raised when keys in request don’t hash to the same slot

exception ClusterDownError(resp: str)

Error indicated CLUSTERDOWN error received from cluster.

By default Redis Cluster nodes stop accepting queries if they detect there is at least a hash slot uncovered (no available node is serving it). This way if the cluster is partially down (for example a range of hash slots are no longer covered) the entire cluster eventually becomes unavailable. It automatically returns available as soon as all the slots are covered again.

exception ClusterError

Cluster errors occurred multiple times, resulting in an exhaustion of the command execution TTL

exception ClusterResponseError

Raised when application logic to combine multi node cluster responses has errors.

exception ClusterRoutingError

Raised when keys in request can’t be routed to destination nodes

exception ClusterTransactionError(msg: str)

exception MovedError(resp: str)

Error indicated MOVED error received from cluster. A request sent to a node that doesn’t serve this key will be replayed with a MOVED error that points to the correct node.

exception TryAgainError

Error indicated TRYAGAIN error received from cluster. Operations on keys that don’t exist or are - during resharding - split between the source and destination nodes, will generate a -TRYAGAIN error.

Sentinel Errors

exception PrimaryNotFoundError

Raised when a primary cannot be located in a sentinel managed redis

exception ReplicaNotFoundError

Raised when a replica cannot be located in a sentinel managed redis

exception StalePrimaryError

Raised when a primary discovered through a sentinel is not a primary as it has been demoted to a replica

exception SentinelError

Scripting Errors

exception NoScriptError

exception FunctionError

Raised for errors relating to redis functions

exception NotBusyError

Raised when script kill or function kill have nothing to terminate

Stream Consumer Errors

exception StreamConsumerInitializationError

Raised when a stream consumer could not be initialized based on the configuration provided

exception StreamDuplicateConsumerGroupError

Raised when and attempt to create a stream consumer group fails because it already exists

General Exceptions

exception BusyLoadingError

exception CommandSyntaxError(arguments: set[str], message: str)

Raised when a redis command is called with an invalid syntax

exception CommandNotSupportedError(cmd: str, current_version: str)

Raised when the target server doesn’t support a command due to version mismatch

exception ConnectionError

Raised when a connection to Redis cannot be established or is lost.

This exception indicates a failure in the underlying network connection, protocol handshake, or connection configuration

exception DataError

exception ExecAbortError

exception InvalidResponse

exception LockError

Errors acquiring or releasing a lock

exception LockAcquisitionError

Errors acquiring a lock

exception LockReleaseError

Errors releasing a lock

exception LockExtensionError

Errors extending a lock

exception NoKeyError

Raised when a key provided in the command is missing

exception PersistenceError(command: bytes, local: int, replicas: int, timeout: int)

Raised when the persistence requirements were not met

exception PubSubError

exception ReadOnlyError

exception RedisError

Base exception from which all other exceptions in coredis derive from.

exception ReplicationError(command: bytes, replicas: int, timeout: int)

Raised when the replication requirements were not met

exception ResponseError

exception UnblockedError

Raised if a blocked client is unblocked forcefully

exception WatchError