Home Explore Blog CI



postgresql

2nd chunk of `doc/src/sgml/ref/pg_recvlogical.sgml`
fe5b1f08aa37a7ce4a8155ecd102bfde4af6a232971b451f0000000100000fa0
 </listitem>
     </varlistentry>

     <varlistentry>
      <term><option>--start</option></term>
      <listitem>
       <para>
        Begin streaming changes from the logical replication slot specified
        by <option>--slot</option>, continuing until terminated by a
        signal. If the server side change stream ends with a server shutdown
        or disconnect, retry in a loop unless
        <option>--no-loop</option> is specified.
       </para>

       <para>
        The <option>--slot</option> and <option>--dbname</option>,
        <option>--file</option> are required for this action.
       </para>

       <para>
        The stream format is determined by the output plugin specified when
        the slot was created.
       </para>

       <para>
        The connection must be to the same database used to create the slot.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>

   <para>
    <option>--create-slot</option> and <option>--start</option> can be
    specified together.  <option>--drop-slot</option> cannot be combined with
    another action.
   </para>

   <para>
    The following command-line options control the location and format of the
    output and other replication behavior:

    <variablelist>
     <varlistentry>
      <term><option>-E <replaceable>lsn</replaceable></option></term>
      <term><option>--endpos=<replaceable>lsn</replaceable></option></term>
      <listitem>
       <para>
        In <option>--start</option> mode, automatically stop replication
        and exit with normal exit status 0 when receiving reaches the
        specified LSN.  If specified when not in <option>--start</option>
        mode, an error is raised.
       </para>

       <para>
        If there's a record with LSN exactly equal to <replaceable>lsn</replaceable>,
        the record will be output.
       </para>

       <para>
        The <option>--endpos</option> option is not aware of transaction
        boundaries and may truncate output partway through a transaction.
        Any partially output transaction will not be consumed and will be
        replayed again when the slot is next read from. Individual messages
        are never truncated.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><option>--failover</option></term>
      <listitem>
       <para>
        Enables the slot to be synchronized to the standbys. This option may
        only be specified with <option>--create-slot</option>.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><option>-f <replaceable>filename</replaceable></option></term>
      <term><option>--file=<replaceable>filename</replaceable></option></term>
      <listitem>
       <para>
        Write received and decoded transaction data into this
        file. Use <literal>-</literal> for <systemitem>stdout</systemitem>.
       </para>
       <para>
        This parameter is required for <option>--start</option>.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><option>-F <replaceable>interval_seconds</replaceable></option></term>
      <term><option>--fsync-interval=<replaceable>interval_seconds</replaceable></option></term>
      <listitem>
       <para>
        Specifies how often <application>pg_recvlogical</application> should
        issue <function>fsync()</function> calls to ensure the output file is
        safely flushed to disk.
       </para>

       <para>
        The server will occasionally request the client to perform a flush and
        report the flush position to the server.  This setting is in addition
        to that, to perform flushes more frequently.
       </para>

       <para>
        Specifying an interval of <literal>0</literal> disables
        issuing <function>fsync()</function> calls altogether, while still
        reporting progress to the server.  In this case, data could be lost in
        the event of a

Title: pg_recvlogical Options: Actions, Output Control, and Replication Behavior
Summary
This section details the options available for pg_recvlogical, categorized by action (creating, dropping, or starting a replication slot), output control, and replication behavior. It covers options like --create-slot, --drop-slot, --start, --endpos, --failover, --file, and --fsync-interval. These options allow users to manage replication slots, control output destinations, specify end positions, enable synchronous replication to standbys, and adjust file synchronization frequency.