Skip to main content

Redis Cache Backend for Django

Project description

A simple Redis cache backend for Django

Changelog

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'
        },
    },
}

# 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'
        },
    },
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-redis-cache-0.10.2.tar.gz (6.5 kB view details)

Uploaded Source

File details

Details for the file django-redis-cache-0.10.2.tar.gz.

File metadata

File hashes

Hashes for django-redis-cache-0.10.2.tar.gz
Algorithm Hash digest
SHA256 5d8db55e827fbcb4cfa8503f43228825851f80fb652486f3c086b9725ab94146
MD5 d9cc77705b089e818defb75e1394c423
BLAKE2b-256 445c31989b294652ae11451f8d54dbf79c7b42b0c1aa0f53149ab62d4e0e7695

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page