Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 387e059

Browse files
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 Back-patch of f2d0c7f into v15. Discussion: https://postgr.es/m/20221103123320.GQ16921@telsasoft.com
1 parent c301e1c commit 387e059

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
@@ -23915,28 +23915,8 @@ SELECT currval(pg_get_serial_sequence('sometable', 'id'));
2391523915
Returns an array of the flags associated with the given GUC, or
2391623916
<literal>NULL</literal> if it does not exist. The result is
2391723917
an empty array if the GUC exists but there are no flags to show.
23918-
Only the most useful flags are exposed, as of the following:
23919-
<simplelist>
23920-
<member>
23921-
<literal>EXPLAIN</literal>: parameters included in
23922-
<command>EXPLAIN (SETTINGS)</command> commands.
23923-
</member>
23924-
<member>
23925-
<literal>NO_SHOW_ALL</literal>: parameters excluded from
23926-
<command>SHOW ALL</command> commands.
23927-
</member>
23928-
<member>
23929-
<literal>NO_RESET_ALL</literal>: parameters excluded from
23930-
<command>RESET ALL</command> commands.
23931-
</member>
23932-
<member>
23933-
<literal>NOT_IN_SAMPLE</literal>: parameters not included in
23934-
<filename>postgresql.conf</filename> by default.
23935-
</member>
23936-
<member>
23937-
<literal>RUNTIME_COMPUTED</literal>: runtime-computed parameters.
23938-
</member>
23939-
</simplelist>
23918+
Only the most useful flags listed in
23919+
<xref linkend="functions-pg-settings-flags"/> are exposed.
2394023920
</para></entry>
2394123921
</row>
2394223922

@@ -24344,6 +24324,46 @@ SELECT collation for ('foo' COLLATE "de_DE");
2434424324
</tgroup>
2434524325
</table>
2434624326

24327+
<table id="functions-pg-settings-flags">
24328+
<title>GUC Flags</title>
24329+
<tgroup cols="2">
24330+
<thead>
24331+
<row><entry>Flag</entry><entry>Description</entry></row>
24332+
</thead>
24333+
<tbody>
24334+
<row>
24335+
<entry><literal>EXPLAIN</literal></entry>
24336+
<entry>Parameters with this flag are included in
24337+
<command>EXPLAIN (SETTINGS)</command> commands.
24338+
</entry>
24339+
</row>
24340+
<row>
24341+
<entry><literal>NO_SHOW_ALL</literal></entry>
24342+
<entry>Parameters with this flag are excluded from
24343+
<command>SHOW ALL</command> commands.
24344+
</entry>
24345+
</row>
24346+
<row>
24347+
<entry><literal>NO_RESET_ALL</literal></entry>
24348+
<entry>Parameters with this flag are excluded from
24349+
<command>RESET ALL</command> commands.
24350+
</entry>
24351+
</row>
24352+
<row>
24353+
<entry><literal>NOT_IN_SAMPLE</literal></entry>
24354+
<entry>Parameters with this flag are not included in
24355+
<filename>postgresql.conf</filename> by default.
24356+
</entry>
24357+
</row>
24358+
<row>
24359+
<entry><literal>RUNTIME_COMPUTED</literal></entry>
24360+
<entry>Parameters with this flag are runtime-computed ones.
24361+
</entry>
24362+
</row>
24363+
</tbody>
24364+
</tgroup>
24365+
</table>
24366+
2434724367
<para>
2434824368
<xref linkend="functions-info-object-table"/> lists functions related to
2434924369
database object identification and addressing.

0 commit comments

Comments
 (0)