doc: add pg_prewarm example
authorBruce Momjian <[email protected]>
Fri, 8 Jul 2022 22:36:27 +0000 (18:36 -0400)
committerBruce Momjian <[email protected]>
Fri, 8 Jul 2022 22:36:27 +0000 (18:36 -0400)
Discussion: https://postgr.es/m/20220618085541.ezxdaljlpo6x7msc@home-desktop

Author: Dong Wook Lee

Backpatch-through: 11

doc/src/sgml/pgprewarm.sgml

index 4e68812250eefa934c27ed9d8c1c918bca0b77f5..754a21a076ca4e2ecf68273f39aa9c4ccc75ffde 100644 (file)
@@ -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>