Skip to content

Commit f2d0c7f

Browse files
MasaoFujiiMasaoFujii
committed
docs: Improve pg_settings_get_flags docs.
In the docs, the GUC flags that pg_settings_get_flags() reported were listed using <simplelist>. But the list was treated as separate lines in the existing function table and didn't look good. For better view, this commit separates the list from the table entry for pg_settings_get_flags() and adds the table for it at the bottom of the existing function table. Author: Fujii Masao Reviewed-by: Alvaro Herrera, Michael Paquier Discussion: https://postgr.es/m/f093edf9-6e5a-b119-ee50-6a2c97c79ee8@oss.nttdata.com
1 parent 2b99ce1 commit f2d0c7f

File tree

1 file changed

+42
-22
lines changed

1 file changed

+42
-22
lines changed

‎doc/src/sgml/func.sgml

Lines changed: 42 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -24975,28 +24975,8 @@ SELECT currval(pg_get_serial_sequence('sometable', 'id'));
2497524975
Returns an array of the flags associated with the given GUC, or
2497624976
<literal>NULL</literal> if it does not exist. The result is
2497724977
an empty array if the GUC exists but there are no flags to show.
24978-
Only the most useful flags are exposed, as of the following:
24979-
<simplelist>
24980-
<member>
24981-
<literal>EXPLAIN</literal>: parameters included in
24982-
<command>EXPLAIN (SETTINGS)</command> commands.
24983-
</member>
24984-
<member>
24985-
<literal>NO_SHOW_ALL</literal>: parameters excluded from
24986-
<command>SHOW ALL</command> commands.
24987-
</member>
24988-
<member>
24989-
<literal>NO_RESET_ALL</literal>: parameters excluded from
24990-
<command>RESET ALL</command> commands.
24991-
</member>
24992-
<member>
24993-
<literal>NOT_IN_SAMPLE</literal>: parameters not included in
24994-
<filename>postgresql.conf</filename> by default.
24995-
</member>
24996-
<member>
24997-
<literal>RUNTIME_COMPUTED</literal>: runtime-computed parameters.
24998-
</member>
24999-
</simplelist>
24978+
Only the most useful flags listed in
24979+
<xref linkend="functions-pg-settings-flags"/> are exposed.
2500024980
</para></entry>
2500124981
</row>
2500224982

@@ -25404,6 +25384,46 @@ SELECT collation for ('foo' COLLATE "de_DE");
2540425384
</tgroup>
2540525385
</table>
2540625386

25387+
<table id="functions-pg-settings-flags">
25388+
<title>GUC Flags</title>
25389+
<tgroup cols="2">
25390+
<thead>
25391+
<row><entry>Flag</entry><entry>Description</entry></row>
25392+
</thead>
25393+
<tbody>
25394+
<row>
25395+
<entry><literal>EXPLAIN</literal></entry>
25396+
<entry>Parameters with this flag are included in
25397+
<command>EXPLAIN (SETTINGS)</command> commands.
25398+
</entry>
25399+
</row>
25400+
<row>
25401+
<entry><literal>NO_SHOW_ALL</literal></entry>
25402+
<entry>Parameters with this flag are excluded from
25403+
<command>SHOW ALL</command> commands.
25404+
</entry>
25405+
</row>
25406+
<row>
25407+
<entry><literal>NO_RESET_ALL</literal></entry>
25408+
<entry>Parameters with this flag are excluded from
25409+
<command>RESET ALL</command> commands.
25410+
</entry>
25411+
</row>
25412+
<row>
25413+
<entry><literal>NOT_IN_SAMPLE</literal></entry>
25414+
<entry>Parameters with this flag are not included in
25415+
<filename>postgresql.conf</filename> by default.
25416+
</entry>
25417+
</row>
25418+
<row>
25419+
<entry><literal>RUNTIME_COMPUTED</literal></entry>
25420+
<entry>Parameters with this flag are runtime-computed ones.
25421+
</entry>
25422+
</row>
25423+
</tbody>
25424+
</tgroup>
25425+
</table>
25426+
2540725427
<para>
2540825428
<xref linkend="functions-info-object-table"/> lists functions related to
2540925429
database object identification and addressing.

0 commit comments

Comments
 (0)