Home • Explore • Blog • CI
☰



postgresql
2nd chunk of `doc/src/sgml/ref/pg_waldump.sgml`
1e70f04c96e58943f440bd77b9c797269b252a64b8b40e720000000100000fe2
 <term><option>-f</option></term>
      <term><option>--follow</option></term>
      <listitem>
       <para>
        After reaching the end of valid WAL, keep polling once per second for
        new WAL to appear.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><option>-F <replaceable>fork</replaceable></option></term>
      <term><option>--fork=<replaceable>fork</replaceable></option></term>
      <listitem>
       <para>
        Only display records that modify blocks in the given fork.
        The valid values are <literal>main</literal> for the main fork,
        <literal>fsm</literal> for the free space map,
        <literal>vm</literal> for the visibility map,
        and <literal>init</literal> for the init fork.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><option>-n <replaceable>limit</replaceable></option></term>
      <term><option>--limit=<replaceable>limit</replaceable></option></term>
      <listitem>
       <para>
        Display the specified number of records, then stop.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><option>-p <replaceable>path</replaceable></option></term>
      <term><option>--path=<replaceable>path</replaceable></option></term>
      <listitem>
       <para>
        Specifies a directory to search for WAL segment files or a
        directory with a <literal>pg_wal</literal> subdirectory that
        contains such files.  The default is to search in the current
        directory, the <literal>pg_wal</literal> subdirectory of the
        current directory, and the <literal>pg_wal</literal> subdirectory
        of <envar>PGDATA</envar>.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><option>-q</option></term>
      <term><option>--quiet</option></term>
      <listitem>
       <para>
        Do not print any output, except for errors. This option can be useful
        when you want to know whether a range of WAL records can be
        successfully parsed but don't care about the record contents.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><option>-r <replaceable>rmgr</replaceable></option></term>
      <term><option>--rmgr=<replaceable>rmgr</replaceable></option></term>
      <listitem>
       <para>
        Only display records generated by the specified resource manager. You can
        specify the option multiple times to select multiple resource managers.
        If <literal>list</literal> is passed as name, print a list of valid resource manager
        names, and exit.
       </para>
       <para>
        Extensions may define custom resource managers, but
        <application>pg_waldump</application> does
        not load the extension module and therefore does not recognize custom
        resource managers by name. Instead, you can specify the custom
        resource managers as <literal>custom###</literal> where
        <replaceable>###</replaceable> is the three-digit resource manager ID.
        Names of this form will always be considered valid.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><option>-R <replaceable>tblspc</replaceable>/<replaceable>db</replaceable>/<replaceable>rel</replaceable></option></term>
      <term><option>--relation=<replaceable>tblspc</replaceable>/<replaceable>db</replaceable>/<replaceable>rel</replaceable></option></term>
      <listitem>
       <para>
        Only display records that modify blocks in the given relation.  The
        relation is specified with tablespace OID, database OID, and relfilenode
        separated by slashes, for example <literal>1234/12345/12345</literal>.
        This is the same format used for relations in the program's output.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><option>-s <replaceable>start</replaceable></option></term>
      <term><option>--start=<replaceable>start</replaceable></option></term>
Title: pg_waldump Options: Controlling Output and Filtering Records
Summary
This section details command-line options for pg_waldump, controlling output and filtering WAL records. Options include: following the log for new WAL entries; filtering records by fork (main, fsm, vm, init); limiting the number of records displayed; specifying the path to WAL segment files; suppressing output except for errors; filtering by resource manager; filtering by relation (tablespace/database/relfilenode); and specifying the starting point for reading WAL.