From: Bruce Momjian <bruce@momjian.us>
Date: Fri, 8 Jul 2022 22:36:27 +0000 (-0400)
Subject: doc:  add pg_prewarm example
X-Git-Tag: REL_16_BETA1~2313
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=aa31b29375b9afbe1330d7726855645ff82a2e51;p=thirdparty%2Fpostgresql.git

doc:  add pg_prewarm example

Discussion: https://postgr.es/m/20220618085541.ezxdaljlpo6x7msc@home-desktop

Author: Dong Wook Lee

Backpatch-through: 11
---

diff --git a/doc/src/sgml/pgprewarm.sgml b/doc/src/sgml/pgprewarm.sgml
index 4e68812250e..754a21a076c 100644
--- a/doc/src/sgml/pgprewarm.sgml
+++ b/doc/src/sgml/pgprewarm.sgml
@@ -121,6 +121,19 @@ autoprewarm_dump_now() RETURNS int8
     </listitem>
    </varlistentry>
   </variablelist>
+  <para>
+   These parameters must be set in <filename>postgresql.conf</filename>.
+   Typical usage might be:
+  </para>
+
+<programlisting>
+# postgresql.conf
+shared_preload_libraries = 'pg_prewarm'
+
+pg_prewarm.autoprewarm = true
+pg_prewarm.autoprewarm_interval = 300s
+
+</programlisting>
 
  </sect2>