diff options
Diffstat (limited to 'docs/cache.txt')
| -rw-r--r-- | docs/cache.txt | 38 |
1 files changed, 23 insertions, 15 deletions
diff --git a/docs/cache.txt b/docs/cache.txt index 3318b2ad4a..d22dd91994 100644 --- a/docs/cache.txt +++ b/docs/cache.txt @@ -6,8 +6,8 @@ A fundamental tradeoff in dynamic Web sites is, well, they're dynamic. Each time a user requests a page, the Web server makes all sorts of calculations -- from database queries to template rendering to business logic -- to create the page that your site's visitor sees. This is a lot more expensive, from a -processing-overhead perspective, than your standard read-a-file-off-the-filesystem -server arrangement. +processing-overhead perspective, than your standard +read-a-file-off-the-filesystem server arrangement. For most Web applications, this overhead isn't a big deal. Most Web applications aren't washingtonpost.com or slashdot.org; they're simply small- @@ -159,19 +159,6 @@ cache is multi-process and thread-safe. To use it, set ``CACHE_BACKEND`` to CACHE_BACKEND = 'locmem:///' -Simple caching (for development) --------------------------------- - -A simple, single-process memory cache is available as ``"simple:///"``. This -merely saves cached data in-process, which means it should only be used in -development or testing environments. For example:: - - CACHE_BACKEND = 'simple:///' - -**New in Django development version:** This cache backend is deprecated and -will be removed in a future release. New code should use the ``locmem`` backend -instead. - Dummy caching (for development) ------------------------------- @@ -186,6 +173,27 @@ production environment still will. To activate dummy caching, set CACHE_BACKEND = 'dummy:///' +Using a custom cache backend +---------------------------- + +**New in Django development version** + +While Django includes support for a number of cache backends out-of-the-box, +sometimes you will want to use a customised verison or your own backend. To +use an external cache backend with Django, use a Python import path as the +scheme portion (the part before the initial colon) of the ``CACHE_BACKEND`` +URI, like so:: + + CACHE_BACKEND = 'path.to.backend://' + +If you're building your own backend, you can use the standard cache backends +as reference implementations. You'll find the code in the +``django/core/cache/backends/`` directory of the Django source. + +Note: Without a really compelling reason, like a host that doesn't support the +them, you should stick to the cache backends included with Django. They've +been really well-tested and are quite easy to use. + CACHE_BACKEND arguments ----------------------- |