This document describes the current stable version of Celery (5.5). For development docs, go here.
celery.backends.redis
¶
Redis result store backend.
- class celery.backends.redis.RedisBackend(host=None, port=None, db=None, password=None, max_connections=None, url=None, connection_pool=None, **kwargs)[source]¶
Redis task result store.
It makes use of the following commands: GET, MGET, DEL, INCRBY, EXPIRE, SET, SETEX
- property ConnectionPool¶
- class ResultConsumer(*args, **kwargs)¶
- cancel_for(task_id)¶
- consume_from(task_id)¶
- drain_events(timeout=None)¶
- on_after_fork()¶
- on_state_change(meta, message)¶
- on_wait_for_pending(result, **kwargs)¶
- reconnect_on_error()¶
- start(initial_task_id, **kwargs)¶
- stop()¶
- property client¶
- connection_class_ssl¶
alias of
SSLConnection
- exception_safe_to_retry(exc)[source]¶
Check if an exception is safe to retry.
Backends have to overload this method with correct predicates dealing with their exceptions.
By default no exception is safe to retry, it’s up to backend implementation to define which exceptions are safe.
- max_connections = None¶
Maximum number of connections in the pool.
- redis = <module 'redis' from '/home/docs/checkouts/readthedocs.org/user_builds/celery/envs/latest/lib/python3.9/site-packages/redis/__init__.py'>¶
https://pypi.org/project/redis/ client module.
- property retry_policy¶
dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s
(key, value) pairs
- dict(iterable) -> new dictionary initialized as if via:
d = {} for k, v in iterable:
d[k] = v
- dict(**kwargs) -> new dictionary initialized with the name=value pairs
in the keyword argument list. For example: dict(one=1, two=2)
- supports_autoexpire = True¶
If true the backend must automatically expire results. The daily backend_cleanup periodic task won’t be triggered in this case.
- supports_native_join = True¶
If true the backend must implement
get_many()
.
- class celery.backends.redis.SentinelBackend(*args, **kwargs)[source]¶
Redis sentinel task result store.
- as_uri(include_password=False)[source]¶
Return the server addresses as URIs, sanitizing the password or not.
- connection_class_ssl¶
alias of
SentinelManagedSSLConnection
- sentinel = <module 'redis.sentinel' from '/home/docs/checkouts/readthedocs.org/user_builds/celery/envs/latest/lib/python3.9/site-packages/redis/sentinel.py'>¶