Home Explore Blog CI



postgresql

41th chunk of `doc/src/sgml/protocol.sgml`
10072f6ff1617035c14e928ec18b2d6855fbbeb574053d9b0000000100000fa1
 following options are accepted:

       <variablelist>
        <varlistentry>
         <term><literal>LABEL</literal> <replaceable>'label'</replaceable></term>
         <listitem>
          <para>
           Sets the label of the backup. If none is specified, a backup label
           of <literal>base backup</literal> will be used. The quoting rules
           for the label are the same as a standard SQL string with
           <xref linkend="guc-standard-conforming-strings"/> turned on.
          </para>
         </listitem>
        </varlistentry>

        <varlistentry>
         <term><literal>TARGET</literal> <replaceable>'target'</replaceable></term>
         <listitem>
          <para>
           Tells the server where to send the backup.  If the target is
           <literal>client</literal>, which is the default, the backup data is
           sent to the client. If it is <literal>server</literal>, the backup
           data is written to the server at the pathname specified by the
           <literal>TARGET_DETAIL</literal> option. If it is
           <literal>blackhole</literal>, the backup data is not sent
           anywhere; it is simply discarded.
          </para>

          <para>
           The <literal>server</literal> target requires superuser privilege or
           being granted the <literal>pg_write_server_files</literal> role.
          </para>
         </listitem>
        </varlistentry>

        <varlistentry>
         <term><literal>TARGET_DETAIL</literal> <replaceable>'detail'</replaceable></term>
         <listitem>
          <para>
           Provides additional information about the backup target.
          </para>

          <para>
           Currently, this option can only be used when the backup target is
           <literal>server</literal>. It specifies the server directory
           to which the backup should be written.
          </para>
         </listitem>
        </varlistentry>

        <varlistentry>
         <term><literal>PROGRESS [ <replaceable class="parameter">boolean</replaceable> ]</literal></term>
         <listitem>
          <para>
           If set to true, request information required to generate a progress
           report. This will send back an approximate size in the header of each
           tablespace, which can be used to calculate how far along the stream
           is done. This is calculated by enumerating all the file sizes once
           before the transfer is even started, and might as such have a
           negative impact on the performance.  In particular, it might take
           longer before the first data
           is streamed. Since the database files can change during the backup,
           the size is only approximate and might both grow and shrink between
           the time of approximation and the sending of the actual files.
           The default is false.
          </para>
         </listitem>
        </varlistentry>

        <varlistentry>
         <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

Title: Base Backup Options
Summary
A list of options that can be used with the BASE_BACKUP command to customize the backup process, including setting a label, target location, progress reporting, checkpoint type, WAL segment inclusion, and wait behavior.