Re: [DOCS] Stats views and functions not in order?

Peter Eisentraut <peter.eisentraut@enterprisedb.com>

From: Peter Eisentraut <peter.eisentraut@enterprisedb.com>
To: Peter Smith <smithpb2250@gmail.com>, "David G. Johnston" <david.g.johnston@gmail.com>
Cc: Tom Lane <tgl@sss.pgh.pa.us>, PostgreSQL Hackers <pgsql-hackers@lists.postgresql.org>
Date: 2022-12-01T09:20:34Z
Lists: pgsql-hackers
On 29.11.22 08:29, Peter Smith wrote:
> PSA v8* patches.
> 
> Here, patches 0001 and 0002 are unchanged, but 0003 has many changes
> per David's suggestion [1] to change all these views to <refentry>
> blocks.

I don't understand what order 0001 is trying to achieve.  I know we 
didn't necessarily want to go fully alphabetic, but if we're going to 
spend time on this, let's come up with a system that the next 
contributor who adds a view will be able to understand and follow.

As an aside, I find the mixing of pg_stat_* and pg_statio_* views 
visually distracting.  It was easier to read before when they were in 
separate blocks.

I think something like this would be manageable:

<!-- everything related to global objects, alphabetically -->
pg_stat_archiver
pg_stat_bgwriter
pg_stat_database
pg_stat_database_conflicts
pg_stat_replication_slots
pg_stat_slru
pg_stat_subscription_stats
pg_stat_wal

<!-- all "stat" for schema objects, by "importance" -->
pg_stat_all_tables
pg_stat_sys_tables
pg_stat_user_tables
pg_stat_xact_all_tables
pg_stat_xact_sys_tables
pg_stat_xact_user_tables
pg_stat_all_indexes
pg_stat_sys_indexes
pg_stat_user_indexes
pg_stat_user_functions
pg_stat_xact_user_functions

<!-- all "statio" for schema objects, by "importance" -->
pg_statio_all_tables
pg_statio_sys_tables
pg_statio_user_tables
pg_statio_all_indexes
pg_statio_sys_indexes
pg_statio_user_indexes
pg_statio_all_sequences
pg_statio_sys_sequences
pg_statio_user_sequences


In any case, the remaining patches are new and need further review, so 
I'll move this to the next CF.





Commits

  1. doc: Re-order Table 28.2 "Collected Statistics Views"

  2. doc: Re-order Table 28.35 "Per-Backend Statistics Functions"

  3. doc: Re-order Table 28.12 "Wait Events of type LWLock"

  4. doc: Re-order sections of "28.4. Progress Reporting"