v2-0001-doc-Clarify-synchronous_standby_names-parameter.patch

text/plain

Filename: v2-0001-doc-Clarify-synchronous_standby_names-parameter.patch
Type: text/plain
Part: 0
Message: Re: BUG #18663: synchronous_standby_names vs synchronous_commit vs pg_stat_replication

Patch

Format: format-patch
Series: patch v2-0001
Subject: doc: Clarify synchronous_standby_names parameter.
File+
doc/src/sgml/config.sgml 2 0
From 4bb69b55e060dc4124ba55dcd7dca164cc76c09d Mon Sep 17 00:00:00 2001
From: Fujii Masao <fujii@postgresql.org>
Date: Thu, 9 Jan 2025 09:26:36 +0900
Subject: [PATCH v2] doc: Clarify synchronous_standby_names parameter.

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 <asphator@gmail.com>
Discussion: https://postgr.es/m/18663-b02f75cb919f1b60@postgresql.org
---
 doc/src/sgml/config.sgml | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 8683f0bdf5..f1ab614575 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -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>
-- 
2.47.0