pg.ddx.io pgsql-docs@postgresql.org mailing list archive
help / color / mirror / Atom feedWhere to document system views?
4+ messages / 2 participants
[nested] [flat]
* Where to document system views?
@ 2001-10-15 02:08 Tom Lane <tgl@sss.pgh.pa.us>
0 siblings, 1 reply; 4+ messages in thread
From: Tom Lane @ 2001-10-15 02:08 UTC (permalink / raw)
To: pgsql-docs
I have noticed that there is a nearly total lack of documentation of the
various predefined system views, which as of 7.2 include:
pg_indexes
pg_rules
pg_stat_activity
pg_stat_all_indexes
pg_stat_all_tables
pg_stat_database
pg_stat_sys_indexes
pg_stat_sys_tables
pg_stat_user_indexes
pg_stat_user_tables
pg_statio_all_indexes
pg_statio_all_sequences
pg_statio_all_tables
pg_statio_sys_indexes
pg_statio_sys_sequences
pg_statio_sys_tables
pg_statio_user_indexes
pg_statio_user_sequences
pg_statio_user_tables
pg_stats
pg_tables
pg_user
pg_views
The lack of docs for the pg_stat* stuff can be blamed on Jan and me,
but the other ones are of longer standing. My current thought is to
add a section somewhere that describes these views, but where? I don't
think it's quite right to document them under the System Catalogs
chapter of the Developer's Guide, since they're all intended for use
by ordinary users and dbadmins; the system itself doesn't use them.
Thoughts?
regards, tom lane
^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: Where to document system views?
@ 2001-10-15 19:31 Tom Lane <tgl@sss.pgh.pa.us>
parent: Peter Eisentraut <peter_e@gmx.net>
0 siblings, 1 reply; 4+ messages in thread
From: Tom Lane @ 2001-10-15 19:31 UTC (permalink / raw)
To: Peter Eisentraut <peter_e@gmx.net>; +Cc: pgsql-docs
Peter Eisentraut <peter_e@gmx.net> writes:
> The pg_stat-related views ought to become part of a new section that
> describes that whole deal in the first place. If there is a lot to say it
> could become a new chapter in the Admin Guide (perhaps "Monitoring...").
That seems like a good plan for Jan's runtime statistics stuff. But
pg_stats doesn't quite fit with the others. Maybe I'll put it into the
"performance tips" area.
> The others could become part of a chapter in the User's Guide I've been
> meaning to write on "schema creation", which would describe what tables,
> views, contraints, and such are. A subsection on how to reverse engineer
> the created schema would fit naturally.
Seems okay. Are you thinking of getting that done for 7.2, or is this a
long-term idea?
regards, tom lane
^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: Where to document system views?
@ 2001-10-15 19:31 Peter Eisentraut <peter_e@gmx.net>
parent: Tom Lane <tgl@sss.pgh.pa.us>
0 siblings, 1 reply; 4+ messages in thread
From: Peter Eisentraut @ 2001-10-15 19:31 UTC (permalink / raw)
To: Tom Lane <tgl@sss.pgh.pa.us>; +Cc: pgsql-docs
Tom Lane writes:
> My current thought is to add a section somewhere that describes these
> views, but where? I don't think it's quite right to document them
> under the System Catalogs chapter of the Developer's Guide, since
> they're all intended for use by ordinary users and dbadmins; the
> system itself doesn't use them. Thoughts?
The pg_stat-related views ought to become part of a new section that
describes that whole deal in the first place. If there is a lot to say it
could become a new chapter in the Admin Guide (perhaps "Monitoring...").
If there is only little to say it could be thrown into the big old "Server
Run-time Environment".
The others could become part of a chapter in the User's Guide I've been
meaning to write on "schema creation", which would describe what tables,
views, contraints, and such are. A subsection on how to reverse engineer
the created schema would fit naturally.
--
Peter Eisentraut peter_e@gmx.net http://funkturm.homeip.net/~peter
^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: Where to document system views?
@ 2001-10-17 20:37 Peter Eisentraut <peter_e@gmx.net>
parent: Tom Lane <tgl@sss.pgh.pa.us>
0 siblings, 0 replies; 4+ messages in thread
From: Peter Eisentraut @ 2001-10-17 20:37 UTC (permalink / raw)
To: Tom Lane <tgl@sss.pgh.pa.us>; +Cc: pgsql-docs
Tom Lane writes:
> > The others could become part of a chapter in the User's Guide I've been
> > meaning to write on "schema creation", which would describe what tables,
> > views, contraints, and such are. A subsection on how to reverse engineer
> > the created schema would fit naturally.
>
> Seems okay. Are you thinking of getting that done for 7.2, or is this a
> long-term idea?
It's a long-term idea that should finally get done for 7.2. ;-)
--
Peter Eisentraut peter_e@gmx.net http://funkturm.homeip.net/~peter
^ permalink raw reply [nested|flat] 4+ messages in thread
end of thread, other threads:[~2001-10-17 20:37 UTC | newest]
Thread overview: 4+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2001-10-15 02:08 Where to document system views? Tom Lane <tgl@sss.pgh.pa.us>
2001-10-15 19:31 ` Peter Eisentraut <peter_e@gmx.net>
2001-10-15 19:31 ` Tom Lane <tgl@sss.pgh.pa.us>
2001-10-17 20:37 ` Peter Eisentraut <peter_e@gmx.net>
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox