diff options
| author | Michael Paquier <michael@paquier.xyz> | 2021-05-10 09:30:35 +0900 |
|---|---|---|
| committer | Michael Paquier <michael@paquier.xyz> | 2021-05-10 09:32:56 +0900 |
| commit | 02a93e7ef9612788081ef07ea1bbd0a8cc99ae99 (patch) | |
| tree | c54b842b944ce0a6836e7fb1b8e9d5912367de77 | |
| parent | 8dc3d68cbe676deb5e74d1b1b565f57fffaf107e (diff) | |
| download | postgresql-02a93e7ef9612788081ef07ea1bbd0a8cc99ae99.tar.gz | |
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
| -rw-r--r-- | doc/src/sgml/catalogs.sgml | 2 | ||||
| -rw-r--r-- | doc/src/sgml/config.sgml | 6 | ||||
| -rw-r--r-- | 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 29ee9605b6..6d06ad22b9 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 (<literal>'\0'</literal>) then column data will not be compressed. Otherwise, <literal>'p'</literal> = pglz compression or - <literal>'l'</literal> = lz4 compression. + <literal>'l'</literal> = <productname>LZ4</productname> compression. </para></entry> </row> diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml index a71c8821f6..f129a87501 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; <command>CREATE TABLE</command> statement can override this default by specifying the <literal>COMPRESSION</literal> column option. - The supported compression methods are <literal>pglz</literal> and - (if configured at the time <productname>PostgreSQL</productname> was - built) <literal>lz4</literal>. + The supported compression methods are <literal>pglz</literal> and, + if <productname>PostgreSQL</productname> was compiled with + <literal>--with-lz4</literal>, <literal>lz4</literal>. The default is <literal>pglz</literal>. </para> </listitem> diff --git a/doc/src/sgml/installation.sgml b/doc/src/sgml/installation.sgml index 50d9fa2021..3c0aa118c7 100644 --- a/doc/src/sgml/installation.sgml +++ b/doc/src/sgml/installation.sgml @@ -268,6 +268,14 @@ su - postgres <listitem> <para> + You need <productname>LZ4</productname>, if you want to support + compression of data with this method; see + <xref linkend="guc-default-toast-compression"/>. + </para> + </listitem> + + <listitem> + <para> To build the <productname>PostgreSQL</productname> documentation, there is a separate set of requirements; see <xref linkend="docguide-toolsets"/>. @@ -967,6 +975,17 @@ build-postgresql: </varlistentry> <varlistentry> + <term><option>--with-lz4</option></term> + <listitem> + <para> + Build with <productname>LZ4</productname> compression support. + This allows the use of <productname>LZ4</productname> for + compression of table data. + </para> + </listitem> + </varlistentry> + + <varlistentry> <term><option>--with-ssl=<replaceable>LIBRARY</replaceable></option> <indexterm> <primary>OpenSSL</primary> |