Date: Sat, 19 Apr 2014 13:10:39 -0400
From: Bruce Momjian <bruce@momjian.us>
To: Stefan Seifert <nine@detonation.org>
Cc: pgsql-docs@postgresql.org
Subject: Re: Docs incorrectly claiming equivalence between show and
 pg_settings
Message-ID: <20140419171039.GA23526@momjian.us>
References: <6963016.0JgteVRq9S@sunshine.detonation.org>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="AhhlLboLdkugWU4S"
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
In-Reply-To: <6963016.0JgteVRq9S@sunshine.detonation.org>
User-Agent: Mutt/1.5.20 (2009-06-14)
Precedence: bulk
Sender: pgsql-docs-owner@postgresql.org


--AhhlLboLdkugWU4S
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: 8bit

On Wed, Feb 12, 2014 at 03:54:31PM +0100, Stefan Seifert wrote:
> Hi!
> 
> http://www.postgresql.org/docs/devel/static/sql-show.html claims:
> "Also, the pg_settings system view produces the same information."
> 
> This is not entirely correct. On IRC I was told, that the view only contains 
> settings set from C, not user defined settings defined by the SET command:
> 
> timemngt=# set my.test = 'test';                                                                                                                                  
> SET                                                                                                                                                               
> timemngt=# show my.test;                                                                                                                                          
> ┌─────────┐                                                                                                                                                       
> │ my.test │                                                                                                                                                       
> ├─────────┤                                                                                                                                                       
> │ test    │                                                                                                                                                       
> └─────────┘                                                                                                                                                       
> (1 row)                                                                                                                                                           
> 
> timemngt=# select * from pg_settings where name = 'my.test';                                                                                                      
> timemngt=# 
> 
> Including this rather obscure bit of information might help another user down 
> the road.

This is an interesting report.  You are correct that there are several
places in the docs that say that SHOW and pg_settings display the same
information, and even state that pg_settings shows _more_ information
than SHOW.

However, in the case of custom variables, you are right that pg_settings
doesn't show custom variables.  I have found the place in the code
where we do that using GUC_NO_SHOW_ALL.

I believe the original reason for this is that custom variables were
designed to modify plugin languages and therefore not useful for people
doing SHOW ALL, but if you specifically asked for it, it would show it
to you.  Because pg_settings is built as a view, the API doesn't really
have an ALL mode.

We can do a few things:

        1  show custom variables in SHOW ALL and pg_settings
        2  show custom and other non-SHOW-ALL variables in pg_settings
        3  document this restriction

I am not sure which approach is best.  I am attaching a patch that does
#1.

-- 
  Bruce Momjian  <bruce@momjian.us>        http://momjian.us
  EnterpriseDB                             http://enterprisedb.com

  + Everyone has their own god. +

--AhhlLboLdkugWU4S
Content-Type: text/x-diff; charset=us-ascii
Content-Disposition: attachment; filename="guc.diff"

diff --git a/src/backend/utils/misc/guc.c b/src/backend/utils/misc/guc.c
new file mode 100644
index 15020c4..c0f9880
*** a/src/backend/utils/misc/guc.c
--- b/src/backend/utils/misc/guc.c
*************** add_placeholder_variable(const char *nam
*** 3929,3936 ****
  
  	gen->context = PGC_USERSET;
  	gen->group = CUSTOM_OPTIONS;
! 	gen->short_desc = "GUC placeholder variable";
! 	gen->flags = GUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE | GUC_CUSTOM_PLACEHOLDER;
  	gen->vartype = PGC_STRING;
  
  	/*
--- 3929,3936 ----
  
  	gen->context = PGC_USERSET;
  	gen->group = CUSTOM_OPTIONS;
! 	gen->short_desc = "Custom variable.";
! 	gen->flags = GUC_NOT_IN_SAMPLE | GUC_CUSTOM_PLACEHOLDER;
  	gen->vartype = PGC_STRING;
  
  	/*

--AhhlLboLdkugWU4S
Content-Type: text/plain
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
MIME-Version: 1.0


-- 
Sent via pgsql-docs mailing list (pgsql-docs@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-docs

--AhhlLboLdkugWU4S--