public inbox for [email protected]
help / color / mirror / Atom feedpg_settings doc patch
5+ messages / 3 participants
[nested] [flat]
* pg_settings doc patch
@ 2002-08-31 23:26 Joe Conway <[email protected]>
2002-09-01 00:36 ` Re: [PATCHES] pg_settings doc patch Tom Lane <[email protected]>
0 siblings, 1 reply; 5+ messages in thread
From: Joe Conway @ 2002-08-31 23:26 UTC (permalink / raw)
To: PostgreSQL Patches <[email protected]>
Here is a documentation patch for the pg_settings virtual table. If
there are no objections, please apply.
Thanks,
Joe
Attachments:
[text/html] pg_settings-doc.1.patch (2.7K, 2-pg_settings-doc.1.patch)
download | inline diff:
Index: doc/src/sgml/catalogs.sgml
===================================================================
RCS file: /opt/src/cvs/pgsql-server/doc/src/sgml/catalogs.sgml,v
retrieving revision 2.56
diff -c -r2.56 catalogs.sgml
*** doc/src/sgml/catalogs.sgml 30 Aug 2002 19:23:18 -0000 2.56
--- doc/src/sgml/catalogs.sgml 31 Aug 2002 22:46:02 -0000
***************
*** 162,167 ****
--- 162,172 ----
</row>
<row>
+ <entry>pg_settings</entry>
+ <entry>current session run-time parameters</entry>
+ </row>
+
+ <row>
<entry>pg_statistic</entry>
<entry>optimizer statistics</entry>
</row>
***************
*** 2858,2863 ****
--- 2863,2924 ----
<entry><type>text[]</type></entry>
<entry></entry>
<entry>Session defaults for run-time configuration variables</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ </sect1>
+
+
+ <sect1 id="catalog-pg-settings">
+ <title>pg_settings</title>
+
+ <para>
+ <structname>pg_settings</structname> virtual table allows display and update
+ of current session run-time parameters. There is one entry for each of the
+ available parameters provided by <command>SHOW ALL</command>. But it is
+ in a form that allows it to be joined with other relations and have a
+ selection criteria applied.
+ </para>
+
+ <para>
+ An <command>UPDATE</command> performed on <structname>pg_settings</structname>
+ is equivalent to executing the <command>SET</command> command on that named
+ parameter. The change only affects the value used by the current session. If
+ an <command>UPDATE</command> is issued within a transaction that is later
+ aborted, the effects of the <command>UPDATE</command> command disappear when
+ the transaction is rolled back. Once the surrounding transaction is
+ committed, the effects will persist until the end of the session, unless
+ overridden by another <command>UPDATE</command> or <command>SET</command>.
+ </para>
+
+ <table>
+ <title>pg_settings Columns</title>
+
+ <tgroup cols=4>
+ <thead>
+ <row>
+ <entry>Name</entry>
+ <entry>Type</entry>
+ <entry>References</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>name</entry>
+ <entry><type>text</type></entry>
+ <entry></entry>
+ <entry>The name of a current session run-time parameter</entry>
+ </row>
+
+ <row>
+ <entry>setting</entry>
+ <entry><type>text</type></entry>
+ <entry></entry>
+ <entry>The value of a current session run-time parameter</entry>
</row>
</tbody>
</tgroup>
^ permalink raw reply [nested|flat] 5+ messages in thread
* Re: [PATCHES] pg_settings doc patch
2002-08-31 23:26 pg_settings doc patch Joe Conway <[email protected]>
@ 2002-09-01 00:36 ` Tom Lane <[email protected]>
2002-09-01 00:40 ` Re: [PATCHES] pg_settings doc patch Joe Conway <[email protected]>
2002-09-01 02:52 ` Re: [PATCHES] pg_settings doc patch Joe Conway <[email protected]>
0 siblings, 2 replies; 5+ messages in thread
From: Tom Lane @ 2002-09-01 00:36 UTC (permalink / raw)
To: Joe Conway <[email protected]>; +Cc: PostgreSQL Patches <[email protected]>; pgsql-docs
Joe Conway <[email protected]> writes:
> Here is a documentation patch for the pg_settings virtual table. If
> there are no objections, please apply.
pg_settings is not a system catalog, so I don't think it belongs in the
system catalogs chapter. In fact it doesn't belong anywhere in the
Developer's Guide, since it's a user-oriented view.
I'm not sure where it *does* belong though :-(. Right at the moment we
have no documentation of any of the predefined system views, except for
the ones that fit into the "monitoring" chapter of the Admin Guide.
I think maybe we ought to make a new chapter for system views ... but
where to put it? User's Guide maybe?
regards, tom lane
^ permalink raw reply [nested|flat] 5+ messages in thread
* Re: [PATCHES] pg_settings doc patch
2002-08-31 23:26 pg_settings doc patch Joe Conway <[email protected]>
2002-09-01 00:36 ` Re: [PATCHES] pg_settings doc patch Tom Lane <[email protected]>
@ 2002-09-01 00:40 ` Joe Conway <[email protected]>
2002-09-01 04:55 ` syntax to access/retrieve data from multiple databases Vishnu <[email protected]>
1 sibling, 1 reply; 5+ messages in thread
From: Joe Conway @ 2002-09-01 00:40 UTC (permalink / raw)
To: Tom Lane <[email protected]>; +Cc: PostgreSQL Patches <[email protected]>; pgsql-docs
Tom Lane wrote:
> pg_settings is not a system catalog, so I don't think it belongs in the
> system catalogs chapter. In fact it doesn't belong anywhere in the
> Developer's Guide, since it's a user-oriented view.
>
> I'm not sure where it *does* belong though :-(. Right at the moment we
> have no documentation of any of the predefined system views, except for
> the ones that fit into the "monitoring" chapter of the Admin Guide.
>
> I think maybe we ought to make a new chapter for system views ... but
> where to put it? User's Guide maybe?
It didn't seem to fit, but as you point out, there was no place else
even close. I'll try to come up with something and submit another patch.
Joe
^ permalink raw reply [nested|flat] 5+ messages in thread
* syntax to access/retrieve data from multiple databases
2002-08-31 23:26 pg_settings doc patch Joe Conway <[email protected]>
2002-09-01 00:36 ` Re: [PATCHES] pg_settings doc patch Tom Lane <[email protected]>
2002-09-01 00:40 ` Re: [PATCHES] pg_settings doc patch Joe Conway <[email protected]>
@ 2002-09-01 04:55 ` Vishnu <[email protected]>
0 siblings, 0 replies; 5+ messages in thread
From: Vishnu @ 2002-09-01 04:55 UTC (permalink / raw)
To: pgsql-docs
Dear Friend,
I need to access/retrieve data from multiple databases
using single query ...
Is there any syntax ...?
Thanks in advance
Regards
Vishnu.
^ permalink raw reply [nested|flat] 5+ messages in thread
* Re: [PATCHES] pg_settings doc patch
2002-08-31 23:26 pg_settings doc patch Joe Conway <[email protected]>
2002-09-01 00:36 ` Re: [PATCHES] pg_settings doc patch Tom Lane <[email protected]>
@ 2002-09-01 02:52 ` Joe Conway <[email protected]>
1 sibling, 0 replies; 5+ messages in thread
From: Joe Conway @ 2002-09-01 02:52 UTC (permalink / raw)
To: Tom Lane <[email protected]>; +Cc: PostgreSQL Patches <[email protected]>; pgsql-docs
Tom Lane wrote:
> pg_settings is not a system catalog, so I don't think it belongs in the
> system catalogs chapter. In fact it doesn't belong anywhere in the
> Developer's Guide, since it's a user-oriented view.
>
> I'm not sure where it *does* belong though :-(. Right at the moment we
> have no documentation of any of the predefined system views, except for
> the ones that fit into the "monitoring" chapter of the Admin Guide.
>
> I think maybe we ought to make a new chapter for system views ... but
> where to put it? User's Guide maybe?
>
What about putting pg_settings documentation at the bottom of:
->Administrators Guide
->Server run-time environment
->run-time configuration
just before the Planner and optimizer tuning subsection?
http://developer.postgresql.org/docs/postgres/runtime-config.html
I think at some point there should be a consolidated section on system
views, but since they are scattered at the moment, this seems like the
most logical choice to me. Comments?
Joe
^ permalink raw reply [nested|flat] 5+ messages in thread
end of thread, other threads:[~2002-09-01 04:55 UTC | newest]
Thread overview: 5+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2002-08-31 23:26 pg_settings doc patch Joe Conway <[email protected]>
2002-09-01 00:36 ` Tom Lane <[email protected]>
2002-09-01 00:40 ` Joe Conway <[email protected]>
2002-09-01 04:55 ` syntax to access/retrieve data from multiple databases Vishnu <[email protected]>
2002-09-01 02:52 ` Joe Conway <[email protected]>
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox