From f743a2bbd4e511ad58b6ce01f81841e5e1611474 Mon Sep 17 00:00:00 2001 From: Tom Lane Date: Fri, 29 Jan 2021 10:46:14 -0500 Subject: [PATCH] Doc: improve cross-references for SET/SHOW. The corresponding functions set_config and current_setting were mostly not hyperlinked. Clarify their descriptions a tad, too. Discussion: https://postgr.es/m/161183356250.4077.687338658090583892@wrigleys.postgresql.org --- doc/src/sgml/config.sgml | 10 ++++++---- doc/src/sgml/func.sgml | 13 +++++++------ doc/src/sgml/ref/set.sgml | 2 +- doc/src/sgml/ref/show.sgml | 2 +- 4 files changed, 15 insertions(+), 12 deletions(-) diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml index f1037df5a9..e17cdcc816 100644 --- a/doc/src/sgml/config.sgml +++ b/doc/src/sgml/config.sgml @@ -263,8 +263,9 @@ shared_buffers = 128MB The SHOW command allows inspection of the - current value of all parameters. The corresponding function is - current_setting(setting_name text). + current value of any parameter. The corresponding SQL function is + current_setting(setting_name text) + (see ). @@ -273,8 +274,9 @@ shared_buffers = 128MB The SET command allows modification of the current value of those parameters that can be set locally to a session; it has no effect on other sessions. - The corresponding function is - set_config(setting_name, new_value, is_local). + The corresponding SQL function is + set_config(setting_name, new_value, is_local) + (see ). diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index de1b1b6deb..f30eaa3e4b 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -24593,8 +24593,9 @@ SELECT collation for ('foo' COLLATE "de_DE"); setting setting_name. If there is no such setting, current_setting throws an error unless missing_ok is supplied and - is true. This function corresponds to - the SQL command SHOW. + is true (in which case NULL is returned). + This function corresponds to + the SQL command . current_setting('datestyle') @@ -24617,10 +24618,10 @@ SELECT collation for ('foo' COLLATE "de_DE"); Sets the parameter setting_name to new_value, and returns that value. If is_local is true, the new - value will only apply for the current transaction. If you want the new - value to apply for the current session, use false - instead. This function corresponds to the SQL - command SET. + value will only apply during the current transaction. If you want the + new value to apply for the rest of the current session, + use false instead. This function corresponds to + the SQL command . set_config('log_statement_stats', 'off', false) diff --git a/doc/src/sgml/ref/set.sgml b/doc/src/sgml/ref/set.sgml index 63f312e812..339ee9eec9 100644 --- a/doc/src/sgml/ref/set.sgml +++ b/doc/src/sgml/ref/set.sgml @@ -267,7 +267,7 @@ SELECT setseed(value); The function set_config provides equivalent - functionality; see . + functionality; see . Also, it is possible to UPDATE the pg_settings system view to perform the equivalent of SET. diff --git a/doc/src/sgml/ref/show.sgml b/doc/src/sgml/ref/show.sgml index 945b0491b1..93789ee0be 100644 --- a/doc/src/sgml/ref/show.sgml +++ b/doc/src/sgml/ref/show.sgml @@ -129,7 +129,7 @@ SHOW ALL The function current_setting produces - equivalent output; see . + equivalent output; see . Also, the pg_settings system view produces the same information.