Document pg_xlog_wait_remote_recieve and pg_xlog_wait_remote_apply
authorCraig Ringer <craig@2ndquadrant.com>
Tue, 7 Apr 2015 09:24:40 +0000 (17:24 +0800)
committerCraig Ringer <craig@2ndquadrant.com>
Tue, 7 Apr 2015 09:24:40 +0000 (17:24 +0800)
doc/manual-functions.sgml

index d97b65002a30767e80bdba7021585ec020577be6..a2abdb91b764b6390ac4bb911cfdad4199e58370 100644 (file)
        </entry>
       </row>
 
+      <row>
+       <entry>&bdr;</entry>
+       <entry>
+        <indexterm>
+         <primary>pg_xlog_wait_remote_apply</primary>
+        </indexterm>
+        <literal><function>pg_xlog_wait_remote_apply(<replaceable>lsn pg_lsn</replaceable>, <replaceable>pid integer</replaceable>)</function></literal>
+       </entry>
+       <entry>void</entry>
+       <entry>
+        Wait until the replication connection with process id <replaceable>pid</replaceable>
+        (or all connections if <replaceable>pid</replaceable> is <literal>0</literal>)
+        in <literal>pg_stat_replication</literal> has replayed WAL up to at least
+        <replaceable>lsn</replaceable>. Typically used with
+        <function>pg_current_xlog_insert_location()</function> as the target LSN.
+        (This function was added to PostgreSQL 9.4 by the BDR patches and is not part
+         of the BDR extension as such.)
+       </entry>
+      </row>
+
+      <row>
+       <entry>&bdr;</entry>
+       <entry>
+        <indexterm>
+         <primary>pg_xlog_wait_remote_receive</primary>
+        </indexterm>
+        <literal><function>pg_xlog_wait_remote_receive(<replaceable>lsn pg_lsn</replaceable>, <replaceable>pid integer</replaceable>)</function></literal>
+       </entry>
+       <entry>void</entry>
+       <entry>
+        Same as <function>pg_xlog_wait_remote_receive(...)</function>, but
+        returns as soon as the remote confirms it has received the changes, not
+        necessarily applied them.
+       </entry>
+      </row>
+
      </tbody>
     </tgroup>
    </table>