Home Explore Blog CI



postgresql

42th chunk of `doc/src/sgml/protocol.sgml`
b80afe80f1a5eb83d84b2562c86bea3b32d660d3b63f8df80000000100000faa
 <term><literal>CHECKPOINT { 'fast' | 'spread' }</literal></term>
         <listitem>
          <para>
           Sets the type of checkpoint to be performed at the beginning of the
           base backup. The default is <literal>spread</literal>.
          </para>
         </listitem>
        </varlistentry>

        <varlistentry>
         <term><literal>WAL [ <replaceable class="parameter">boolean</replaceable> ]</literal></term>
         <listitem>
          <para>
           If set to true, include the necessary WAL segments in the backup.
           This will include all the files between start and stop backup in the
           <filename>pg_wal</filename> directory of the base directory tar
           file. The default is false.
          </para>
         </listitem>
        </varlistentry>

        <varlistentry>
         <term><literal>WAIT [ <replaceable class="parameter">boolean</replaceable> ]</literal></term>
         <listitem>
          <para>
           If set to true, the backup will wait until the last required WAL
           segment has been archived, or emit a warning if WAL archiving is
           not enabled. If false, the backup will neither wait nor warn,
           leaving the client responsible for ensuring the required log is
           available. The default is true.
          </para>
         </listitem>
        </varlistentry>

        <varlistentry>
         <term><literal>COMPRESSION</literal> <replaceable>'method'</replaceable></term>
         <listitem>
          <para>
           Instructs the server to compress the backup using the specified
           method. Currently, the supported methods are <literal>gzip</literal>,
           <literal>lz4</literal>, and <literal>zstd</literal>.
          </para>
         </listitem>
        </varlistentry>

        <varlistentry>
         <term><literal>COMPRESSION_DETAIL</literal> <replaceable>detail</replaceable></term>
         <listitem>
          <para>
           Specifies details for the chosen compression method. This should only
           be used in conjunction with the <literal>COMPRESSION</literal>
           option.  If the value is an integer, it specifies the compression
           level.  Otherwise, it should be a comma-separated list of items,
           each of the form <replaceable>keyword</replaceable> or
           <replaceable>keyword=value</replaceable>. Currently, the supported
           keywords are <literal>level</literal>, <literal>long</literal> and
           <literal>workers</literal>.
          </para>

          <para>
           The <literal>level</literal> keyword sets the compression level.
           For <literal>gzip</literal> the compression level should be an
           integer between <literal>1</literal> and <literal>9</literal>
           (default <literal>Z_DEFAULT_COMPRESSION</literal> or
           <literal>-1</literal>), for <literal>lz4</literal> an integer
           between 1 and 12 (default <literal>0</literal> for fast compression
           mode), and for <literal>zstd</literal> an integer between
           <literal>ZSTD_minCLevel()</literal> (usually <literal>-131072</literal>)
           and <literal>ZSTD_maxCLevel()</literal> (usually <literal>22</literal>),
           (default <literal>ZSTD_CLEVEL_DEFAULT</literal> or
           <literal>3</literal>).
          </para>

          <para>
           The <literal>long</literal> keyword enables long-distance matching
           mode, for improved compression ratio, at the expense of higher memory
           use.  Long-distance mode is supported only for
           <literal>zstd</literal>.
          </para>

          <para>
           The <literal>workers</literal> keyword sets the number of threads
           that should be used for parallel compression. Parallel compression
           is supported only for <literal>zstd</literal>.
          </para>
         </listitem>
        </varlistentry>

        <varlistentry>
         <term><literal>MAX_RATE</literal>

Title: Additional Base Backup Options
Summary
A list of additional options for customizing the base backup process, including checkpoint type, WAL segment inclusion, waiting for WAL archiving, compression methods, compression details, and rate limiting.