From 02a93e7ef9612788081ef07ea1bbd0a8cc99ae99 Mon Sep 17 00:00:00 2001 From: Michael Paquier Date: Mon, 10 May 2021 09:30:35 +0900 Subject: [PATCH] doc: Fix some gaps with the documentation related to LZ4 The upstream project is officially named "LZ4", and the documentation was confused with the option value that can be used with DDLs supporting this option, and the project name. Documentation related to the configure option --with-lz4 was missing, so add something for that. Author: Dilip Kumar, Michael Paquier Reviewed-by: Justin Pryzby Discussion: https://postgr.es/m/YJaOZQDXBVySq+Cc@paquier.xyz --- doc/src/sgml/catalogs.sgml | 2 +- doc/src/sgml/config.sgml | 6 +++--- doc/src/sgml/installation.sgml | 19 +++++++++++++++++++ 3 files changed, 23 insertions(+), 4 deletions(-) diff --git a/doc/src/sgml/catalogs.sgml b/doc/src/sgml/catalogs.sgml index 29ee9605b61..6d06ad22b92 100644 --- a/doc/src/sgml/catalogs.sgml +++ b/doc/src/sgml/catalogs.sgml @@ -1363,7 +1363,7 @@ The current compression method of the column. If it is an invalid compression method ('\0') then column data will not be compressed. Otherwise, 'p' = pglz compression or - 'l' = lz4 compression. + 'l' = LZ4 compression. diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml index a71c8821f6a..f129a875014 100644 --- a/doc/src/sgml/config.sgml +++ b/doc/src/sgml/config.sgml @@ -8321,9 +8321,9 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv; CREATE TABLE statement can override this default by specifying the COMPRESSION column option. - The supported compression methods are pglz and - (if configured at the time PostgreSQL was - built) lz4. + The supported compression methods are pglz and, + if PostgreSQL was compiled with + --with-lz4, lz4. The default is pglz. diff --git a/doc/src/sgml/installation.sgml b/doc/src/sgml/installation.sgml index 50d9fa20215..3c0aa118c76 100644 --- a/doc/src/sgml/installation.sgml +++ b/doc/src/sgml/installation.sgml @@ -266,6 +266,14 @@ su - postgres + + + You need LZ4, if you want to support + compression of data with this method; see + . + + + To build the PostgreSQL documentation, @@ -966,6 +974,17 @@ build-postgresql: + + + + + Build with LZ4 compression support. + This allows the use of LZ4 for + compression of table data. + + + +