aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBruce Momjian <bruce@momjian.us>2023-10-31 10:21:32 -0400
committerBruce Momjian <bruce@momjian.us>2023-10-31 10:21:32 -0400
commit664f3081712fa08ecfc5c6d486475fa1f7edbe36 (patch)
tree9ee3b93ffcc35263226c715bdef1df13103d8eaa
parent83981bcbace1e0eac599cdac196213e78f6d545a (diff)
downloadpostgresql-664f3081712fa08ecfc5c6d486475fa1f7edbe36.tar.gz
postgresql-664f3081712fa08ecfc5c6d486475fa1f7edbe36.zip
doc: improve ALTER SYSTEM description of value list quoting
Reported-by: splarv@ya.ru Discussion: https://postgr.es/m/167105927893.1897.13227723035830709578@wrigleys.postgresql.org Backpatch-through: 11
-rw-r--r--doc/src/sgml/ref/alter_system.sgml10
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/src/sgml/ref/alter_system.sgml b/doc/src/sgml/ref/alter_system.sgml
index 6f8bd39eaf8..bea5714ba1a 100644
--- a/doc/src/sgml/ref/alter_system.sgml
+++ b/doc/src/sgml/ref/alter_system.sgml
@@ -21,7 +21,7 @@ PostgreSQL documentation
<refsynopsisdiv>
<synopsis>
-ALTER SYSTEM SET <replaceable class="parameter">configuration_parameter</replaceable> { TO | = } { <replaceable class="parameter">value</replaceable> | '<replaceable class="parameter">value</replaceable>' | DEFAULT }
+ALTER SYSTEM SET <replaceable class="parameter">configuration_parameter</replaceable> { TO | = } { <replaceable class="parameter">value</replaceable> [, ...] | DEFAULT }
ALTER SYSTEM RESET <replaceable class="parameter">configuration_parameter</replaceable>
ALTER SYSTEM RESET ALL
@@ -83,9 +83,17 @@ ALTER SYSTEM RESET ALL
New value of the parameter. Values can be specified as string
constants, identifiers, numbers, or comma-separated lists of
these, as appropriate for the particular parameter.
+ Values that are neither numbers nor valid identifiers must be quoted.
<literal>DEFAULT</literal> can be written to specify removing the
parameter and its value from <filename>postgresql.auto.conf</filename>.
</para>
+
+ <para>
+ For some list-accepting parameters, quoted values will produce
+ double-quoted output to preserve whitespace and commas; for others,
+ double-quotes must be used inside single-quoted strings to get
+ this effect.
+ </para>
</listitem>
</varlistentry>
</variablelist>