From dab298471ff2f91f33bc25bfb73e435d3ab02148 Mon Sep 17 00:00:00 2001
From: Robert Haas <rhaas@postgresql.org>
Date: Fri, 11 Feb 2022 08:29:38 -0500
Subject: Add suport for server-side LZ4 base backup compression.

LZ4 compression can be a lot faster than gzip compression, so users
may prefer it even if the compression ratio is not as good. We will
want pg_basebackup to support LZ4 compression and decompression on the
client side as well, and there is a pending patch for that, but it's
by a different author, so I am committing this part separately for
that reason.

Jeevan Ladhe, reviewed by Tushar Ahuja and by me.

Discussion: http://postgr.es/m/CANm22Cg9cArXEaYgHVZhCnzPLfqXCZLAzjwTq7Fc0quXRPfbxA@mail.gmail.com
---
 doc/src/sgml/protocol.sgml          |  7 ++++---
 doc/src/sgml/ref/pg_basebackup.sgml | 24 ++++++++++++++----------
 2 files changed, 18 insertions(+), 13 deletions(-)

(limited to 'doc/src')

diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml
index fd03c860bdf..1c5ab008791 100644
--- a/doc/src/sgml/protocol.sgml
+++ b/doc/src/sgml/protocol.sgml
@@ -2724,8 +2724,8 @@ The commands accepted in replication mode are:
         <listitem>
          <para>
           Instructs the server to compress the backup using the specified
-          method. Currently, the only supported method is
-          <literal>gzip</literal>.
+          method. Currently, the supported methods are <literal>gzip</literal>
+          and <literal>lz4</literal>.
          </para>
         </listitem>
        </varlistentry>
@@ -2736,7 +2736,8 @@ The commands accepted in replication mode are:
          <para>
           Specifies the compression level to be used. This should only be
           used in conjunction with the <literal>COMPRESSION</literal> option.
-          The value should be an integer between 1 and 9.
+          For <literal>gzip</literal> the value should be an integer between 1
+          and 9, and for <literal>lz4</literal> it should be between 1 and 12.
          </para>
         </listitem>
        </varlistentry>
diff --git a/doc/src/sgml/ref/pg_basebackup.sgml b/doc/src/sgml/ref/pg_basebackup.sgml
index e7ae29ec3d3..7a1b432eba3 100644
--- a/doc/src/sgml/ref/pg_basebackup.sgml
+++ b/doc/src/sgml/ref/pg_basebackup.sgml
@@ -417,10 +417,13 @@ PostgreSQL documentation
         specify <literal>-Xfetch</literal>.
        </para>
        <para>
-        The compression method can be set to either <literal>gzip</literal>
-        for compression with <application>gzip</application>, or
-        <literal>none</literal> for no compression. A compression level
-        can be optionally specified, by appending the level number after a
+        The compression method can be set to <literal>gzip</literal> for
+        compression with <application>gzip</application>, or
+        <literal>lz4</literal> for compression with
+        <application>lz4</application>, or <literal>none</literal> for no
+        compression. However, <literal>lz4</literal> can be currently only
+        used with <literal>server</literal>. A compression level can be
+        optionally specified, by appending the level number after a
         colon (<literal>:</literal>). If no level is specified, the default
         compression level will be used. If only a level is specified without
         mentioning an algorithm, <literal>gzip</literal> compression will
@@ -428,12 +431,13 @@ PostgreSQL documentation
         used if the level is 0.
        </para>
        <para>
-        When the tar format is used, the suffix <filename>.gz</filename> will
-        automatically be added to all tar filenames. When the plain format is
-        used, client-side compression may not be specified, but it is
-        still possible to request server-side compression. If this is done,
-        the server will compress the backup for transmission, and the
-        client will decompress and extract it.
+        When the tar format is used with <literal>gzip</literal> or
+        <literal>lz4</literal>, the suffix <filename>.gz</filename> or
+        <filename>.lz4</filename> will automatically be added to all tar
+        filenames. When the plain format is used, client-side compression may
+        not be specified, but it is still possible to request server-side
+        compression. If this is done, the server will compress the backup for
+        transmission, and the client will decompress and extract it.
        </para>
       </listitem>
      </varlistentry>
-- 
cgit v1.2.3