Skip to content

Commit f743a2b

Browse files
committed
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
1 parent b416454 commit f743a2b

File tree

4 files changed

+15
-12
lines changed

4 files changed

+15
-12
lines changed

doc/src/sgml/config.sgml

+6-4
Original file line numberDiff line numberDiff line change
@@ -263,8 +263,9 @@ shared_buffers = 128MB
263263
<listitem>
264264
<para>
265265
The <link linkend="sql-show"><command>SHOW</command></link> command allows inspection of the
266-
current value of all parameters. The corresponding function is
267-
<function>current_setting(setting_name text)</function>.
266+
current value of any parameter. The corresponding SQL function is
267+
<function>current_setting(setting_name text)</function>
268+
(see <xref linkend="functions-admin-set"/>).
268269
</para>
269270
</listitem>
270271

@@ -273,8 +274,9 @@ shared_buffers = 128MB
273274
The <link linkend="sql-set"><command>SET</command></link> command allows modification of the
274275
current value of those parameters that can be set locally to a
275276
session; it has no effect on other sessions.
276-
The corresponding function is
277-
<function>set_config(setting_name, new_value, is_local)</function>.
277+
The corresponding SQL function is
278+
<function>set_config(setting_name, new_value, is_local)</function>
279+
(see <xref linkend="functions-admin-set"/>).
278280
</para>
279281
</listitem>
280282
</itemizedlist>

doc/src/sgml/func.sgml

+7-6
Original file line numberDiff line numberDiff line change
@@ -24593,8 +24593,9 @@ SELECT collation for ('foo' COLLATE "de_DE");
2459324593
setting <parameter>setting_name</parameter>. If there is no such
2459424594
setting, <function>current_setting</function> throws an error
2459524595
unless <parameter>missing_ok</parameter> is supplied and
24596-
is <literal>true</literal>. This function corresponds to
24597-
the <acronym>SQL</acronym> command <command>SHOW</command>.
24596+
is <literal>true</literal> (in which case NULL is returned).
24597+
This function corresponds to
24598+
the <acronym>SQL</acronym> command <xref linkend="sql-show"/>.
2459824599
</para>
2459924600
<para>
2460024601
<literal>current_setting('datestyle')</literal>
@@ -24617,10 +24618,10 @@ SELECT collation for ('foo' COLLATE "de_DE");
2461724618
Sets the parameter <parameter>setting_name</parameter>
2461824619
to <parameter>new_value</parameter>, and returns that value.
2461924620
If <parameter>is_local</parameter> is <literal>true</literal>, the new
24620-
value will only apply for the current transaction. If you want the new
24621-
value to apply for the current session, use <literal>false</literal>
24622-
instead. This function corresponds to the SQL
24623-
command <command>SET</command>.
24621+
value will only apply during the current transaction. If you want the
24622+
new value to apply for the rest of the current session,
24623+
use <literal>false</literal> instead. This function corresponds to
24624+
the SQL command <xref linkend="sql-set"/>.
2462424625
</para>
2462524626
<para>
2462624627
<literal>set_config('log_statement_stats', 'off', false)</literal>

doc/src/sgml/ref/set.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ SELECT setseed(<replaceable>value</replaceable>);
267267

268268
<para>
269269
The function <function>set_config</function> provides equivalent
270-
functionality; see <xref linkend="functions-admin"/>.
270+
functionality; see <xref linkend="functions-admin-set"/>.
271271
Also, it is possible to UPDATE the
272272
<link linkend="view-pg-settings"><structname>pg_settings</structname></link>
273273
system view to perform the equivalent of <command>SET</command>.

doc/src/sgml/ref/show.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ SHOW ALL
129129

130130
<para>
131131
The function <function>current_setting</function> produces
132-
equivalent output; see <xref linkend="functions-admin"/>.
132+
equivalent output; see <xref linkend="functions-admin-set"/>.
133133
Also, the
134134
<link linkend="view-pg-settings"><structname>pg_settings</structname></link>
135135
system view produces the same information.

0 commit comments

Comments
 (0)