Document "repmgr standby unregister"

This commit is contained in:
Ian Barwick
2017-09-22 17:40:14 +09:00
parent 9697e2ccfc
commit cb61b447f3
2 changed files with 31 additions and 0 deletions

View File

@@ -148,6 +148,36 @@
</sect2>
</sect1>
<sect1 id="repmgr-standby-unregister" xreflabel="repmgr standby inregister">
<indexterm><primary>repmgr standby unregister</primary></indexterm>
<title>repmgr standby unregister</title>
<para>
Unregisters a standby with `repmgr`. This command does not affect the actual
replication, just removes the standby's entry from the &repmgr; metadata.
</para>
<para>
To unregister a running standby, execute:
<programlisting>
repmgr standby unregister -f /etc/repmgr.conf</programlisting>
</para>
<para>
This will remove the standby record from &repmgr;'s internal metadata
table (<literal>repmgr.nodes</literal>). A <literal>standby_unregister</literal>
event notification will be recorded in the <literal>repmgr.events</literal> table.
</para>
<para>
If the standby is not running, the command can be executed on another
node by providing the id of the node to be unregistered using
the command line parameter <literal>--node-id</literal>, e.g. executing the following
command on the master server will unregister the standby with
id <literal>3</literal>:
<programlisting>
repmgr standby unregister -f /etc/repmgr.conf --node-id=3
</programlisting>
</para>
</sect1>
<sect1 id="repmgr-standby-promote" xreflabel="repmgr standby promote">
<indexterm>
<primary>repmgr standby promote</primary>

View File

@@ -70,6 +70,7 @@
&configuration;
&cloning-standbys;
&promoting-standby;
&follow-new-primary;
&command-reference;
</part>