wal_compression = on: what is the algorithm?

From: PG Doc comments form <noreply(at)postgresql(dot)org>
To: pgsql-docs(at)lists(dot)postgresql(dot)org
Cc: christophe(dot)courtois(at)dalibo(dot)com
Subject: wal_compression = on: what is the algorithm?
Date: 2024-11-15 15:30:59
Message-ID: 173168465965.1547981.1990746268682320616@wrigleys.postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/16/runtime-config-wal.html
Description:

In
https://www.postgresql.org/docs/16/runtime-config-wal.html#GUC-WAL-COMPRESSION,
the option "on" is not described:

“The supported methods are pglz, lz4 (if PostgreSQL was compiled with
--with-lz4) and zstd (if PostgreSQL was compiled with --with-zstd). The
default value is off. ”

"on" was an available option before PG 15, and still seen in some docs.
If I understand the code in src/backend/utils/misc/guc_tables.c, "on" is the
same as "pglz". So I suggest:

“The supported methods are pglz, lz4 (if PostgreSQL was compiled with
--with-lz4) and zstd (if PostgreSQL was compiled with --with-zstd). The
default value is off. The value on is synonym of pglz.”

I didn't see this discussed in
https://www.postgresql.org/message-id/flat/3037310D-ECB7-4BF1-AF20-01C10BB33A33%40yandex-team.ru

Browse pgsql-docs by date

  From Date Subject
Next Message Egor Rogov 2024-11-17 08:28:07 Re: Parallel index build for BRIN
Previous Message Greg Sabino Mullane 2024-11-15 14:13:34 Re: Generated names (suffix) for constraints not described in docs