summaryrefslogtreecommitdiffstats
path: root/modules/prefetch/README.rst
diff options
context:
space:
mode:
authorLukáš Ondráček <lukas.ondracek@nic.cz>2024-05-07 16:06:23 +0200
committerLukáš Ondráček <lukas.ondracek@nic.cz>2024-05-07 16:06:23 +0200
commit3754493f83b41592578417f27483d4ce9c8295bd (patch)
treed7698d6c92b2de34188e4034f191a5f746477a75 /modules/prefetch/README.rst
parentfixup! rrl: truncating answers when close to limit, dropping over limit (diff)
parentMerge remote-tracking branch 'origin/master' into 6.0 (diff)
downloadknot-resolver-3754493f83b41592578417f27483d4ce9c8295bd.tar.xz
knot-resolver-3754493f83b41592578417f27483d4ce9c8295bd.zip
Merge remote-tracking branch 'origin/6.0' into rrl-wip
Diffstat (limited to 'modules/prefetch/README.rst')
-rw-r--r--modules/prefetch/README.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/modules/prefetch/README.rst b/modules/prefetch/README.rst
new file mode 100644
index 00000000..4d5a5e3e
--- /dev/null
+++ b/modules/prefetch/README.rst
@@ -0,0 +1,18 @@
+.. SPDX-License-Identifier: GPL-3.0-or-later
+
+.. _mod-prefetch:
+
+Expiring records
+----------------
+
+The ``prefetch`` module helps to keep the cache hot by prefetching expiring records.
+
+This mechanism is activated when the module is loaded and it is not configurable.
+
+.. code-block:: lua
+
+ modules.load('prefetch')
+
+
+Any time the resolver answers with records that are about to expire, they get refreshed. (see :c:func:`is_expiring`)
+That improves latency for records which get frequently queried, relatively to their TTL.