bdr: description of replication set functions
authorChristoph Moench-Tegeder <cmt@burggraben.net>
Thu, 19 Mar 2015 22:23:25 +0000 (23:23 +0100)
committerChristoph Moench-Tegeder <cmt@burggraben.net>
Thu, 19 Mar 2015 22:23:25 +0000 (23:23 +0100)
doc/manual-functions.sgml

index eff15b84f46cc47ce2b96f9a40e44e1482f5a820..c77d8904fec27b2d343336b64281f44276c6839b 100644 (file)
 
   </para>
  </sect1>
+
+ <sect1 id="functions-replication-sets">
+  <title>Replication Set functions</title>
+  <para>
+   The following functions exist to manage <xref linkend="replication-sets">.
+   They are used in both &bdr; and &udr; context.
+
+   <table>
+    <title>Replication Set functions</title>
+    <tgroup cols="3">
+     <thead>
+      <row>
+       <entry>Function</entry>
+       <entry>Return Type</entry>
+       <entry>Description</entry>
+      </row>
+     </thead>
+     <tbody>
+
+      <row id="function-bdr-table-set-replication-sets">
+       <entry>
+        <indexterm>
+         <primary>bdr.table_set_replication_sets</primary>
+        </indexterm>
+        <literal><function>bdr.table_set_replication_sets(<replaceable>p_relation regclass</replaceable>, <replaceable>p_sets text[]</replaceable>)</function></literal>
+       </entry>
+       <entry>void</entry>
+       <entry>
+         Sets the replication sets of a table. The previous assignment will
+         be overwritten.
+       </entry>
+      </row>
+
+      <row id="function-bdr-table-get-replication-sets">
+       <entry>
+        <indexterm>
+         <primary>bdr.table_get_replication_sets</primary>
+        </indexterm>
+        <literal><function>bdr.table_get_replicatio_sets(<replaceable>relation regclass</replaceable>)</function></literal>
+       </entry>
+       <entry>text[]</entry>
+       <entry>
+        Returns the replication sets the specified table is part of.
+       </entry>
+      </row>
+     </tbody>
+    </tgroup>
+   </table>
+  <para>
+ </sect1>
 </chapter>