doc: Clarify synchronous_standby_names parameter.
authorFujii Masao <[email protected]>
Thu, 9 Jan 2025 12:04:49 +0000 (21:04 +0900)
committerFujii Masao <[email protected]>
Thu, 9 Jan 2025 12:04:49 +0000 (21:04 +0900)
The synchronous_standby_names GUC allows specifying num_sync,
the number of synchronous standbys transactions must wait for
replies from. This value must be an integer greater than zero.
This commit updates the documentation to clarify this requirement.

Reported-by: Asphator <[email protected]>
Discussion: https://postgr.es/m/18663-b02f75cb919f1b60@postgresql.org

doc/src/sgml/config.sgml

index 8683f0bdf53dc0126e9da59dc9aa4ac7f4abf5bc..f1ab614575a3d70006adfd04f442ad3fddb29e1d 100644 (file)
@@ -4715,6 +4715,8 @@ ANY <replaceable class="parameter">num_sync</replaceable> ( <replaceable class="
         wait for replies from,
         and <replaceable class="parameter">standby_name</replaceable>
         is the name of a standby server.
+        <replaceable class="parameter">num_sync</replaceable>
+        must be an integer value greater than zero.
         <literal>FIRST</literal> and <literal>ANY</literal> specify the method to choose
         synchronous standbys from the listed servers.
        </para>