is_local parameter on set_config function

Started by PG Bug reporting formabout 5 years ago4 messagesdocs
Jump to latest
#1PG Bug reporting form
noreply@postgresql.org

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/9.5/config-setting.html
Description:

Hello,

I have just used the set_config(...) function for the first time and it took
me a bit of experimenting to understand the effect of the is_local
parameter. My suggestion would be to add a bit of explanation on that.

Thank you
Joao

#2Michael Paquier
michael@paquier.xyz
In reply to: PG Bug reporting form (#1)
Re: is_local parameter on set_config function

On Thu, Jan 28, 2021 at 11:32:42AM +0000, PG Doc comments form wrote:

I have just used the set_config(...) function for the first time and it took
me a bit of experimenting to understand the effect of the is_local
parameter. My suggestion would be to add a bit of explanation on that.

This is equivalent to the LOCAL clause in the SET query:
https://www.postgresql.org/docs/9.5/sql-set.html
--
Michael

#3David G. Johnston
david.g.johnston@gmail.com
In reply to: Michael Paquier (#2)
Re: is_local parameter on set_config function

On Thu, Jan 28, 2021 at 10:14 PM Michael Paquier <michael@paquier.xyz>
wrote:

On Thu, Jan 28, 2021 at 11:32:42AM +0000, PG Doc comments form wrote:

I have just used the set_config(...) function for the first time and it

took

me a bit of experimenting to understand the effect of the is_local
parameter. My suggestion would be to add a bit of explanation on that.

This is equivalent to the LOCAL clause in the SET query:
https://www.postgresql.org/docs/9.5/sql-set.html

Specifically, the hyperlink link to the SET command in that section is
expected to be referenced for details. Repeating that documentation on the
config-settings page is not particularly desirable.

David J.

#4Tom Lane
tgl@sss.pgh.pa.us
In reply to: David G. Johnston (#3)
Re: is_local parameter on set_config function

"David G. Johnston" <david.g.johnston@gmail.com> writes:

On Thu, Jan 28, 2021 at 10:14 PM Michael Paquier <michael@paquier.xyz>
wrote:

This is equivalent to the LOCAL clause in the SET query:
https://www.postgresql.org/docs/9.5/sql-set.html

Specifically, the hyperlink link to the SET command in that section is
expected to be referenced for details. Repeating that documentation on the
config-settings page is not particularly desirable.

I think the OP might be looking at table 9.85 (Configuration Settings
Functions), in which the cross-references to SET and SHOW are *not*
hyperlinks. But they should be. Will fix. I think there might be
room to say explicitly that is_local is equivalent to SET's LOCAL
option, too.

regards, tom lane