This document describes the current stable version of Celery (5.5). For development docs, go here.

celery.backends.consul

Consul result store backend.

  • ConsulBackend implements KeyValueStoreBackend to store results

    in the key-value store of Consul.

class celery.backends.consul.ConsulBackend(*args, **kwargs)[source]

Consul.io K/V store backend for Celery.

client()[source]
consistency = 'consistent'
consul = None
delete(key)[source]
get(key)[source]
mget(keys)[source]
path = None
set(key, value)[source]

Set a key in Consul.

Before creating the key it will create a session inside Consul where it creates a session with a TTL

The key created afterwards will reference to the session’s ID.

If the session expires it will remove the key so that results can auto expire from the K/V store

supports_autoexpire = True

If true the backend must automatically expire results. The daily backend_cleanup periodic task won’t be triggered in this case.