diff options
| author | zedr <rigel.discala@propylon.com> | 2014-02-23 22:58:26 +0000 |
|---|---|---|
| committer | Baptiste Mispelon <bmispelon@gmail.com> | 2014-03-04 21:16:35 +0100 |
| commit | 6fe22b30e007b7ac49eae48a53e7ba0a4ee79a4b (patch) | |
| tree | 38fe1af6a021e4b8a50cc88d2d1975a36ff7042a /docs/topics | |
| parent | 24f0113fb9bc1a47094a12eff2ae78e8f2bcb0fb (diff) | |
Fixed #22085 -- Added a feature for setting non-expiring keys as the default.
This feature allows the default `TIMEOUT` Cache argument to be set to `None`,
so that cache instances can set a non-expiring key as the default,
instead of using the default value of 5 minutes.
Previously, this was possible only by passing `None` as an argument to
the set() method of objects of type `BaseCache` (and subtypes).
Diffstat (limited to 'docs/topics')
| -rw-r--r-- | docs/topics/cache.txt | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/docs/topics/cache.txt b/docs/topics/cache.txt index 97c54918cd..2ebc015c75 100644 --- a/docs/topics/cache.txt +++ b/docs/topics/cache.txt @@ -363,9 +363,14 @@ Each cache backend can be given additional arguments to control caching behavior. These arguments are provided as additional keys in the :setting:`CACHES` setting. Valid arguments are as follows: + * :setting:`TIMEOUT <CACHES-TIMEOUT>`: The default timeout, in - seconds, to use for the cache. This argument defaults to ``300`` - seconds (5 minutes). + seconds, to use for the cache. This argument defaults to ``300`` seconds (5 minutes). + + .. versionadded:: 1.7 + + You can set ``TIMEOUT`` to ``None`` so that, by default, cache keys never + expire. * :setting:`OPTIONS <CACHES-OPTIONS>`: Any options that should be passed to the cache backend. The list of valid options will vary |