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

git projects / postgresql.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 902900b)
Update PQparameterStatus and ParameterStatus docs
author Alvaro Herrera <alvherre@alvh.no-ip.org>
Wed, 7 Feb 2024 18:25:07 +0000 (19:25 +0100)
committer Alvaro Herrera <alvherre@alvh.no-ip.org>
Wed, 7 Feb 2024 18:25:07 +0000 (19:25 +0100)
Cover scram_iterations, which was added in commit b577743000cd. While
at it, turn the list into a <simplelist> with 2 columns, which is much
nicer to read.

In master, remove mentions of antediluvian versions before which some
parameters were not reported.

Noticed while investigating a question by Maiquel Grassi.

Backpatch to 16.

Reviewed-by: Daniel Gustafsson <daniel@yesql.se>
Reviewed-by: Jelte Fennema-Nio <postgres@jeltef.nl>
Discussion: https://postgr.es/m/202401301236.mc5ebrohhtsd@alvherre.pgsql

doc/src/sgml/libpq.sgml patch | blob | blame | history
doc/src/sgml/protocol.sgml patch | blob | blame | history

diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml
index d0d5aefadc05d5d99267607f4735a2b7ccf2706c..1d8998efb2a8ed27b69487d887a7b9e3db55ccba 100644 (file)
--- a/doc/src/sgml/libpq.sgml
+++ b/doc/src/sgml/libpq.sgml
@@ -2509,30 +2509,27 @@ const char *PQparameterStatus(const PGconn *conn, const char *paramName);
</para>
<para>
- Parameters reported as of the current release include
- <varname>server_version</varname>,
- <varname>server_encoding</varname>,
- <varname>client_encoding</varname>,
- <varname>application_name</varname>,
- <varname>default_transaction_read_only</varname>,
- <varname>in_hot_standby</varname>,
- <varname>is_superuser</varname>,
- <varname>session_authorization</varname>,
- <varname>DateStyle</varname>,
- <varname>IntervalStyle</varname>,
- <varname>TimeZone</varname>,
- <varname>integer_datetimes</varname>, and
- <varname>standard_conforming_strings</varname>.
- (<varname>server_encoding</varname>, <varname>TimeZone</varname>, and
- <varname>integer_datetimes</varname> were not reported by releases before 8.0;
- <varname>standard_conforming_strings</varname> was not reported by releases
- before 8.1;
- <varname>IntervalStyle</varname> was not reported by releases before 8.4;
- <varname>application_name</varname> was not reported by releases before
- 9.0;
- <varname>default_transaction_read_only</varname> and
+ Parameters reported as of the current release include:
+ <simplelist type="vert" columns="2">
+ <member><varname>application_name</varname></member>
+ <member><varname>client_encoding</varname></member>
+ <member><varname>DateStyle</varname></member>
+ <member><varname>default_transaction_read_only</varname></member>
+ <member><varname>in_hot_standby</varname></member>
+ <member><varname>integer_datetimes</varname></member>
+ <member><varname>IntervalStyle</varname></member>
+ <member><varname>is_superuser</varname></member>
+ <member><varname>scram_iterations</varname></member>
+ <member><varname>server_encoding</varname></member>
+ <member><varname>server_version</varname></member>
+ <member><varname>session_authorization</varname></member>
+ <member><varname>standard_conforming_strings</varname></member>
+ <member><varname>TimeZone</varname></member>
+ </simplelist>
+ (<varname>default_transaction_read_only</varname> and
<varname>in_hot_standby</varname> were not reported by releases before
- 14.)
+ 14; <varname>scram_iterations</varname> was not reported by releases
+ before 16.)
Note that
<varname>server_version</varname>,
<varname>server_encoding</varname> and
diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml
index bb4fef1f519415dc5cc0f0ba01ea4cc66d7e41c2..ed1d62f5f8a5276b427a82f53c29429a4bb16607 100644 (file)
--- a/doc/src/sgml/protocol.sgml
+++ b/doc/src/sgml/protocol.sgml
@@ -1314,30 +1314,27 @@ SELCT 1/0;<!-- this typo is intentional -->
<para>
At present there is a hard-wired set of parameters for which
- ParameterStatus will be generated: they are
- <varname>server_version</varname>,
- <varname>server_encoding</varname>,
- <varname>client_encoding</varname>,
- <varname>application_name</varname>,
- <varname>default_transaction_read_only</varname>,
- <varname>in_hot_standby</varname>,
- <varname>is_superuser</varname>,
- <varname>session_authorization</varname>,
- <varname>DateStyle</varname>,
- <varname>IntervalStyle</varname>,
- <varname>TimeZone</varname>,
- <varname>integer_datetimes</varname>, and
- <varname>standard_conforming_strings</varname>.
- (<varname>server_encoding</varname>, <varname>TimeZone</varname>, and
- <varname>integer_datetimes</varname> were not reported by releases before 8.0;
- <varname>standard_conforming_strings</varname> was not reported by releases
- before 8.1;
- <varname>IntervalStyle</varname> was not reported by releases before 8.4;
- <varname>application_name</varname> was not reported by releases before
- 9.0;
- <varname>default_transaction_read_only</varname> and
+ ParameterStatus will be generated. They are:
+ <simplelist type="vert" columns="2">
+ <member><varname>application_name</varname></member>
+ <member><varname>client_encoding</varname></member>
+ <member><varname>DateStyle</varname></member>
+ <member><varname>default_transaction_read_only</varname></member>
+ <member><varname>in_hot_standby</varname></member>
+ <member><varname>integer_datetimes</varname></member>
+ <member><varname>IntervalStyle</varname></member>
+ <member><varname>is_superuser</varname></member>
+ <member><varname>scram_iterations</varname></member>
+ <member><varname>server_encoding</varname></member>
+ <member><varname>server_version</varname></member>
+ <member><varname>session_authorization</varname></member>
+ <member><varname>standard_conforming_strings</varname></member>
+ <member><varname>TimeZone</varname></member>
+ </simplelist>
+ (<varname>default_transaction_read_only</varname> and
<varname>in_hot_standby</varname> were not reported by releases before
- 14.)
+ 14; <varname>scram_iterations</varname> was not reported by releases
+ before 16.)
Note that
<varname>server_version</varname>,
<varname>server_encoding</varname> and
This is the main PostgreSQL git repository.
RSS Atom

AltStyle によって変換されたページ (->オリジナル) /