/usr/share/doc/skytools3/londiste3.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.9" />
<title>londiste3(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */

/* Default font. */
body {
  font-family: Georgia,serif;
}

/* Title font. */
h1, h2, h3, h4, h5, h6,
div.title, caption.title,
thead, p.table.header,
#toctitle,
#author, #revnumber, #revdate, #revremark,
#footer {
  font-family: Arial,Helvetica,sans-serif;
}

body {
  margin: 1em 5% 1em 5%;
}

a {
  color: blue;
  text-decoration: underline;
}
a:visited {
  color: fuchsia;
}

em {
  font-style: italic;
  color: navy;
}

strong {
  font-weight: bold;
  color: #083194;
}

h1, h2, h3, h4, h5, h6 {
  color: #527bbd;
  margin-top: 1.2em;
  margin-bottom: 0.5em;
  line-height: 1.3;
}

h1, h2, h3 {
  border-bottom: 2px solid silver;
}
h2 {
  padding-top: 0.5em;
}
h3 {
  float: left;
}
h3 + * {
  clear: left;
}
h5 {
  font-size: 1.0em;
}

div.sectionbody {
  margin-left: 0;
}

hr {
  border: 1px solid silver;
}

p {
  margin-top: 0.5em;
  margin-bottom: 0.5em;
}

ul, ol, li > p {
  margin-top: 0;
}
ul > li     { color: #aaa; }
ul > li > * { color: black; }

.monospaced, code, pre {
  font-family: "Courier New", Courier, monospace;
  font-size: inherit;
  color: navy;
  padding: 0;
  margin: 0;
}
pre {
  white-space: pre-wrap;
}

#author {
  color: #527bbd;
  font-weight: bold;
  font-size: 1.1em;
}
#email {
}
#revnumber, #revdate, #revremark {
}

#footer {
  font-size: small;
  border-top: 2px solid silver;
  padding-top: 0.5em;
  margin-top: 4.0em;
}
#footer-text {
  float: left;
  padding-bottom: 0.5em;
}
#footer-badges {
  float: right;
  padding-bottom: 0.5em;
}

#preamble {
  margin-top: 1.5em;
  margin-bottom: 1.5em;
}
div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
  margin-top: 1.0em;
  margin-bottom: 1.5em;
}
div.admonitionblock {
  margin-top: 2.0em;
  margin-bottom: 2.0em;
  margin-right: 10%;
  color: #606060;
}

div.content { /* Block element content. */
  padding: 0;
}

/* Block element titles. */
div.title, caption.title {
  color: #527bbd;
  font-weight: bold;
  text-align: left;
  margin-top: 1.0em;
  margin-bottom: 0.5em;
}
div.title + * {
  margin-top: 0;
}

td div.title:first-child {
  margin-top: 0.0em;
}
div.content div.title:first-child {
  margin-top: 0.0em;
}
div.content + div.title {
  margin-top: 0.0em;
}

div.sidebarblock > div.content {
  background: #ffffee;
  border: 1px solid #dddddd;
  border-left: 4px solid #f0f0f0;
  padding: 0.5em;
}

div.listingblock > div.content {
  border: 1px solid #dddddd;
  border-left: 5px solid #f0f0f0;
  background: #f8f8f8;
  padding: 0.5em;
}

div.quoteblock, div.verseblock {
  padding-left: 1.0em;
  margin-left: 1.0em;
  margin-right: 10%;
  border-left: 5px solid #f0f0f0;
  color: #888;
}

div.quoteblock > div.attribution {
  padding-top: 0.5em;
  text-align: right;
}

div.verseblock > pre.content {
  font-family: inherit;
  font-size: inherit;
}
div.verseblock > div.attribution {
  padding-top: 0.75em;
  text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
  text-align: left;
}

div.admonitionblock .icon {
  vertical-align: top;
  font-size: 1.1em;
  font-weight: bold;
  text-decoration: underline;
  color: #527bbd;
  padding-right: 0.5em;
}
div.admonitionblock td.content {
  padding-left: 0.5em;
  border-left: 3px solid #dddddd;
}

div.exampleblock > div.content {
  border-left: 3px solid #dddddd;
  padding-left: 0.5em;
}

div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; vertical-align: text-bottom; }
a.image:visited { color: white; }

dl {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
}
dt {
  margin-top: 0.5em;
  margin-bottom: 0;
  font-style: normal;
  color: navy;
}
dd > *:first-child {
  margin-top: 0.1em;
}

ul, ol {
    list-style-position: outside;
}
ol.arabic {
  list-style-type: decimal;
}
ol.loweralpha {
  list-style-type: lower-alpha;
}
ol.upperalpha {
  list-style-type: upper-alpha;
}
ol.lowerroman {
  list-style-type: lower-roman;
}
ol.upperroman {
  list-style-type: upper-roman;
}

div.compact ul, div.compact ol,
div.compact p, div.compact p,
div.compact div, div.compact div {
  margin-top: 0.1em;
  margin-bottom: 0.1em;
}

tfoot {
  font-weight: bold;
}
td > div.verse {
  white-space: pre;
}

div.hdlist {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
}
div.hdlist tr {
  padding-bottom: 15px;
}
dt.hdlist1.strong, td.hdlist1.strong {
  font-weight: bold;
}
td.hdlist1 {
  vertical-align: top;
  font-style: normal;
  padding-right: 0.8em;
  color: navy;
}
td.hdlist2 {
  vertical-align: top;
}
div.hdlist.compact tr {
  margin: 0;
  padding-bottom: 0;
}

.comment {
  background: yellow;
}

.footnote, .footnoteref {
  font-size: 0.8em;
}

span.footnote, span.footnoteref {
  vertical-align: super;
}

#footnotes {
  margin: 20px 0 20px 0;
  padding: 7px 0 0 0;
}

#footnotes div.footnote {
  margin: 0 0 5px 0;
}

#footnotes hr {
  border: none;
  border-top: 1px solid silver;
  height: 1px;
  text-align: left;
  margin-left: 0;
  width: 20%;
  min-width: 100px;
}

div.colist td {
  padding-right: 0.5em;
  padding-bottom: 0.3em;
  vertical-align: top;
}
div.colist td img {
  margin-top: 0.3em;
}

@media print {
  #footer-badges { display: none; }
}

#toc {
  margin-bottom: 2.5em;
}

#toctitle {
  color: #527bbd;
  font-size: 1.1em;
  font-weight: bold;
  margin-top: 1.0em;
  margin-bottom: 0.1em;
}

div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
  margin-top: 0;
  margin-bottom: 0;
}
div.toclevel2 {
  margin-left: 2em;
  font-size: 0.9em;
}
div.toclevel3 {
  margin-left: 4em;
  font-size: 0.9em;
}
div.toclevel4 {
  margin-left: 6em;
  font-size: 0.9em;
}

span.aqua { color: aqua; }
span.black { color: black; }
span.blue { color: blue; }
span.fuchsia { color: fuchsia; }
span.gray { color: gray; }
span.green { color: green; }
span.lime { color: lime; }
span.maroon { color: maroon; }
span.navy { color: navy; }
span.olive { color: olive; }
span.purple { color: purple; }
span.red { color: red; }
span.silver { color: silver; }
span.teal { color: teal; }
span.white { color: white; }
span.yellow { color: yellow; }

span.aqua-background { background: aqua; }
span.black-background { background: black; }
span.blue-background { background: blue; }
span.fuchsia-background { background: fuchsia; }
span.gray-background { background: gray; }
span.green-background { background: green; }
span.lime-background { background: lime; }
span.maroon-background { background: maroon; }
span.navy-background { background: navy; }
span.olive-background { background: olive; }
span.purple-background { background: purple; }
span.red-background { background: red; }
span.silver-background { background: silver; }
span.teal-background { background: teal; }
span.white-background { background: white; }
span.yellow-background { background: yellow; }

span.big { font-size: 2em; }
span.small { font-size: 0.6em; }

span.underline { text-decoration: underline; }
span.overline { text-decoration: overline; }
span.line-through { text-decoration: line-through; }

div.unbreakable { page-break-inside: avoid; }


/*
 * xhtml11 specific
 *
 * */

div.tableblock {
  margin-top: 1.0em;
  margin-bottom: 1.5em;
}
div.tableblock > table {
  border: 3px solid #527bbd;
}
thead, p.table.header {
  font-weight: bold;
  color: #527bbd;
}
p.table {
  margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
  border-style: none;
}
div.tableblock > table[frame="hsides"] {
  border-left-style: none;
  border-right-style: none;
}
div.tableblock > table[frame="vsides"] {
  border-top-style: none;
  border-bottom-style: none;
}


/*
 * html5 specific
 *
 * */

table.tableblock {
  margin-top: 1.0em;
  margin-bottom: 1.5em;
}
thead, p.tableblock.header {
  font-weight: bold;
  color: #527bbd;
}
p.tableblock {
  margin-top: 0;
}
table.tableblock {
  border-width: 3px;
  border-spacing: 0px;
  border-style: solid;
  border-color: #527bbd;
  border-collapse: collapse;
}
th.tableblock, td.tableblock {
  border-width: 1px;
  padding: 4px;
  border-style: solid;
  border-color: #527bbd;
}

table.tableblock.frame-topbot {
  border-left-style: hidden;
  border-right-style: hidden;
}
table.tableblock.frame-sides {
  border-top-style: hidden;
  border-bottom-style: hidden;
}
table.tableblock.frame-none {
  border-style: hidden;
}

th.tableblock.halign-left, td.tableblock.halign-left {
  text-align: left;
}
th.tableblock.halign-center, td.tableblock.halign-center {
  text-align: center;
}
th.tableblock.halign-right, td.tableblock.halign-right {
  text-align: right;
}

th.tableblock.valign-top, td.tableblock.valign-top {
  vertical-align: top;
}
th.tableblock.valign-middle, td.tableblock.valign-middle {
  vertical-align: middle;
}
th.tableblock.valign-bottom, td.tableblock.valign-bottom {
  vertical-align: bottom;
}


/*
 * manpage specific
 *
 * */

body.manpage h1 {
  padding-top: 0.5em;
  padding-bottom: 0.5em;
  border-top: 2px solid silver;
  border-bottom: 2px solid silver;
}
body.manpage h2 {
  border-style: none;
}
body.manpage div.sectionbody {
  margin-left: 3em;
}

@media print {
  body.manpage div#toc { display: none; }
}


</style>
<script type="text/javascript">
/*<![CDATA[*/
var asciidoc = {  // Namespace.

/////////////////////////////////////////////////////////////////////
// Table Of Contents generator
/////////////////////////////////////////////////////////////////////

/* Author: Mihai Bazon, September 2002
 * http://students.infoiasi.ro/~mishoo
 *
 * Table Of Content generator
 * Version: 0.4
 *
 * Feel free to use this script under the terms of the GNU General Public
 * License, as long as you do not remove or alter this notice.
 */

 /* modified by Troy D. Hanson, September 2006. License: GPL */
 /* modified by Stuart Rackham, 2006, 2009. License: GPL */

// toclevels = 1..4.
toc: function (toclevels) {

  function getText(el) {
    var text = "";
    for (var i = el.firstChild; i != null; i = i.nextSibling) {
      if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
        text += i.data;
      else if (i.firstChild != null)
        text += getText(i);
    }
    return text;
  }

  function TocEntry(el, text, toclevel) {
    this.element = el;
    this.text = text;
    this.toclevel = toclevel;
  }

  function tocEntries(el, toclevels) {
    var result = new Array;
    var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
    // Function that scans the DOM tree for header elements (the DOM2
    // nodeIterator API would be a better technique but not supported by all
    // browsers).
    var iterate = function (el) {
      for (var i = el.firstChild; i != null; i = i.nextSibling) {
        if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
          var mo = re.exec(i.tagName);
          if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
            result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
          }
          iterate(i);
        }
      }
    }
    iterate(el);
    return result;
  }

  var toc = document.getElementById("toc");
  if (!toc) {
    return;
  }

  // Delete existing TOC entries in case we're reloading the TOC.
  var tocEntriesToRemove = [];
  var i;
  for (i = 0; i < toc.childNodes.length; i++) {
    var entry = toc.childNodes[i];
    if (entry.nodeName.toLowerCase() == 'div'
     && entry.getAttribute("class")
     && entry.getAttribute("class").match(/^toclevel/))
      tocEntriesToRemove.push(entry);
  }
  for (i = 0; i < tocEntriesToRemove.length; i++) {
    toc.removeChild(tocEntriesToRemove[i]);
  }

  // Rebuild TOC entries.
  var entries = tocEntries(document.getElementById("content"), toclevels);
  for (var i = 0; i < entries.length; ++i) {
    var entry = entries[i];
    if (entry.element.id == "")
      entry.element.id = "_toc_" + i;
    var a = document.createElement("a");
    a.href = "#" + entry.element.id;
    a.appendChild(document.createTextNode(entry.text));
    var div = document.createElement("div");
    div.appendChild(a);
    div.className = "toclevel" + entry.toclevel;
    toc.appendChild(div);
  }
  if (entries.length == 0)
    toc.parentNode.removeChild(toc);
},


/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////

/* Based on footnote generation code from:
 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 */

footnotes: function () {
  // Delete existing footnote entries in case we're reloading the footnodes.
  var i;
  var noteholder = document.getElementById("footnotes");
  if (!noteholder) {
    return;
  }
  var entriesToRemove = [];
  for (i = 0; i < noteholder.childNodes.length; i++) {
    var entry = noteholder.childNodes[i];
    if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
      entriesToRemove.push(entry);
  }
  for (i = 0; i < entriesToRemove.length; i++) {
    noteholder.removeChild(entriesToRemove[i]);
  }

  // Rebuild footnote entries.
  var cont = document.getElementById("content");
  var spans = cont.getElementsByTagName("span");
  var refs = {};
  var n = 0;
  for (i=0; i<spans.length; i++) {
    if (spans[i].className == "footnote") {
      n++;
      var note = spans[i].getAttribute("data-note");
      if (!note) {
        // Use [\s\S] in place of . so multi-line matches work.
        // Because JavaScript has no s (dotall) regex flag.
        note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
        spans[i].innerHTML =
          "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
          "' title='View footnote' class='footnote'>" + n + "</a>]";
        spans[i].setAttribute("data-note", note);
      }
      noteholder.innerHTML +=
        "<div class='footnote' id='_footnote_" + n + "'>" +
        "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
        n + "</a>. " + note + "</div>";
      var id =spans[i].getAttribute("id");
      if (id != null) refs["#"+id] = n;
    }
  }
  if (n == 0)
    noteholder.parentNode.removeChild(noteholder);
  else {
    // Process footnoterefs.
    for (i=0; i<spans.length; i++) {
      if (spans[i].className == "footnoteref") {
        var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
        href = href.match(/#.*/)[0];  // Because IE return full URL.
        n = refs[href];
        spans[i].innerHTML =
          "[<a href='#_footnote_" + n +
          "' title='View footnote' class='footnote'>" + n + "</a>]";
      }
    }
  }
},

install: function(toclevels) {
  var timerId;

  function reinstall() {
    asciidoc.footnotes();
    if (toclevels) {
      asciidoc.toc(toclevels);
    }
  }

  function reinstallAndRemoveTimer() {
    clearInterval(timerId);
    reinstall();
  }

  timerId = setInterval(reinstall, 500);
  if (document.addEventListener)
    document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
  else
    window.onload = reinstallAndRemoveTimer;
}

}
asciidoc.install(2);
/*]]>*/
</script>
</head>
<body class="article">
<div id="header">
<h1>londiste3(1)</h1>
<div id="toc">
  <div id="toctitle">Table of Contents</div>
  <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_name">NAME</h2>
<div class="sectionbody">
<div class="paragraph"><p>londiste3 - tool for managing trigger-based replication for PostgreSQL.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="literalblock">
<div class="content">
<pre><code>londiste3 &lt;config.ini&gt; command [subcommand] [options]</code></pre>
</div></div>
</div>
</div>
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph"><p>Londiste allows you to setup and administer the replication, and is run as a
daemon to handle the replication itself. (Londiste is just a complex
PgQ Consumer).</p></div>
<div class="paragraph"><p>See <a href="#examples">EXAMPLES</a> below to start your first trigger-based
replication in a few steps.</p></div>
<div class="paragraph"><p>The <em>command</em> is one of Node, Replication, Information or Internal
commands listed below.</p></div>
<div class="paragraph"><p>Londiste introduces the notion of <em>takeover</em>.  It is the action when a
local node takes over the work of another node. The other node can be a
root node or a branch node and it can be dead or alive when the action
is run.</p></div>
<div class="paragraph"><p>Londiste also allows (among many other features): cascading replication,
partial replication and custom handlers for replication.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_general_options">GENERAL OPTIONS</h2>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
-V, --version
</dt>
<dd>
<p>
    Print version info and exit.
</p>
</dd>
<dt class="hdlist1">
-h, --help
</dt>
<dd>
<p>
    Show this help message and exit.
</p>
</dd>
<dt class="hdlist1">
-q, --quiet
</dt>
<dd>
<p>
    Log only errors and warnings.
</p>
</dd>
<dt class="hdlist1">
-v, --verbose
</dt>
<dd>
<p>
    Log verbosely.
</p>
</dd>
<dt class="hdlist1">
-d, --daemon
</dt>
<dd>
<p>
    Run in daemon mode (go background).
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="_specific_options">SPECIFIC OPTIONS</h2>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--ini
</dt>
<dd>
<p>
    Display sample ini file.
</p>
</dd>
<dt class="hdlist1">
--set="<em>param=val[,param=value]</em>"
</dt>
<dd>
<p>
    Override config setting.
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="_daemon_options">DAEMON OPTIONS</h2>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
-r, --reload
</dt>
<dd>
<p>
    Reload config (send SIGHUP).
</p>
</dd>
<dt class="hdlist1">
-s, --stop
</dt>
<dd>
<p>
    Stop program safely (send SIGINT).
</p>
</dd>
<dt class="hdlist1">
-k, --kill
</dt>
<dd>
<p>
    Kill program immediately (send SIGTERM).
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="_replication_extra_arguments">REPLICATION EXTRA ARGUMENTS</h2>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--rewind
</dt>
<dd>
<p>
    Change queue position according to destination.
</p>
</dd>
<dt class="hdlist1">
--reset
</dt>
<dd>
<p>
    Reset queue position on destination side.
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="_node_initialization_commands">NODE INITIALIZATION COMMANDS</h2>
<div class="sectionbody">
<div class="paragraph"><p>Initialization commands will set up "public connect string" for
current node.  It is a connect string that other nodes will
use to connect to current node.  The local Londiste itself
uses <em>db</em> option from config file to connect to local node,
which can have different user rights than scripts coming
over public connect string.</p></div>
<div class="paragraph"><p>Connect strings can be set in either command line or config file.
Command line overrides config.  Setting them up in config
might be more comfortable.  See <code>londiste3 --ini</code> for details.</p></div>
<div class="sect2">
<h3 id="_create_root_lt_node_gt_lt_public_connstr_for_node_gt">create-root &lt;node&gt; [&lt;public_connstr_for_node&gt;]</h3>
<div class="paragraph"><p>Initializes a Master node.</p></div>
<div class="paragraph"><p>The &lt;node&gt; is the name of the node, it should be unique.</p></div>
</div>
<div class="sect2">
<h3 id="_create_branch_lt_node_gt_lt_public_connstr_for_node_gt_provider_lt_connstr_to_provider_gt">create-branch &lt;node&gt; [&lt;public_connstr_for_node&gt;] [--provider=&lt;connstr_to_provider&gt;]</h3>
<div class="paragraph"><p>Initializes a Slave node which can be used as a reference for other
nodes.</p></div>
<div class="paragraph"><p>The &lt;node&gt; is the name of the node, it should be unique.
The &lt;public_connstr_for_node&gt; argument is the connection string to the database
on the current node and &lt;connstr_to_provider&gt; is the connection string to the
provider database (it can be a root node or a branch node).</p></div>
</div>
<div class="sect2">
<h3 id="_create_leaf_lt_node_gt_lt_public_connstr_for_node_gt_provider_lt_connstr_to_provider_gt">create-leaf &lt;node&gt; [&lt;public_connstr_for_node&gt;] [--provider=&lt;connstr_to_provider&gt;]</h3>
<div class="paragraph"><p>Initializes a slave node which can not be used as a reference for other
nodes.</p></div>
<div class="paragraph"><p>The &lt;node&gt; is the name of the node, it should be unique.
The &lt;public_connstr_for_node&gt; argument is the connection string to the database
on the current node and &lt;connstr_to_provider&gt; is the connection string to the
provider database (it can be a root node or a branch node).</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
--merge=<em>qname</em>
</dt>
<dd>
<p>
    combined queue name
</p>
</dd>
</dl></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_node_administration_commands">NODE ADMINISTRATION COMMANDS</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_pause">pause</h3>
<div class="paragraph"><p>Pause the consumer: the replication of the events is stopped and can be
resumed later.</p></div>
</div>
<div class="sect2">
<h3 id="_resume">resume</h3>
<div class="paragraph"><p>When the consumer has been paused, let it replay again.</p></div>
</div>
<div class="sect2">
<h3 id="_change_provider_lt_tonode_gt">change-provider &lt;tonode&gt;</h3>
<div class="paragraph"><p>Make &lt;tonode&gt; become the new provider for the current node.</p></div>
<div class="paragraph"><p>TODO: londiste.py need update (param change from --provider)</p></div>
</div>
<div class="sect2">
<h3 id="_takeover_lt_fromnode_gt_target_lt_tonode_gt_all_dead">takeover &lt;fromnode&gt; [--target=&lt;tonode&gt;] [--all] [--dead]</h3>
<div class="paragraph"><p>This command allows to achieve failover and switchover for any of your
providers (root or branch nodes).</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
--target=<em>tonode</em>
</dt>
<dd>
<p>
    Target node of the takeover.
</p>
</dd>
<dt class="hdlist1">
--all
</dt>
<dd>
<p>
    In addition to take over the work from the <em>fromnode</em>, make other
    nodes change their provider to the current node.
</p>
</dd>
<dt class="hdlist1">
--dead
</dt>
<dd>
<p>
    Don&#8217;t wait to take the new role and flag the <em>fromnode</em> as dead.
</p>
</dd>
<dt class="hdlist1">
--dead=<em>deadnode</em>
</dt>
<dd>
<p>
    Assume node is dead.
    TODO : why use this one ?
</p>
</dd>
<dt class="hdlist1">
--dead-root
</dt>
<dd>
<p>
    Old node was root.
</p>
</dd>
<dt class="hdlist1">
--dead-branch
</dt>
<dd>
<p>
    Old node was branch
</p>
</dd>
</dl></div>
</div>
<div class="sect2">
<h3 id="_resurrect">resurrect</h3>
<div class="paragraph"><p>In case root was down and taken over with <code>--dead-root</code>, this command
fixes queue contents on that old root to match the rest of cascade.
Events that did not propagate to rest of the cascade before failure
(lost events) are dumped into file in JSON format and deleted from queue.
Then the node is registered into cascade and it&#8217;s worker will
be paused.</p></div>
<div class="paragraph"><p>It requires that there is another active root in cascade and
there is consumer named <code>NODENAME.gravestone</code> registered
on same node, it uses that to get position where rest of the
cascade moved on.</p></div>
<div class="paragraph"><p>It does not touch actual tables, which means there must
be external mechanism to survive unsynced tables.  Options:</p></div>
<div class="ulist"><ul>
<li>
<p>
Ignore lost events.  May need trigger/rule on tables to handle conflicts.
</p>
</li>
<li>
<p>
Replay the lost events on new root.
  May need trigger/rule on tables to handle conflicts.
</p>
</li>
<li>
<p>
Roll back table changes.
  May need old version of row stored in events.
  (Achieved with <code>backup</code> parameter to <code>pgq.logutriga</code>)
</p>
</li>
</ul></div>
</div>
<div class="sect2">
<h3 id="_drop_node_lt_node_gt">drop-node &lt;node&gt;</h3>
<div class="paragraph"><p>Remove the node from the Londiste replication.</p></div>
<div class="paragraph"><p>Londiste triggers on the node are removed but Londiste or PgQ are not
removed.</p></div>
</div>
<div class="sect2">
<h3 id="_tag_dead_lt_node_gt">tag-dead &lt;node&gt;</h3>
<div class="paragraph"><p>Tag the node as dead, the command can be run from any node in the
replication.</p></div>
</div>
<div class="sect2">
<h3 id="_tag_alive_lt_node_gt">tag-alive &lt;node&gt;</h3>
<div class="paragraph"><p>Tag the node as alive, the command can be run from any node in the
replication.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_information_commands">INFORMATION COMMANDS</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_status">status</h3>
<div class="paragraph"><p>Show status of the replication viewed by the current node.</p></div>
<div class="paragraph"><p>The output is a tree of the members of the replication with their lags,
last tick, status and the number of tables in state: ok/half/ignored
(replicated, initial copy not finnished, table not replicated locally).</p></div>
</div>
<div class="sect2">
<h3 id="_members">members</h3>
<div class="paragraph"><p>Show members of the replication viewed by the current node.</p></div>
<div class="paragraph"><p>Output the nodes name, status and node location (connection string to
the node).</p></div>
</div>
<div class="sect2">
<h3 id="_show_consumers_node">show-consumers [--node]</h3>
<div class="paragraph"><p>TODO: command is not working</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_replication_daemon_command">REPLICATION DAEMON COMMAND</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_worker">worker</h3>
<div class="paragraph"><p>Replay events to subscriber: it is needed to make the replication active
as it will start to replay the events.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_replication_administration_commands">REPLICATION ADMINISTRATION COMMANDS</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_add_table_lt_table_gt_args">add-table &lt;table&gt; [args]</h3>
<div class="paragraph"><p>Add the table to the replication.</p></div>
<div class="paragraph"><p>See <a href="#add_args">ADD ARGUMENTS</a> below for the list of possible arguments.</p></div>
</div>
<div class="sect2">
<h3 id="_remove_table_lt_table_gt">remove-table &lt;table&gt;</h3>
<div class="paragraph"><p>Remove the table from the replication.</p></div>
</div>
<div class="sect2">
<h3 id="_add_seq_lt_seq_gt_args">add-seq &lt;seq&gt; [args]</h3>
<div class="paragraph"><p>Add the sequence to the replication.</p></div>
<div class="paragraph"><p>See <a href="#add_args">ADD ARGUMENTS</a> below for the list of possible arguments.</p></div>
</div>
<div class="sect2">
<h3 id="_remove_seq_lt_seq_gt">remove-seq &lt;seq&gt;</h3>
<div class="paragraph"><p>Remove the sequence from the replication.</p></div>
</div>
<div class="sect2">
<h3 id="_tables">tables</h3>
<div class="paragraph"><p>Show all tables on provider.</p></div>
</div>
<div class="sect2">
<h3 id="_seqs">seqs</h3>
<div class="paragraph"><p>Show all sequences on provider.</p></div>
</div>
<div class="sect2">
<h3 id="_missing">missing</h3>
<div class="paragraph"><p>List tables subscriber has not yet attached to.</p></div>
</div>
<div class="sect2">
<h3 id="_resync_lt_table_gt">resync &lt;table&gt;</h3>
<div class="paragraph"><p>Do full copy of the table, again.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_add_arguments_a_id_add_args_a">ADD ARGUMENTS <a id="add_args"></a></h2>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--all
</dt>
<dd>
<p>
    Include all possible tables.
</p>
</dd>
<dt class="hdlist1">
--wait-sync
</dt>
<dd>
<p>
    Wait until newly added tables are synced fully.
</p>
</dd>
<dt class="hdlist1">
--dest-table=<em>table</em>
</dt>
<dd>
<p>
    Redirect changes to different table.
</p>
</dd>
<dt class="hdlist1">
--force
</dt>
<dd>
<p>
    Ignore table differences.
</p>
</dd>
<dt class="hdlist1">
--expect-sync
</dt>
<dd>
<p>
    No copy needed.
</p>
</dd>
<dt class="hdlist1">
--skip-truncate
</dt>
<dd>
<p>
    Keep old data.
</p>
</dd>
<dt class="hdlist1">
--create
</dt>
<dd>
<p>
    Create table/sequence if not exist, with minimal schema.
</p>
</dd>
<dt class="hdlist1">
--create-full
</dt>
<dd>
<p>
    Create table/sequence if not exist, with full schema.
</p>
</dd>
<dt class="hdlist1">
--trigger-flags=<em>trigger_flags</em>
</dt>
<dd>
<p>
    Trigger creation flags, see below for details.
</p>
</dd>
<dt class="hdlist1">
--trigger-arg=<em>trigger_arg</em>
</dt>
<dd>
<p>
    Custom trigger arg (can be specified multiply times).
</p>
</dd>
<dt class="hdlist1">
--no-triggers
</dt>
<dd>
<p>
    Dont put triggers on table (makes sense on leaf node).
</p>
</dd>
<dt class="hdlist1">
--handler=<em>handler</em>
</dt>
<dd>
<p>
    Custom handler for table.
</p>
</dd>
<dt class="hdlist1">
--handler-arg=<em>handler_arg</em>
</dt>
<dd>
<p>
    Argument to custom handler.
</p>
</dd>
<dt class="hdlist1">
--copy-node=<em>NODE_NAME</em>
</dt>
<dd>
<p>
    Do initial copy from that node instead from provider.
    Useful if provider does not contain table data locally
    or is simply under load.
</p>
</dd>
<dt class="hdlist1">
--merge-all
</dt>
<dd>
<p>
    Merge tables from all source queues.
</p>
</dd>
<dt class="hdlist1">
--no-merge
</dt>
<dd>
<p>
    Don&#8217;t merge tables from source queues.
</p>
</dd>
<dt class="hdlist1">
--max-parallel-copy=<em>max_parallel_copy</em>
</dt>
<dd>
<p>
    Max number of parallel copy processes.
</p>
</dd>
<dt class="hdlist1">
--skip-non-existing
</dt>
<dd>
<p>
    Skip objects that do not exist.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Trigger creation flags (default: AIUDL):</p></div>
<div class="ulist"><ul>
<li>
<p>
I - ON INSERT
</p>
</li>
<li>
<p>
U - ON UPDATE
</p>
</li>
<li>
<p>
D - ON DELETE
</p>
</li>
<li>
<p>
Q - use pgq.sqltriga() as trigger function
</p>
</li>
<li>
<p>
L - use pgq.logutriga() as trigger function
</p>
</li>
<li>
<p>
B - BEFORE
</p>
</li>
<li>
<p>
A - AFTER
</p>
</li>
<li>
<p>
S - SKIP
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="_replication_extra_commands">REPLICATION EXTRA COMMANDS</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_check">check</h3>
<div class="paragraph"><p>Compare table structure on both sides.</p></div>
</div>
<div class="sect2">
<h3 id="_fkeys">fkeys</h3>
<div class="paragraph"><p>Print out fkey drop/create commands.</p></div>
</div>
<div class="sect2">
<h3 id="_compare_lt_table_gt">compare [&lt;table&gt;]</h3>
<div class="paragraph"><p>Compare table contents on both sides.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
--count-only
</dt>
<dd>
<p>
    Just count rows, do not compare data.
</p>
</dd>
</dl></div>
</div>
<div class="sect2">
<h3 id="_repair_lt_table_gt_force">repair [&lt;table&gt;] [--force]</h3>
<div class="paragraph"><p>Repair data on subscriber.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
--force
</dt>
<dd>
<p>
    Ignore lag.
</p>
</dd>
</dl></div>
</div>
<div class="sect2">
<h3 id="_execute_filepath">execute [filepath]</h3>
<div class="paragraph"><p>Execute SQL files on each node of the cascaded queue.  The SQL file is
executed locally in single transaction and inserted into queue in same
transaction.  Thus guaranteeing that is will be replayed in subscriber
databases at correct position.</p></div>
<div class="paragraph"><p>The filename is stored in <code>londiste.applied_execute</code> table, and checked
before execution.  If same filename already exists, the SQL execution
is skipped.</p></div>
<div class="sect3">
<h4 id="_sql_meta_data_attributes">SQL meta-data attributes</h4>
<div class="paragraph"><p>SQL file can contain attributes that limit where the SQL is executed:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>--*--
--*-- Local-Table: mytable, othertable,
--*--              thirdtable
--*-- Local-Sequence: thisseq
--*--</code></pre>
</div></div>
<div class="paragraph"><p>The magic comments are searched only in file start, before any actual SQL
statement is seen.  Empty lines and lines with regular SQL comments
are ignored.</p></div>
<div class="paragraph"><p>Supported keys:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
Local-Table
</dt>
<dd>
<p>
    Table must be added to local node with <code>add-table</code>.
</p>
</dd>
<dt class="hdlist1">
Local-Sequence
</dt>
<dd>
<p>
    Sequence must be added to local node with <code>add-seq</code>.
</p>
</dd>
<dt class="hdlist1">
Local-Destination
</dt>
<dd>
<p>
    Table must be added to local node and actual destination table must exists.
    This is for cases where table is added to some nodes with handler
    that does not need actual table to exist.
</p>
</dd>
<dt class="hdlist1">
Need-Table
</dt>
<dd>
<p>
    Physical table must exist in database.  It does not matter if it is
    replicated or not.
</p>
</dd>
<dt class="hdlist1">
Need-Sequence
</dt>
<dd>
<p>
    Sequence must exist in database.
</p>
</dd>
<dt class="hdlist1">
Need-Function
</dt>
<dd>
<p>
    Database function must exists.  The function name is in form <code>function_name(nargs)</code>.
    If the <code>(nargs)</code> portion is missed then nargs is taken as 0.
</p>
</dd>
<dt class="hdlist1">
Need-View
</dt>
<dd>
<p>
    A view must exist in database.
</p>
</dd>
<dt class="hdlist1">
Need-Schema
</dt>
<dd>
<p>
    Schema mist exist in database.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Londiste supports table renaming, where table is attached to queue with one name
but events are applied to local table with different name.  To make this
work with EXECUTE, the Local-Toble and Local-Destination support tag replacement,
where queue&#8217;s table name that is mentioned in attribute is replaced
with actual table name in local database:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>--*-- Local-Table: mytable
ALTER TABLE @mytable@ ...;</code></pre>
</div></div>
</div>
</div>
<div class="sect2">
<h3 id="_show_handlers_em_handler_em">show-handlers [<em>handler</em>]</h3>
<div class="paragraph"><p>Show info about all or a specific handler.</p></div>
</div>
<div class="sect2">
<h3 id="_wait_sync">wait-sync</h3>
<div class="paragraph"><p>Wait until all added tables are copied over.</p></div>
</div>
<div class="sect2">
<h3 id="_wait_provider">wait-provider</h3>
<div class="paragraph"><p>Wait until local node passes latest queue position on provider.</p></div>
</div>
<div class="sect2">
<h3 id="_wait_root">wait-root</h3>
<div class="paragraph"><p>Wait until local node passes latest queue position on root.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_internal_command">INTERNAL COMMAND</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_copy">copy</h3>
<div class="paragraph"><p>Copy table logic.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_exit_status">EXIT STATUS</h2>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
0
</dt>
<dd>
<p>
    Successful program execution.
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="_environment">ENVIRONMENT</h2>
<div class="sectionbody">
<div class="paragraph"><p>PostgreSQL environment variables can be used.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_examples_a_id_examples_a">EXAMPLES <a id="examples"></a></h2>
<div class="sectionbody">
<div class="paragraph"><p>Londiste is provided with HowTos to help you make your fisrt steps:</p></div>
<div class="ulist"><ul>
<li>
<p>
How to set up simple replication.
</p>
</li>
<li>
<p>
How to set up cascaded replication.
</p>
</li>
<li>
<p>
How to set up table partitioning (handlers).
</p>
</li>
</ul></div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated
 2016-01-15 17:16:23 UTC
</div>
</div>
</body>
</html>
skytools3 3.2.6-4 / usr / share / doc / skytools3 / londiste3.html
