Re: GUC flags

From: Justin Pryzby <pryzby(at)telsasoft(dot)com>
To: Michael Paquier <michael(at)paquier(dot)xyz>
Cc: Peter Eisentraut <peter(dot)eisentraut(at)enterprisedb(dot)com>, Kyotaro Horiguchi <horikyota(dot)ntt(at)gmail(dot)com>, pgsql-hackers(at)lists(dot)postgresql(dot)org, bruce(at)momjian(dot)us, tgl(at)sss(dot)pgh(dot)pa(dot)us
Subject: Re: GUC flags
Date: 2022-01-30 00:18:50
Message-ID: 20220130001849.GR23027@telsasoft.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Sat, Jan 29, 2022 at 03:38:53PM +0900, Michael Paquier wrote:
> +-- Three exceptions as of transaction_*
> +SELECT name FROM pg_settings_flags
> + WHERE NOT no_show_all AND no_reset_all
> + ORDER BY 1;
> + name
> +------------------------
> + transaction_deferrable
> + transaction_isolation
> + transaction_read_only
> +(3 rows)

I think "as of" is not the right phrase here.
Maybe say: Exceptions are transaction_*

> --- a/doc/src/sgml/func.sgml
> +++ b/doc/src/sgml/func.sgml
> @@ -23596,6 +23596,45 @@ SELECT pg_type_is_visible('myschema.widget'::regtype);
> + <para>
> + Returns an array of the flags associated with the given GUC, or
> + <literal>NULL</literal> if the does not exist. The result is

I guess it should say "if the GUC does not exist".

> + an empty array if the GUC exists but there are no flags to show,
> + as supported by the list below.

I'd say "...but none of the GUC's flags are exposed by this function."

> + The following flags are exposed (the most meaningful ones are
> + included):

"The most meaningful ones are included" doesn't seem to add anything.
Maybe it'd be useful to say "(Only the most useful flags are exposed)"

> + <literal>EXPLAIN</literal>, parameters included in
> + <command>EXPLAIN</command> commands.
> + </member>
> + <member>

I think the description is wrong, or just copied from the others.
EXPLAIN is for GUCs which are shown in EXPLAIN(SETTINGS).

|EXPLAIN, parameters included in EXPLAIN commands.
|NO_SHOW_ALL, parameters excluded from SHOW ALL commands.
|NO_RESET_ALL, parameters excluded from RESET ALL commands.
|NOT_IN_SAMPLE, parameters not included in postgresql.conf by default.
|RUNTIME_COMPUTED, runtime-computed parameters.

Instead of a comma, these should use a colon, or something else?

--
Justin

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Nathan Bossart 2022-01-30 00:31:48 Re: archive modules
Previous Message Alvaro Herrera 2022-01-29 21:49:37 Re: support for MERGE