Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 17f3196

Browse files
committed
Update PQparameterStatus and ParameterStatus docs
Cover scram_iterations, which was added in commit b577743. 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
1 parent b78fa85 commit 17f3196

File tree

2 files changed

+38
-30
lines changed

2 files changed

+38
-30
lines changed

doc/src/sgml/libpq.sgml

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2509,20 +2509,23 @@ const char *PQparameterStatus(const PGconn *conn, const char *paramName);
25092509
</para>
25102510

25112511
<para>
2512-
Parameters reported as of the current release include
2513-
<varname>server_version</varname>,
2514-
<varname>server_encoding</varname>,
2515-
<varname>client_encoding</varname>,
2516-
<varname>application_name</varname>,
2517-
<varname>default_transaction_read_only</varname>,
2518-
<varname>in_hot_standby</varname>,
2519-
<varname>is_superuser</varname>,
2520-
<varname>session_authorization</varname>,
2521-
<varname>DateStyle</varname>,
2522-
<varname>IntervalStyle</varname>,
2523-
<varname>TimeZone</varname>,
2524-
<varname>integer_datetimes</varname>, and
2525-
<varname>standard_conforming_strings</varname>.
2512+
Parameters reported as of the current release include:
2513+
<simplelist type="vert" columns="2">
2514+
<member><varname>application_name</varname></member>
2515+
<member><varname>client_encoding</varname></member>
2516+
<member><varname>DateStyle</varname></member>
2517+
<member><varname>default_transaction_read_only</varname></member>
2518+
<member><varname>in_hot_standby</varname></member>
2519+
<member><varname>integer_datetimes</varname></member>
2520+
<member><varname>IntervalStyle</varname></member>
2521+
<member><varname>is_superuser</varname></member>
2522+
<member><varname>scram_iterations</varname></member>
2523+
<member><varname>server_encoding</varname></member>
2524+
<member><varname>server_version</varname></member>
2525+
<member><varname>session_authorization</varname></member>
2526+
<member><varname>standard_conforming_strings</varname></member>
2527+
<member><varname>TimeZone</varname></member>
2528+
</simplelist>
25262529
(<varname>server_encoding</varname>, <varname>TimeZone</varname>, and
25272530
<varname>integer_datetimes</varname> were not reported by releases before 8.0;
25282531
<varname>standard_conforming_strings</varname> was not reported by releases
@@ -2532,7 +2535,8 @@ const char *PQparameterStatus(const PGconn *conn, const char *paramName);
25322535
9.0;
25332536
<varname>default_transaction_read_only</varname> and
25342537
<varname>in_hot_standby</varname> were not reported by releases before
2535-
14.)
2538+
14; <varname>scram_iterations</varname> was not reported by releases
2539+
before 16.)
25362540
Note that
25372541
<varname>server_version</varname>,
25382542
<varname>server_encoding</varname> and

doc/src/sgml/protocol.sgml

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1314,20 +1314,23 @@ SELCT 1/0;<!-- this typo is intentional -->
13141314

13151315
<para>
13161316
At present there is a hard-wired set of parameters for which
1317-
ParameterStatus will be generated: they are
1318-
<varname>server_version</varname>,
1319-
<varname>server_encoding</varname>,
1320-
<varname>client_encoding</varname>,
1321-
<varname>application_name</varname>,
1322-
<varname>default_transaction_read_only</varname>,
1323-
<varname>in_hot_standby</varname>,
1324-
<varname>is_superuser</varname>,
1325-
<varname>session_authorization</varname>,
1326-
<varname>DateStyle</varname>,
1327-
<varname>IntervalStyle</varname>,
1328-
<varname>TimeZone</varname>,
1329-
<varname>integer_datetimes</varname>, and
1330-
<varname>standard_conforming_strings</varname>.
1317+
ParameterStatus will be generated. They are:
1318+
<simplelist type="vert" columns="2">
1319+
<member><varname>application_name</varname></member>
1320+
<member><varname>client_encoding</varname></member>
1321+
<member><varname>DateStyle</varname></member>
1322+
<member><varname>default_transaction_read_only</varname></member>
1323+
<member><varname>in_hot_standby</varname></member>
1324+
<member><varname>integer_datetimes</varname></member>
1325+
<member><varname>IntervalStyle</varname></member>
1326+
<member><varname>is_superuser</varname></member>
1327+
<member><varname>scram_iterations</varname></member>
1328+
<member><varname>server_encoding</varname></member>
1329+
<member><varname>server_version</varname></member>
1330+
<member><varname>session_authorization</varname></member>
1331+
<member><varname>standard_conforming_strings</varname></member>
1332+
<member><varname>TimeZone</varname></member>
1333+
</simplelist>
13311334
(<varname>server_encoding</varname>, <varname>TimeZone</varname>, and
13321335
<varname>integer_datetimes</varname> were not reported by releases before 8.0;
13331336
<varname>standard_conforming_strings</varname> was not reported by releases
@@ -1337,7 +1340,8 @@ SELCT 1/0;<!-- this typo is intentional -->
13371340
9.0;
13381341
<varname>default_transaction_read_only</varname> and
13391342
<varname>in_hot_standby</varname> were not reported by releases before
1340-
14.)
1343+
14; <varname>scram_iterations</varname> was not reported by releases
1344+
before 16.)
13411345
Note that
13421346
<varname>server_version</varname>,
13431347
<varname>server_encoding</varname> and

0 commit comments

Comments
 (0)