open-dsi
/
postgres
mirror of https://github.com/postgres/postgres
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update PQparameterStatus and ParameterStatus docs

Browse Source 
Cover scram_iterations, which was added in commit b577743000.  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
pull/157/head
Alvaro Herrera 1 year ago
parent 902900b308
commit a39f1a365a
No known key found for this signature in database
GPG Key ID: 1C20ACB9D5C564AE
2 changed files with 40 additions and 46 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 43
      doc/src/sgml/libpq.sgml
  2. 43
      doc/src/sgml/protocol.sgml

43
doc/src/sgml/libpq.sgml
Unescape View File

@ -2509,30 +2509,27 @@ const char *PQparameterStatus(const PGconn *conn, const char *paramName);
</para> </para>
<para> <para>
Parameters reported as of the current release include Parameters reported as of the current release include:
<varname>server_version</varname>, <simplelist type="vert" columns="2">
<varname>server_encoding</varname>, <member><varname>application_name</varname></member>
<varname>client_encoding</varname>, <member><varname>client_encoding</varname></member>
<varname>application_name</varname>, <member><varname>DateStyle</varname></member>
<varname>default_transaction_read_only</varname>, <member><varname>default_transaction_read_only</varname></member>
<varname>in_hot_standby</varname>, <member><varname>in_hot_standby</varname></member>
<varname>is_superuser</varname>, <member><varname>integer_datetimes</varname></member>
<varname>session_authorization</varname>, <member><varname>IntervalStyle</varname></member>
<varname>DateStyle</varname>, <member><varname>is_superuser</varname></member>
<varname>IntervalStyle</varname>, <member><varname>scram_iterations</varname></member>
<varname>TimeZone</varname>, <member><varname>server_encoding</varname></member>
<varname>integer_datetimes</varname>, and <member><varname>server_version</varname></member>
<varname>standard_conforming_strings</varname>. <member><varname>session_authorization</varname></member>
(<varname>server_encoding</varname>, <varname>TimeZone</varname>, and <member><varname>standard_conforming_strings</varname></member>
<varname>integer_datetimes</varname> were not reported by releases before 8.0; <member><varname>TimeZone</varname></member>
<varname>standard_conforming_strings</varname> was not reported by releases </simplelist>
before 8.1; (<varname>default_transaction_read_only</varname> and
<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
<varname>in_hot_standby</varname> were not reported by releases before <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 Note that
<varname>server_version</varname>, <varname>server_version</varname>,
<varname>server_encoding</varname> and <varname>server_encoding</varname> and

43
doc/src/sgml/protocol.sgml
Unescape View File

@ -1314,30 +1314,27 @@ SELCT 1/0;<!-- this typo is intentional -->
<para> <para>
At present there is a hard-wired set of parameters for which At present there is a hard-wired set of parameters for which
ParameterStatus will be generated: they are ParameterStatus will be generated. They are:
<varname>server_version</varname>, <simplelist type="vert" columns="2">
<varname>server_encoding</varname>, <member><varname>application_name</varname></member>
<varname>client_encoding</varname>, <member><varname>client_encoding</varname></member>
<varname>application_name</varname>, <member><varname>DateStyle</varname></member>
<varname>default_transaction_read_only</varname>, <member><varname>default_transaction_read_only</varname></member>
<varname>in_hot_standby</varname>, <member><varname>in_hot_standby</varname></member>
<varname>is_superuser</varname>, <member><varname>integer_datetimes</varname></member>
<varname>session_authorization</varname>, <member><varname>IntervalStyle</varname></member>
<varname>DateStyle</varname>, <member><varname>is_superuser</varname></member>
<varname>IntervalStyle</varname>, <member><varname>scram_iterations</varname></member>
<varname>TimeZone</varname>, <member><varname>server_encoding</varname></member>
<varname>integer_datetimes</varname>, and <member><varname>server_version</varname></member>
<varname>standard_conforming_strings</varname>. <member><varname>session_authorization</varname></member>
(<varname>server_encoding</varname>, <varname>TimeZone</varname>, and <member><varname>standard_conforming_strings</varname></member>
<varname>integer_datetimes</varname> were not reported by releases before 8.0; <member><varname>TimeZone</varname></member>
<varname>standard_conforming_strings</varname> was not reported by releases </simplelist>
before 8.1; (<varname>default_transaction_read_only</varname> and
<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
<varname>in_hot_standby</varname> were not reported by releases before <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 Note that
<varname>server_version</varname>, <varname>server_version</varname>,
<varname>server_encoding</varname> and <varname>server_encoding</varname> and

Write Preview
Loading…
Cancel
Save