From a39f1a365a3b99149ba0038ef7e39d6bff2560c9 Mon Sep 17 00:00:00 2001 From: Alvaro Herrera Date: Wed, 7 Feb 2024 19:25:07 +0100 Subject: [PATCH] Update PQparameterStatus and ParameterStatus docs Cover scram_iterations, which was added in commit b577743000cd. While at it, turn the list into a 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 Reviewed-by: Jelte Fennema-Nio Discussion: https://postgr.es/m/202401301236.mc5ebrohhtsd@alvherre.pgsql --- doc/src/sgml/libpq.sgml | 43 ++++++++++++++++++-------------------- doc/src/sgml/protocol.sgml | 43 ++++++++++++++++++-------------------- 2 files changed, 40 insertions(+), 46 deletions(-) diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml index d0d5aefadc..1d8998efb2 100644 --- 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); - Parameters reported as of the current release include - server_version, - server_encoding, - client_encoding, - application_name, - default_transaction_read_only, - in_hot_standby, - is_superuser, - session_authorization, - DateStyle, - IntervalStyle, - TimeZone, - integer_datetimes, and - standard_conforming_strings. - (server_encoding, TimeZone, and - integer_datetimes were not reported by releases before 8.0; - standard_conforming_strings was not reported by releases - before 8.1; - IntervalStyle was not reported by releases before 8.4; - application_name was not reported by releases before - 9.0; - default_transaction_read_only and + Parameters reported as of the current release include: + + application_name + client_encoding + DateStyle + default_transaction_read_only + in_hot_standby + integer_datetimes + IntervalStyle + is_superuser + scram_iterations + server_encoding + server_version + session_authorization + standard_conforming_strings + TimeZone + + (default_transaction_read_only and in_hot_standby were not reported by releases before - 14.) + 14; scram_iterations was not reported by releases + before 16.) Note that server_version, server_encoding and diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml index bb4fef1f51..ed1d62f5f8 100644 --- a/doc/src/sgml/protocol.sgml +++ b/doc/src/sgml/protocol.sgml @@ -1314,30 +1314,27 @@ SELCT 1/0; At present there is a hard-wired set of parameters for which - ParameterStatus will be generated: they are - server_version, - server_encoding, - client_encoding, - application_name, - default_transaction_read_only, - in_hot_standby, - is_superuser, - session_authorization, - DateStyle, - IntervalStyle, - TimeZone, - integer_datetimes, and - standard_conforming_strings. - (server_encoding, TimeZone, and - integer_datetimes were not reported by releases before 8.0; - standard_conforming_strings was not reported by releases - before 8.1; - IntervalStyle was not reported by releases before 8.4; - application_name was not reported by releases before - 9.0; - default_transaction_read_only and + ParameterStatus will be generated. They are: + + application_name + client_encoding + DateStyle + default_transaction_read_only + in_hot_standby + integer_datetimes + IntervalStyle + is_superuser + scram_iterations + server_encoding + server_version + session_authorization + standard_conforming_strings + TimeZone + + (default_transaction_read_only and in_hot_standby were not reported by releases before - 14.) + 14; scram_iterations was not reported by releases + before 16.) Note that server_version, server_encoding and