agora inbox for [email protected]  

help / color / mirror / Atom feed

From: Christoph Berg <[email protected]>
Subject: [PATCH v2] Document wal_compression=on
Date: Mon, 29 Jun 2026 11:58:44 +0200

This was not included when lz4 support was added in
4035cd5d4eee4dae797bfc77ab07f8dcd8781b41, but since the value is still
legal and even mentioned in postgresql.conf.sample, it should be
documented.

Update postgresql.conf.sample to say "on" is the same as pglz.
---
 doc/src/sgml/config.sgml                      | 1 +
 src/backend/utils/misc/postgresql.conf.sample | 2 +-
 2 files changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 569fc0e7dba..7bdc85539ce 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -3671,6 +3671,7 @@ include_dir 'conf.d'
         was compiled with <option>--with-lz4</option>) and
         <literal>zstd</literal> (if <productname>PostgreSQL</productname>
         was compiled with <option>--with-zstd</option>).
+        The value <literal>on</literal> is an alias for <literal>pglz</literal>.
         The default value is <literal>off</literal>.
         Only superusers and users with the appropriate <literal>SET</literal>
         privilege can change this setting.
diff --git a/src/backend/utils/misc/postgresql.conf.sample b/src/backend/utils/misc/postgresql.conf.sample
index ac38cddaaf9..86f2e16eba0 100644
--- a/src/backend/utils/misc/postgresql.conf.sample
+++ b/src/backend/utils/misc/postgresql.conf.sample
@@ -262,7 +262,7 @@
 #wal_log_hints = off                    # also do full page writes of non-critical updates
                                         # (change requires restart)
 #wal_compression = off                  # enables compression of full-page writes;
-                                        # off, pglz, lz4, zstd, or on
+                                        # off, pglz (or "on"), lz4, or zstd
 #wal_init_zero = on                     # zero-fill new WAL files
 #wal_recycle = on                       # recycle WAL files
 #wal_buffers = -1                       # min 32kB, -1 sets based on shared_buffers
-- 
2.53.0


--aOuCd2U3waCadW1P--

view thread (69+ messages)  latest in thread

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected]
  Subject: Re: [PATCH v2] Document wal_compression=on
  In-Reply-To: <no-message-id-666811@localhost>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox