diff options
author | Tom Lane <tgl@sss.pgh.pa.us> | 2021-01-29 10:46:14 -0500 |
---|---|---|
committer | Tom Lane <tgl@sss.pgh.pa.us> | 2021-01-29 10:46:14 -0500 |
commit | 2a01bc275be1a7d117944b1a58ea1fe5f6c377c6 (patch) | |
tree | e128a0bbf8479a93cf6d8cd773b194504e0b1f72 | |
parent | 9915fe22969a46f9d06d6c2c53dea7269ec4cc7e (diff) | |
download | postgresql-2a01bc275be1a7d117944b1a58ea1fe5f6c377c6.tar.gz postgresql-2a01bc275be1a7d117944b1a58ea1fe5f6c377c6.zip |
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
-rw-r--r-- | doc/src/sgml/config.sgml | 10 | ||||
-rw-r--r-- | doc/src/sgml/func.sgml | 13 | ||||
-rw-r--r-- | doc/src/sgml/ref/set.sgml | 2 | ||||
-rw-r--r-- | 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 97610de287d..6999c4a2a36 100644 --- a/doc/src/sgml/config.sgml +++ b/doc/src/sgml/config.sgml @@ -263,8 +263,9 @@ shared_buffers = 128MB <listitem> <para> The <xref linkend="sql-show"/> command allows inspection of the - current value of all parameters. The corresponding function is - <function>current_setting(setting_name text)</function>. + current value of any parameter. The corresponding SQL function is + <function>current_setting(setting_name text)</function> + (see <xref linkend="functions-admin-set"/>). </para> </listitem> @@ -273,8 +274,9 @@ shared_buffers = 128MB The <xref linkend="sql-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 - <function>set_config(setting_name, new_value, is_local)</function>. + The corresponding SQL function is + <function>set_config(setting_name, new_value, is_local)</function> + (see <xref linkend="functions-admin-set"/>). </para> </listitem> </itemizedlist> diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index 7ba867b1b5c..6f1133365b8 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -23930,8 +23930,9 @@ SELECT collation for ('foo' COLLATE "de_DE"); setting <parameter>setting_name</parameter>. If there is no such setting, <function>current_setting</function> throws an error unless <parameter>missing_ok</parameter> is supplied and - is <literal>true</literal>. This function corresponds to - the <acronym>SQL</acronym> command <command>SHOW</command>. + is <literal>true</literal> (in which case NULL is returned). + This function corresponds to + the <acronym>SQL</acronym> command <xref linkend="sql-show"/>. </para> <para> <literal>current_setting('datestyle')</literal> @@ -23954,10 +23955,10 @@ SELECT collation for ('foo' COLLATE "de_DE"); Sets the parameter <parameter>setting_name</parameter> to <parameter>new_value</parameter>, and returns that value. If <parameter>is_local</parameter> is <literal>true</literal>, the new - value will only apply for the current transaction. If you want the new - value to apply for the current session, use <literal>false</literal> - instead. This function corresponds to the SQL - command <command>SET</command>. + value will only apply during the current transaction. If you want the + new value to apply for the rest of the current session, + use <literal>false</literal> instead. This function corresponds to + the SQL command <xref linkend="sql-set"/>. </para> <para> <literal>set_config('log_statement_stats', 'off', false)</literal> diff --git a/doc/src/sgml/ref/set.sgml b/doc/src/sgml/ref/set.sgml index 63f312e812a..339ee9eec94 100644 --- a/doc/src/sgml/ref/set.sgml +++ b/doc/src/sgml/ref/set.sgml @@ -267,7 +267,7 @@ SELECT setseed(<replaceable>value</replaceable>); <para> The function <function>set_config</function> provides equivalent - functionality; see <xref linkend="functions-admin"/>. + functionality; see <xref linkend="functions-admin-set"/>. Also, it is possible to UPDATE the <link linkend="view-pg-settings"><structname>pg_settings</structname></link> system view to perform the equivalent of <command>SET</command>. diff --git a/doc/src/sgml/ref/show.sgml b/doc/src/sgml/ref/show.sgml index 945b0491b14..93789ee0be0 100644 --- a/doc/src/sgml/ref/show.sgml +++ b/doc/src/sgml/ref/show.sgml @@ -129,7 +129,7 @@ SHOW ALL <para> The function <function>current_setting</function> produces - equivalent output; see <xref linkend="functions-admin"/>. + equivalent output; see <xref linkend="functions-admin-set"/>. Also, the <link linkend="view-pg-settings"><structname>pg_settings</structname></link> system view produces the same information. |