Writing a Backend¶
What is a backend¶
A backend is simply a store for objects. It needs to support four operations:
- Saving Python objects associated with a key (a key is a string)
- Loading Python objects by their key
- Create a lock (identified by a key)
- Release a lock (identified by a key)
There are a few other operations, like deleting an entry, that are useful, but not strictly necessary.
Backends are identified by a URI type string, generically called
For example, to connect to a redis backend, use
Your backend should support a similar scheme.
How to write a backend¶
You can start with the file
jug/backends/base.py which provides a
template with documentation. Implement the functions in there.
This module details all the operations that are necessary to implement a jug backend.
It can be used as a starting point (template) for writing new backends.