From ee018de76f07d0e0da433913966708d01476aa48 Mon Sep 17 00:00:00 2001
From: Aleš Mrázek <ales.mrazek@nic.cz>
Date: Wed, 17 Apr 2024 15:55:02 +0200
Subject: modules: prefetch: new module for prefetching expiring records

---
 modules/prefetch/README.rst | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 modules/prefetch/README.rst

(limited to 'modules/prefetch/README.rst')

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.
-- 
cgit v1.2.3