1
0
mirror of https://github.com/postgres/postgres.git synced 2025-10-18 04:29:09 +03:00

doc: Improve description of wal_compression

The description of this GUC provides a list of the situations where
full-page writes are generated.  However, it is not completely exact,
mentioning only the cases where full_page_writes=on or base backups.  It
is possible to generate full-page writes in more situations than these
two, making the description confusing as it implies that no other cases
exist.

The description is slightly reworded to take into account that other
cases are possible, without mentioning them directly to minimize the
maintenance burden should FPWs be generated in more contexts in the
future.

Author: Jingtang Zhang <mrdrivingduck@gmail.com>
Reviewed-by: Andrey Borodin <x4mmm@yandex-team.ru>
Reviewed-by: Xuneng Zhou <xunengzhou@gmail.com>
Discussion: https://postgr.es/m/CAPsk3_CtAYa_fy4p6=x7qtoutrdKvg1kGk46D5fsE=sMt2546g@mail.gmail.com
Backpatch-through: 13
This commit is contained in:
Michael Paquier
2025-08-21 13:25:58 +09:00
parent 8ed079cad8
commit 3f134ce700

View File

@@ -2981,8 +2981,9 @@ include_dir 'conf.d'
<listitem>
<para>
When this parameter is <literal>on</literal>, the <productname>PostgreSQL</productname>
server compresses a full page image written to WAL when
<xref linkend="guc-full-page-writes"/> is on or during a base backup.
server compresses a full page image written to WAL (e.g. when
<xref linkend="guc-full-page-writes"/> is on, during a base backup,
etc.).
A compressed page image will be decompressed during WAL replay.
The default value is <literal>off</literal>.
Only superusers can change this setting.