Permalink
Browse files

Add documentation for get_caches function

  • Loading branch information...
1 parent 89136b2 commit 2315f1a2ee4e83f7514f20302cdac4782b63751a @clelland clelland committed Sep 20, 2012
Showing with 16 additions and 1 deletion.
  1. +16 −1 docs/topics/cache.txt
View
@@ -673,20 +673,35 @@ 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)
>>> cache.get('my_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.

0 comments on commit 2315f1a

Please sign in to comment.