Commit e758ecc6 authored by Tim Graham's avatar Tim Graham
Browse files

Merge pull request #386 from clelland/ticket_15269

Fixed #15269 - Added documentation for get_caches function
parents 837425b4 2315f1a2
Loading
Loading
Loading
Loading
+16 −1
Original line number Diff line number Diff line
@@ -663,12 +663,27 @@ dictionaries, lists of model objects, and so forth. (Most common Python objects
can be pickled; refer to the Python documentation for more information about
pickling.)

Accessing the cache
-------------------

The cache module, ``django.core.cache``, has a ``cache`` object that's
automatically created from the ``'default'`` entry in the :setting:`CACHES`
setting::

    >>> from django.core.cache import cache

If you have multiple caches defined in :setting:`CACHES`, then you can use
:func:`django.core.cache.get_cache` to retrieve a cache object for any key::

    >>> from django.core.cache import get_cache
    >>> cache = get_cache('alternate')

If the named key does not exist, :exc:`InvalidCacheBackendError` will be raised.


Basic usage
-----------

The basic interface is ``set(key, value, timeout)`` and ``get(key)``::

    >>> cache.set('my_key', 'hello, world!', 30)
@@ -676,7 +691,7 @@ The basic interface is ``set(key, value, timeout)`` and ``get(key)``::
    'hello, world!'

The ``timeout`` argument is optional and defaults to the ``timeout``
argument of the ``'default'`` backend in :setting:`CACHES` setting
argument of the appropriate backend in the :setting:`CACHES` setting
(explained above). It's the number of seconds the value should be stored
in the cache.