From: Fujii Masao <masao.fujii@oss.nttdata.com>
To: Michael Paquier <michael@paquier.xyz>
To: Alvaro Herrera <alvherre@alvh.no-ip.org>
Cc: pgsql-docs@postgresql.org
Subject: Re: list of flags that pg_settings_get_flags reports
Date: Wed, 20 Jul 2022 13:51:36 +0900
Message-ID: <beed11aa-2716-d564-9cba-52ac11e050da@oss.nttdata.com> (raw)
In-Reply-To: <YtImcw5K2ulnI5i0@paquier.xyz>
References: <f093edf9-6e5a-b119-ee50-6a2c97c79ee8@oss.nttdata.com>
<20220715134008.t6sapoqtwnu7ubj2@alvherre.pgsql>
<YtImcw5K2ulnI5i0@paquier.xyz>
On 2022/07/16 11:46, Michael Paquier wrote:
> On Fri, Jul 15, 2022 at 03:40:08PM +0200, Alvaro Herrera wrote:
>> I think it should be a separate table, like tables 9.75-9.77 lists
>> properties for various functions.
+1
> Err, sorry for missing that. I did not notice that a list would be
> treated as separate lines in the existing function table. Adding a
> table at the bottom of the function list sounds fine to me.
+1
Attached is the updated version of the patch. It separates the list for GUC flags from the table entry for pg_settings_get_flags() and adds the table for it at the bottom of the existing function table.
Regards,
--
Fujii Masao
Advanced Computing Technology Center
Research and Development Headquarters
NTT DATA CORPORATION
From db55800943ec0df13f91fe0315a965cc95689273 Mon Sep 17 00:00:00 2001
From: Fujii Masao <fujii@postgresql.org>
Date: Wed, 20 Jul 2022 13:30:58 +0900
Subject: [PATCH] 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
---
doc/src/sgml/func.sgml | 64 +++++++++++++++++++++++++++---------------
1 file changed, 42 insertions(+), 22 deletions(-)
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgmlindex b6783b7ad0..36c3e53e42 100644--- a/doc/src/sgml/func.sgml+++ b/doc/src/sgml/func.sgml@@ -24975,28 +24975,8 @@ SELECT currval(pg_get_serial_sequence('sometable', 'id'));
Returns an array of the flags associated with the given GUC, or
<literal>NULL</literal> if it does not exist. The result is
an empty array if the GUC exists but there are no flags to show.
- Only the most useful flags are exposed, as of the following:- <simplelist>- <member>- <literal>EXPLAIN</literal>: parameters included in- <command>EXPLAIN (SETTINGS)</command> commands.- </member>- <member>- <literal>NO_SHOW_ALL</literal>: parameters excluded from- <command>SHOW ALL</command> commands.- </member>- <member>- <literal>NO_RESET_ALL</literal>: parameters excluded from- <command>RESET ALL</command> commands.- </member>- <member>- <literal>NOT_IN_SAMPLE</literal>: parameters not included in- <filename>postgresql.conf</filename> by default.- </member>- <member>- <literal>RUNTIME_COMPUTED</literal>: runtime-computed parameters.- </member>- </simplelist>+ Only the most useful flags listed in+ <xref linkend="functions-pg-settings-flags"/> are exposed.
</para></entry>
</row>
@@ -25404,6 +25384,46 @@ SELECT collation for ('foo' COLLATE "de_DE");
</tgroup>
</table>
+ <table id="functions-pg-settings-flags">+ <title>GUC Flags</title>+ <tgroup cols="2">+ <thead>+ <row><entry>Flag</entry><entry>Description</entry></row>+ </thead>+ <tbody>+ <row>+ <entry><literal>EXPLAIN</literal></entry>+ <entry>Parameters with this flag are included in+ <command>EXPLAIN (SETTINGS)</command> commands.+ </entry>+ </row>+ <row>+ <entry><literal>NO_SHOW_ALL</literal></entry>+ <entry>Parameters with this flag are excluded from+ <command>SHOW ALL</command> commands.+ </entry>+ </row>+ <row>+ <entry><literal>NO_RESET_ALL</literal></entry>+ <entry>Parameters with this flag are excluded from+ <command>RESET ALL</command> commands.+ </entry>+ </row>+ <row>+ <entry><literal>NOT_IN_SAMPLE</literal></entry>+ <entry>Parameters with this flag are not included in+ <filename>postgresql.conf</filename> by default.+ </entry>+ </row>+ <row>+ <entry><literal>RUNTIME_COMPUTED</literal></entry>+ <entry>Parameters with this flag are runtime-computed ones.+ </entry>+ </row>+ </tbody>+ </tgroup>+ </table>+
<para>
<xref linkend="functions-info-object-table"/> lists functions related to
database object identification and addressing.
--
2.36.0
Attachments:
[text/plain] 0001-docs-Improve-pg_settings_get_flags-docs.patch (3.7K, ../beed11aa-2716-d564-9cba-52ac11e050da@oss.nttdata.com/2-0001-docs-Improve-pg_settings_get_flags-docs.patch)
download | inline diff:
From db55800943ec0df13f91fe0315a965cc95689273 Mon Sep 17 00:00:00 2001
From: Fujii Masao <fujii@postgresql.org>
Date: Wed, 20 Jul 2022 13:30:58 +0900
Subject: [PATCH] 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
---
doc/src/sgml/func.sgml | 64 +++++++++++++++++++++++++++---------------
1 file changed, 42 insertions(+), 22 deletions(-)
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgmlindex b6783b7ad0..36c3e53e42 100644--- a/doc/src/sgml/func.sgml+++ b/doc/src/sgml/func.sgml@@ -24975,28 +24975,8 @@ SELECT currval(pg_get_serial_sequence('sometable', 'id'));
Returns an array of the flags associated with the given GUC, or
<literal>NULL</literal> if it does not exist. The result is
an empty array if the GUC exists but there are no flags to show.
- Only the most useful flags are exposed, as of the following:- <simplelist>- <member>- <literal>EXPLAIN</literal>: parameters included in- <command>EXPLAIN (SETTINGS)</command> commands.- </member>- <member>- <literal>NO_SHOW_ALL</literal>: parameters excluded from- <command>SHOW ALL</command> commands.- </member>- <member>- <literal>NO_RESET_ALL</literal>: parameters excluded from- <command>RESET ALL</command> commands.- </member>- <member>- <literal>NOT_IN_SAMPLE</literal>: parameters not included in- <filename>postgresql.conf</filename> by default.- </member>- <member>- <literal>RUNTIME_COMPUTED</literal>: runtime-computed parameters.- </member>- </simplelist>+ Only the most useful flags listed in+ <xref linkend="functions-pg-settings-flags"/> are exposed.
</para></entry>
</row>
@@ -25404,6 +25384,46 @@ SELECT collation for ('foo' COLLATE "de_DE");
</tgroup>
</table>
+ <table id="functions-pg-settings-flags">+ <title>GUC Flags</title>+ <tgroup cols="2">+ <thead>+ <row><entry>Flag</entry><entry>Description</entry></row>+ </thead>+ <tbody>+ <row>+ <entry><literal>EXPLAIN</literal></entry>+ <entry>Parameters with this flag are included in+ <command>EXPLAIN (SETTINGS)</command> commands.+ </entry>+ </row>+ <row>+ <entry><literal>NO_SHOW_ALL</literal></entry>+ <entry>Parameters with this flag are excluded from+ <command>SHOW ALL</command> commands.+ </entry>+ </row>+ <row>+ <entry><literal>NO_RESET_ALL</literal></entry>+ <entry>Parameters with this flag are excluded from+ <command>RESET ALL</command> commands.+ </entry>+ </row>+ <row>+ <entry><literal>NOT_IN_SAMPLE</literal></entry>+ <entry>Parameters with this flag are not included in+ <filename>postgresql.conf</filename> by default.+ </entry>+ </row>+ <row>+ <entry><literal>RUNTIME_COMPUTED</literal></entry>+ <entry>Parameters with this flag are runtime-computed ones.+ </entry>+ </row>+ </tbody>+ </tgroup>+ </table>+
<para>
<xref linkend="functions-info-object-table"/> lists functions related to
database object identification and addressing.
--
2.36.0
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-docs@postgresql.org
Cc: masao.fujii@oss.nttdata.com, michael@paquier.xyz, alvherre@alvh.no-ip.org
Subject: Re: list of flags that pg_settings_get_flags reports
In-Reply-To: <beed11aa-2716-d564-9cba-52ac11e050da@oss.nttdata.com>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox