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

Peter Smith <smithpb2250@gmail.com>

From: Peter Smith <smithpb2250@gmail.com>
To: PostgreSQL Hackers <pgsql-hackers@lists.postgresql.org>
Date: 2022-08-30T00:19:56Z
Lists: pgsql-hackers

Attachments

On Tue, Aug 2, 2022 at 9:40 AM Peter Smith <smithpb2250@gmail.com> wrote:
>
> Hi Hackers.
>
> I noticed that there are quite a few items in Chapter 28.2 "The
> Cumulative Statistics System" [1] which have no obvious order.
>
> e.g.
>
> - The views (28.2.3 -> 28.2.23) don't seem to be in any order that I
> could work out. Why not alphabetical?
>
> - [2] Table 2.1 "Dynamic Statistics View" views are not in alphabetical order?
>
> - [2] Table 2.2 "Collected Statistics View" views are not in alphabetical order?
>
> - [3] Table 28.34 "Additional Statistics Functions" the
> 'pg_stat_clear_snapshot' is the only one not in order?
>
> - [3] Table 28.35 "Per-Backend Statistics Functions" the
> 'pg_stat_get_backend_idset' is the only one not in order?
>
> ~~
>
> So it doesn't seem as readable as it could be. If other people think
> the same, I can write a patch for it.
>

I received no feedback when I reported this about a month ago, so I
went ahead and made patches to fix the problem anyway.

PSA. Note that no content was harmed in the making of these patches -
I only moved things around to be ordered.

IMO these docs look better now.

Thoughts?

------
Kind Regards,
Peter Smith.
Fujitsu Australia

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"