Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A Redis cache backend for django
branch: master
Failed to load latest commit information.
redis_cache Adds custom 'has_key' implementation using redis's 'exists' command.
tests Adds custom 'has_key' implementation using redis's 'exists' command.
.gitignore
AUTHORS.rst Adds Markus Kaiserswerth to the authors file.
LICENSE Updating copyright date.
MANIFEST.in Added manifest template to make sure we ship all files with a source …
README.rst Bump to version 0.13.0.
setup.py Bump to version 0.13.0.
sockettests.py Added support for unix domain sockets and custom parsers.
tcptests.py Allows user to define the kwargs to initialize the connection pool cl…

README.rst

Redis Django Cache Backend

A cache backend for Django using the Redis datastructure server.

Changelog

0.13.0

  • Adds custom has_key implementation that uses Redis's exists command.

    This will speed has_key up drastically if the key under question is extremely large.

0.12.0

  • Keys can now be kept alive indefinitely by setting the timeout to None,

    e.g. cache.set('key', 'value', timeout=None)

  • Adds ttl method to the cache. cache.ttl(key) will return the number of

    seconds before it expires or None if the key is not volitile.

0.11.1

  • Allows user to specify the connection pool class kwargs, e.g. timeout,

    max_connections, etc.

0.11.0

  • Adds support for specifying the connection pool class.
  • Adds ability to set the max connections for the connection pool.

0.10.0

Adds Support for Python 3.3 and Django 1.5 and 1.6. Huge thanks to Carl Meyer for his work.

0.9.0

Redis cache now allows you to use either a TCP connection or Unix domain socket to connect to your redis server. Using a TCP connection is useful for when you have your redis server separate from your app server and/or within a distributed environment. Unix domain sockets are useful if you have your redis server and application running on the same machine and want the fastest possible connection.

You can now specify (optionally) what parser class you want redis-py to use when parsing messages from the redis server. redis-py will pick the best parser for you implicitly, but using the PARSER_CLASS setting gives you control and the option to roll your own parser class if you are so bold.

Notes

This cache backend requires the redis-py Python client library for communicating with the Redis server.

Redis writes to disk asynchronously so there is a slight chance of losing some data, but for most purposes this is acceptable.

In order to use redis.connection.HiredisParser parser class, you need to pip install hiredis. This is the recommended parser class.

Usage

  1. Run python setup.py install to install, or place redis_cache on your Python path.
  2. Modify your Django settings to use redis_cache :

On Django < 1.3:

CACHE_BACKEND = 'redis_cache.cache://<host>:<port>'

On Django >= 1.3:

# When using TCP connections
CACHES = {
    'default': {
        'BACKEND': 'redis_cache.RedisCache',
        'LOCATION': '<host>:<port>',
        'OPTIONS': {
            'DB': 1,
            'PASSWORD': 'yadayada',
            'PARSER_CLASS': 'redis.connection.HiredisParser',
            'CONNECTION_POOL_CLASS': 'redis.BlockingConnectionPool',
            'CONNECTION_POOL_CLASS_KWARGS': {
                'max_connections': 50,
                'timeout': 20,
            }
        },
    },
}

# When using unix domain sockets
# Note: ``LOCATION`` needs to be the same as the ``unixsocket`` setting
# in your redis.conf
CACHES = {
    'default': {
        'BACKEND': 'redis_cache.RedisCache',
        'LOCATION': '/path/to/socket/file',
        'OPTIONS': {
            'DB': 1,
            'PASSWORD': 'yadayada',
            'PARSER_CLASS': 'redis.connection.HiredisParser'
        },
    },
}
Something went wrong with that request. Please try again.