Home Explore Blog CI



postgresql

5th chunk of `doc/src/sgml/ref/pg_waldump.sgml`
b1ea0731f73534b6b3edcb15a08cf2986df660be921b30d90000000100000e0a
 <literal><replaceable>TIMELINE</replaceable>-<replaceable>LSN</replaceable>.<replaceable>RELTABLESPACE</replaceable>.<replaceable>DATOID</replaceable>.<replaceable>RELNODE</replaceable>.<replaceable>BLKNO</replaceable>_<replaceable>FORK</replaceable></literal>

        The file names are composed of the following parts:
        <informaltable>
         <tgroup cols="2">
          <thead>
           <row>
            <entry>Component</entry>
            <entry>Description</entry>
           </row>
          </thead>

          <tbody>
           <row>
            <entry>TIMELINE</entry>
            <entry>The timeline of the WAL segment file where the record
             is located formatted as one 8-character hexadecimal number
             <literal>%08X</literal></entry>
           </row>

           <row>
            <entry>LSN</entry>
            <entry>The <acronym>LSN</acronym> of the record with this image,
             formatted as two 8-character hexadecimal numbers
             <literal>%08X-%08X</literal></entry>
           </row>

           <row>
            <entry>RELTABLESPACE</entry>
            <entry>tablespace OID of the block</entry>
           </row>

           <row>
            <entry>DATOID</entry>
            <entry>database OID of the block</entry>
           </row>

           <row>
            <entry>RELNODE</entry>
            <entry>filenode of the block</entry>
           </row>

           <row>
            <entry>BLKNO</entry>
            <entry>block number of the block</entry>
           </row>

           <row>
            <entry>FORK</entry>
            <entry>
             The name of the fork the full page image came from, such as
             <literal>main</literal>, <literal>fsm</literal>,
             <literal>vm</literal>, or <literal>init</literal>.
            </entry>
           </row>
          </tbody>
         </tgroup>
        </informaltable>
       </para>
       </listitem>
     </varlistentry>

     <varlistentry>
      <term><option>-?</option></term>
      <term><option>--help</option></term>
       <listitem>
        <para>
         Show help about <application>pg_waldump</application> command line
         arguments, and exit.
        </para>
       </listitem>
      </varlistentry>
    </variablelist>
   </para>
 </refsect1>

 <refsect1>
  <title>Environment</title>

  <variablelist>
   <varlistentry>
    <term><envar>PGDATA</envar></term>
    <listitem>
     <para>
      Data directory; see also the <option>-p</option> option.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><envar>PG_COLOR</envar></term>
    <listitem>
     <para>
      Specifies whether to use color in diagnostic messages. Possible values
      are <literal>always</literal>, <literal>auto</literal> and
      <literal>never</literal>.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1>
  <title>Notes</title>
  <para>
    Can give wrong results when the server is running.
  </para>

  <para>
    Only the specified timeline is displayed (or the default, if none is
    specified). Records in other timelines are ignored.
  </para>

  <para>
    <application>pg_waldump</application> cannot read WAL files with suffix
    <literal>.partial</literal>. If those files need to be read, <literal>.partial</literal>
    suffix needs to be removed from the file name.
  </para>
 </refsect1>

 <refsect1>
  <title>See Also</title>

  <simplelist type="inline">
   <member><xref linkend="wal-internals"/></member>
  </simplelist>
 </refsect1>

</refentry>

Title: pg_waldump: Full-Page Image Filename Format, Help Option, Environment Variables, and Notes
Summary
This section details the format of full-page image filenames saved by pg_waldump, which includes the timeline, LSN, tablespace OID, database OID, relnode, block number and fork information. It also describes the `-?` or `--help` option for displaying command-line argument help. The environment variables PGDATA and PG_COLOR, affecting the data directory and color usage, are also documented. Finally, notes regarding accurate results, timeline specificity, and the inability to read WAL files with the `.partial` suffix are provided.