summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Lane2023-01-30 16:59:37 +0000
committerTom Lane2023-01-30 16:59:37 +0000
commitec7e053a98f39a9e3c7e6d35f0d2e83933882399 (patch)
treefcd59a8d9defc49d85c9eab4bf47abfc10928d58
parentfe9e658f4d7fbc12d2b6a74c4ee90c73e53d68ef (diff)
Doc: clarify behavior of boolean options in replication commands.
defGetBoolean() allows the "value" part of "option = value" syntax to be omitted, in which case it's taken as "true". This is acknowledged in our syntax summaries for relevant commands, but we don't seem to have documented the actual behavior anywhere. Do so for CREATE/ALTER PUBLICATION/SUBSCRIPTION. Use generic boilerplate text for this, with the idea that we can copy-and-paste it into other relevant reference pages, whenever someone gets around to that. Peter Smith, edited a bit by me Discussion: https://postgr.es/m/CAHut+PvwjZfdGt2R8HTXgSZft=jZKymrS8KUg31pS7zqaaWKKw@mail.gmail.com
-rw-r--r--doc/src/sgml/ref/alter_subscription.sgml7
-rw-r--r--doc/src/sgml/ref/create_publication.sgml7
-rw-r--r--doc/src/sgml/ref/create_subscription.sgml7
3 files changed, 21 insertions, 0 deletions
diff --git a/doc/src/sgml/ref/alter_subscription.sgml b/doc/src/sgml/ref/alter_subscription.sgml
index ad93553a1d..964fcbb8ff 100644
--- a/doc/src/sgml/ref/alter_subscription.sgml
+++ b/doc/src/sgml/ref/alter_subscription.sgml
@@ -277,6 +277,13 @@ ALTER SUBSCRIPTION <replaceable class="parameter">name</replaceable> RENAME TO <
</listitem>
</varlistentry>
</variablelist>
+
+ <para>
+ When specifying a parameter of type <type>boolean</type>, the
+ <literal>=</literal> <replaceable class="parameter">value</replaceable>
+ part can be omitted, which is equivalent to
+ specifying <literal>TRUE</literal>.
+ </para>
</refsect1>
<refsect1>
diff --git a/doc/src/sgml/ref/create_publication.sgml b/doc/src/sgml/ref/create_publication.sgml
index e229384e6f..370dac2ccf 100644
--- a/doc/src/sgml/ref/create_publication.sgml
+++ b/doc/src/sgml/ref/create_publication.sgml
@@ -217,6 +217,13 @@ CREATE PUBLICATION <replaceable class="parameter">name</replaceable>
</varlistentry>
</variablelist>
+
+ <para>
+ When specifying a parameter of type <type>boolean</type>, the
+ <literal>=</literal> <replaceable class="parameter">value</replaceable>
+ part can be omitted, which is equivalent to
+ specifying <literal>TRUE</literal>.
+ </para>
</refsect1>
<refsect1>
diff --git a/doc/src/sgml/ref/create_subscription.sgml b/doc/src/sgml/ref/create_subscription.sgml
index eba72c6af6..51c45f17c7 100644
--- a/doc/src/sgml/ref/create_subscription.sgml
+++ b/doc/src/sgml/ref/create_subscription.sgml
@@ -354,6 +354,13 @@ CREATE SUBSCRIPTION <replaceable class="parameter">subscription_name</replaceabl
</listitem>
</varlistentry>
</variablelist>
+
+ <para>
+ When specifying a parameter of type <type>boolean</type>, the
+ <literal>=</literal> <replaceable class="parameter">value</replaceable>
+ part can be omitted, which is equivalent to
+ specifying <literal>TRUE</literal>.
+ </para>
</refsect1>
<refsect1 id="sql-createsubscription-notes" xreflabel="Notes">