Documentation (master)
Extensions
Extensions¶
This section is a list of all the official Orator extensions that provide additional functionalities not bundled in the core package.
Cache¶
Installation¶
pip install orator-cache
Introduction¶
The orator-cache package provides query results caching to Orator.
It uses the Cachy library to ease cache manipulation.
To activate the caching ability you just need to use the provided DatabaseManager class instead of
the default one and passing it a Cache instance:
from orator_cache import DatabaseManager, Cache
stores = {
'stores': {
'redis': {
'driver': 'redis',
'host': 'localhost',
'port': 6379,
'db': 0
},
'memcached': {
'driver' 'memcached',
'servers': [
'127.0.0.1:11211'
]
}
}
}
cache = Cache(stores)
db = DatabaseManager(config, cache=cache)
Note
Since the Cache class is just a subclass of the Cachy CacheManager class. You can refer
to the Cachy documentation to configure the underlying stores.
Warning
Even though, the extension provides a way to cache queries, the invalidation of the caches is the responsability of the developer.
Caching queries¶
You can easily cache the results of a query using the remember or remember_forever methods:
users = db.table('users').remember(10).get()
In this example, the results of the query will be cached for ten minutes. While the results are cached, the query will not be run against the database, and the results will be loaded from the default cache driver.
Note
You can also specify which cache driver to use:
users = db.table('users').cache_driver('redis').remember(10).get()
If you are using a supported cache driver, you can also add tags to the caches:
users = db.table('users').cache_tags(['people', 'authors']).remember(10).get()
