Redis

Search…
Redis
Introduction
The Redis Extension provides application caching and key/value store support via Redis.
Documentation References:
​Caching​
API References:
​Cement Redis Extension​
​Redis Library​
Requirements
Redis
Cement 3.0.8+:
pip install redis
Applications using Cement <3.0.8 should continue to include redis in their dependencies.
Configuration
This extension honors the following config settings under a [cache.redis] section in any configuration file:
Setting
Description
expire_time
The default time in seconds to expire items in the cache.  Default: 0 (does not expire)
host
Redis server ip address or hostname
port
Redis server port
db
Redis server database id/namespace
Usage
Example: Using Redis Cache Handler
myapp.py
from cement import App, init_defaults
​
CONFIG = init_defaults('myapp', 'cache.redis')
CONFIG['cache.redis']['expire_time'] = 300 # seconds
CONFIG['cache.redis']['host'] = '127.0.0.1'
CONFIG['cache.redis']['port'] = 6379
CONFIG['cache.redis']['db'] = 0
​
class MyApp(App):
    class Meta:
        label = 'myapp'
        config_defaults = CONFIG
        extensions = ['redis']
        cache_handler = 'redis'
​
with MyApp() as app:
    # Run the app
    app.run()
​
    # Set a cached value
    app.cache.set('my_key', 'my value')
​
    # Get a cached value
    app.cache.get('my_key')
​
    # Delete a cached value
    app.cache.delete('my_key')
​
    # Delete the entire cache
    app.cache.purge()
~/.myapp.conf
[myapp]
​
# set the cache handler to use
cache_handler = redis
​
​
[cache.redis]
​
# time in seconds that an item in the cache will expire
expire_time = 300
​
# Redis server
host = 127.0.0.1
​
# Redis port
port = 6379
​
# Redis database number
db = 0
Scrub
Last modified 1mo ago
Copy link
On this page
Introduction
Requirements
Configuration
Usage