Re: Documentation of underlying functions for statistics views - Mailing list pgsql-docs

From Tom Lane
Subject Re: Documentation of underlying functions for statistics views
Date
Msg-id 19136.1335733569@sss.pgh.pa.us
Whole thread Raw
In response to Re: Documentation of underlying functions for statistics views  (Josh Kupershmidt <schmiddy@gmail.com>)
Responses Re: Documentation of underlying functions for statistics views  (Josh Kupershmidt <schmiddy@gmail.com>)
List pgsql-docs
Josh Kupershmidt <schmiddy@gmail.com> writes:
> Yeah, that sounds fine. The paragraph I think you're talking about
> claims "These functions are listed in Table 27-13", but Table 27-13
> only has a few functions (e.g. pg_stat_get_db_block_time_read() is
> missing). Maybe that paragraph could  clarify that it's talking
> generally about all the views/functions on that page.

It seemed to me that the only view-underlying function that needs
explicit documentation is pg_stat_get_activity(), because the fact
that you can pass it a PID isn't obvious from the view's usage.
So that's the only one I left in table 27-13.  However, I realized
that the stats functions that we used in pg_stat_activity before 8.4
are not documented at all with this approach, so I made another table
27-14 to cover them.  I'm not sure if we should mark them deprecated
or not; thoughts?

Anyway, this is committed and up on the devel docs website, if
you want to take a look.

            regards, tom lane

pgsql-docs by date:

Previous
From: Josh Kupershmidt
Date:
Subject: Re: Documentation of underlying functions for statistics views
Next
From: Josh Kupershmidt
Date:
Subject: Re: Documentation of underlying functions for statistics views