GUC context information in the document.

From: Kyotaro HORIGUCHI <horiguchi(dot)kyotaro(at)lab(dot)ntt(dot)co(dot)jp>
To: pgsql-hackers(at)postgresql(dot)org
Subject: GUC context information in the document.
Date: 2015-03-31 04:02:56
Message-ID: 20150331.130256.87621020.horiguchi.kyotaro@lab.ntt.co.jp
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Hello, I had a question that whether a change of some GUC
parameter needs restart or not and similar questions come every
now and then.

As shown below, descriptions about GUC context is surely put
there but I believe the average reader of the document doesn't
recognize that clearly while looking into an item without
comparing it with several other itmes that he/she knows how
behave.

Addition to that, the description for PGC_POSTMASTER doesn't say
that it also can be set on command line, and description for
PGC_SIGHUP doesn't state clearly that realoading makes it
effective, and PGC_USERSET has even no description.

If I'm not missing anyting, putting stereotyped information about
GUC contexts like following would be usable.

> share_buffers (integer), (effective after server restart)

> log_destination (string), (effetive after config reload)

> log_min_duration_statement (integer), (effective in-session, superuser only)

> DateStyle (string), (effective in-session)

What do you think about this?

regards,

=====
The typical descriptions are listed below.

A. PGC_POSTMASTER

http://www.postgresql.org/docs/devel/static/runtime-config-resource.html#RUNTIME-CONFIG-RESOURCE-MEMORY

> shared_buffers (integer)
> ... This parameter can only be set at server start.

B. PGC_SIGHUP

http://www.postgresql.org/docs/devel/static/runtime-config-logging.html#GUC-LOG-DESTINATION

> log_destination (string)
> ... This parameter can only be set in the postgresql.conf
> file or on the server command line.

C. PGC_SUSET

http://www.postgresql.org/docs/devel/static/runtime-config-logging.html#GUC-LOG-MIN-DURATION-STATEMENT

> log_min_duration_statement (integer)
> ... Only superusers can change this setting.

D. PGC_USERSET

http://www.postgresql.org/docs/devel/static/runtime-config-client.html#GUC-DATESTYLE

> DateStyle (string)
... nothing about GUC context is written ...

--
Kyotaro Horiguchi
NTT Open Source Software Center

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Michael Paquier 2015-03-31 05:05:18 Re: Exposing PG_VERSION_NUM in pg_config
Previous Message Jeff Janes 2015-03-31 03:54:26 vac truncation scan problems