Skip to content

Commit fb68cb1

Browse files
committed
Documentation for clear expired setting
1 parent 97d0c04 commit fb68cb1

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

docs/getting_started/django_settings.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,23 @@ can set this to ``[r".*"]`` which will ignore all querystrings. This is surely
102102
a terrible idea, but it can be done.
103103

104104

105+
.. _WAGTAIL_CACHE_CLEAR_EXPIRED_ON_SET:
106+
107+
WAGTAIL_CACHE_CLEAR_EXPIRED_ON_SET
108+
----------------------------------
109+
110+
.. versionadded::
111+
112+
This setting will clear any expired `KeyringItems` as a new item is set,
113+
and is OFF by default.
114+
115+
If set to `True`, as a cache item is set the manager will delete any expired
116+
items from the database. If there are likely to be many expired items in the
117+
cache, then that might be time-consuming so this setting can be turned off.
118+
You can use the Django management command `wagtail_cache_clear_expired_items`
119+
periodically to clear expired items instead.
120+
121+
105122
.. _WAGTAIL_CACHE_USE_RAW_DELETE:
106123

107124
WAGTAIL_CACHE_USE_RAW_DELETE

0 commit comments

Comments
 (0)