git.postgresql.org Git - postgresql.git/commitdiff

git projects / postgresql.git / commitdiff

summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: fe9e658)

Doc: clarify behavior of boolean options in replication commands.

author Tom Lane <tgl@sss.pgh.pa.us>

2023年1月30日 16:59:37 +0000 (11:59 -0500)

committer Tom Lane <tgl@sss.pgh.pa.us>

2023年1月30日 16:59:37 +0000 (11:59 -0500)

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

doc/src/sgml/ref/alter_subscription.sgml patch | blob | blame | history

doc/src/sgml/ref/create_publication.sgml patch | blob | blame | history

doc/src/sgml/ref/create_subscription.sgml patch | blob | blame | history

diff --git a/doc/src/sgml/ref/alter_subscription.sgml b/doc/src/sgml/ref/alter_subscription.sgml

index ad93553a1d5fa1d3c3134e789e830be7f247fd23..964fcbb8ff7b589fc09d603e2b4537ab132b3cd0 100644 (file)

--- 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 e229384e6ff35c01c2bb1cf69d310411a5ffd219..370dac2ccf2e92e645bd2442cbdf3c0d8cc0555e 100644 (file)

--- 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 eba72c6af623404ca2ca9da1b630da1ea9193ebe..51c45f17c7d9a7fc5ce3c5010346f818ed83ed98 100644 (file)

--- 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">

This is the main PostgreSQL git repository.