github/repmgr
1
0
Fork 0
mirror of https://github.com/EnterpriseDB/repmgr.git synced 2026-03-26 00:26:30 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

doc: clarify configuration file changes

Browse Source
This commit is contained in:
Ian Barwick
2019-09-17 13:01:03 +09:00
parent 8489fd061f
commit 98e96f4375
2 changed files with 36 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/appendix-release-notes.xml
View File

@@ -41,7 +41,13 @@
<sect3 id="repmgr-5-0-config-file-parsing"> <sect3 id="repmgr-5-0-config-file-parsing">
<title>Configuration file parsing has been made stricter</title> <title>Configuration file parsing has been made stricter</title>
<para> <para>
String parameters should always be enclosed in single quotes. &repmgr; now parses <link linkend="configuration-file-format">configuration files</link>
in the same way that PostgreSQL itself does, which means some files used with
earlier &repmgr; versions may need slight modification before they can be used
with &repmgr; 5 and later.
</para>
<para>
The main change is that string parameters should always be enclosed in single quotes.
</para> </para>
<para> <para>
For example, in &repmgr; 4.4 and earlier, the following <filename>repmgr.conf</filename> For example, in &repmgr; 4.4 and earlier, the following <filename>repmgr.conf</filename>

37
doc/configuration-file.xml
View File

@@ -31,6 +31,8 @@
<secondary>format</secondary> <secondary>format</secondary>
</indexterm> </indexterm>
<para> <para>
<filename>repmgr.conf</filename> is a plain text file with one parameter/value <filename>repmgr.conf</filename> is a plain text file with one parameter/value
combination per line. combination per line.
@@ -39,14 +41,10 @@
Whitespace is insignificant (except within a quoted parameter value) and blank lines are ignored. Whitespace is insignificant (except within a quoted parameter value) and blank lines are ignored.
Hash marks (<literal>#</literal>) designate the remainder of the line as a comment. Hash marks (<literal>#</literal>) designate the remainder of the line as a comment.
Parameter values that are not simple identifiers or numbers should be single-quoted. Parameter values that are not simple identifiers or numbers should be single-quoted.
Note that single quote cannot be embedded in a parameter value.
</para> </para>
<important> <para>
<para> To embed a single quote in a parameter value, write either two quotes (preferred) or backslash-quote.
&repmgr; will interpret double-quotes as being part of a string value; only use single quotes </para>
to quote parameter values.
</para>
</important>
<para> <para>
Example of a valid <filename>repmgr.conf</filename> file: Example of a valid <filename>repmgr.conf</filename> file:
@@ -56,9 +54,32 @@
node_id=1 node_id=1
node_name= node1 node_name= node1
conninfo ='host=node1 dbname=repmgr user=repmgr connect_timeout=2' conninfo ='host=node1 dbname=repmgr user=repmgr connect_timeout=2'
data_directory = /var/lib/pgsql/12/data</programlisting> data_directory = '/var/lib/pgsql/12/data'</programlisting>
</para> </para>
<note>
<para>
Beginning with <link linkend="release-5.0">repmgr 5.0</link>, configuration
file parsing has been tightened up and now matches the way PostgreSQL
itself parses configuration files.
</para>
<para>
This means <filename>repmgr.conf</filename> files used with earlier &repmgr;
versions may need slight modification before they can be used with &repmgr; 5
and later.
</para>
<para>
The main change is that &repmgr; requires most string values to be
enclosed in single quotes. For example, this was previously valid:
<programlisting>
conninfo=host=node1 user=repmgr dbname=repmgr connect_timeout=2</programlisting>
but must now be changed to:
<programlisting>
conninfo='host=node1 user=repmgr dbname=repmgr connect_timeout=2'</programlisting>
</para>
</note>
</sect2> </sect2>