Home Explore Blog CI



postgresql

45th chunk of `doc/src/sgml/protocol.sgml`
5356bb805ec632a4b3dddd70242449000eaf62dc590d4cd50000000100000fa8
      <varlistentry>
         <term><literal>size</literal> (<type>int8</type>)</term>
         <listitem>
          <para>
           The approximate size of the tablespace, in kilobytes (1024 bytes),
           if progress report has been requested; otherwise it's null.
          </para>
         </listitem>
        </varlistentry>
       </variablelist>
      </para>

      <para>
       After the second regular result set, a CopyOutResponse will be sent.
       The payload of each CopyData message will contain a message in one of
       the following formats:
      </para>

      <variablelist>
       <varlistentry>
        <term>new archive (B)</term>
        <listitem>
         <variablelist>
          <varlistentry>
           <term>Byte1('n')</term>
           <listitem><para>
            Identifies the message as indicating the start of a new archive.
            There will be one archive for the main data directory and one
            for each additional tablespace; each will use tar format
            (following the <quote>ustar interchange format</quote> specified
            in the POSIX 1003.1-2008 standard).
           </para></listitem>
          </varlistentry>

          <varlistentry>
           <term>String</term>
           <listitem><para>
            The file name for this archive.
           </para></listitem>
          </varlistentry>

          <varlistentry>
           <term>String</term>
           <listitem><para>
            For the main data directory, an empty string. For other
            tablespaces, the full path to the directory from which this
            archive was created.
           </para></listitem>
          </varlistentry>
         </variablelist>
        </listitem>
       </varlistentry>

       <varlistentry>
        <term>manifest (B)</term>
        <listitem>
         <variablelist>
          <varlistentry>
           <term>Byte1('m')</term>
           <listitem><para>
            Identifies the message as indicating the start of the backup
            manifest.
           </para></listitem>
          </varlistentry>
         </variablelist>
        </listitem>
       </varlistentry>

       <varlistentry>
        <term>archive or manifest data (B)</term>
        <listitem>
         <variablelist>
          <varlistentry>
           <term>Byte1('d')</term>
           <listitem><para>
            Identifies the message as containing archive or manifest data.
           </para></listitem>
          </varlistentry>

          <varlistentry>
           <term>Byte<replaceable>n</replaceable></term>
           <listitem><para>
            Data bytes.
           </para></listitem>
          </varlistentry>
         </variablelist>
        </listitem>
       </varlistentry>

       <varlistentry>
        <term>progress report (B)</term>
        <listitem>
         <variablelist>
          <varlistentry>
           <term>Byte1('p')</term>
           <listitem><para>
            Identifies the message as a progress report.
           </para></listitem>
          </varlistentry>

          <varlistentry>
           <term>Int64</term>
           <listitem><para>
            The number of bytes from the current tablespace for which
            processing has been completed.
           </para></listitem>
          </varlistentry>
         </variablelist>
        </listitem>
       </varlistentry>
      </variablelist>

      <para>
       After the CopyOutResponse, or all such responses, have been sent, a
       final ordinary result set will be sent, containing the WAL end position
       of the backup, in the same format as the start position.
      </para>

      <para>
       The tar archive for the data directory and each tablespace will contain
       all files in the directories, regardless of whether they are
       <productname>PostgreSQL</productname> files or other files added to the same
       directory. The only excluded files are:

       <itemizedlist spacing="compact" mark="bullet">

Title: Backup Response Message Formats
Summary
The server responds to a backup request with a series of messages in specific formats, including new archive, manifest, archive or manifest data, and progress report messages, followed by a final result set containing the WAL end position of the backup.