Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 2a01bc2

Browse filesBrowse 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 9915fe2 commit 2a01bc2
Copy full SHA for 2a01bc2

File tree

Expand file treeCollapse file tree

4 files changed

+15
-12
lines changed
Filter options
Expand file treeCollapse file tree

4 files changed

+15
-12
lines changed

‎doc/src/sgml/config.sgml

Copy file name to clipboardExpand all lines: doc/src/sgml/config.sgml
+6-4Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -263,8 +263,9 @@ shared_buffers = 128MB
263263
<listitem>
264264
<para>
265265
The <xref linkend="sql-show"/> 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 <xref linkend="sql-set"/> 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

Copy file name to clipboardExpand all lines: doc/src/sgml/func.sgml
+7-6Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23930,8 +23930,9 @@ SELECT collation for ('foo' COLLATE "de_DE");
2393023930
setting <parameter>setting_name</parameter>. If there is no such
2393123931
setting, <function>current_setting</function> throws an error
2393223932
unless <parameter>missing_ok</parameter> is supplied and
23933-
is <literal>true</literal>. This function corresponds to
23934-
the <acronym>SQL</acronym> command <command>SHOW</command>.
23933+
is <literal>true</literal> (in which case NULL is returned).
23934+
This function corresponds to
23935+
the <acronym>SQL</acronym> command <xref linkend="sql-show"/>.
2393523936
</para>
2393623937
<para>
2393723938
<literal>current_setting('datestyle')</literal>
@@ -23954,10 +23955,10 @@ SELECT collation for ('foo' COLLATE "de_DE");
2395423955
Sets the parameter <parameter>setting_name</parameter>
2395523956
to <parameter>new_value</parameter>, and returns that value.
2395623957
If <parameter>is_local</parameter> is <literal>true</literal>, the new
23957-
value will only apply for the current transaction. If you want the new
23958-
value to apply for the current session, use <literal>false</literal>
23959-
instead. This function corresponds to the SQL
23960-
command <command>SET</command>.
23958+
value will only apply during the current transaction. If you want the
23959+
new value to apply for the rest of the current session,
23960+
use <literal>false</literal> instead. This function corresponds to
23961+
the SQL command <xref linkend="sql-set"/>.
2396123962
</para>
2396223963
<para>
2396323964
<literal>set_config('log_statement_stats', 'off', false)</literal>

‎doc/src/sgml/ref/set.sgml

Copy file name to clipboardExpand all lines: doc/src/sgml/ref/set.sgml
+1-1Lines changed: 1 addition & 1 deletion
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

Copy file name to clipboardExpand all lines: doc/src/sgml/ref/show.sgml
+1-1Lines changed: 1 addition & 1 deletion
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 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.