doc: Improve descriptions of tup_returned and tup_fetched in pg_stat_database
authorFujii Masao <fujii@postgresql.org>
Wed, 30 Jun 2021 11:57:07 +0000 (20:57 +0900)
committerFujii Masao <fujii@postgresql.org>
Wed, 30 Jun 2021 11:57:07 +0000 (20:57 +0900)
commit3465c8a8692fb628bc2710fbeedb9aeb534b0400
tree8dd124ec49c3453169de39a34076963acabbf6e9
parent61d599ede7424d88bbd4006b968bae366b6b9f5d
doc: Improve descriptions of tup_returned and tup_fetched in pg_stat_database

Previously the descriptions of tup_returned and tup_fetched columns
in pg_stat_database view were confusing. This commit improves them
so that they represent the following formulas of those columns
more accurately.

* pg_stat_database.tup_returned
    = sum(pg_stat_all_tables.seq_tup_read)
    + sum(pg_stat_all_indexes.idx_tup_read)

* pg_stat_database.tup_fetched
    = sum(pg_stat_all_tables.idx_tup_fetch)

In these formulas, note that the counters for some system catalogs
like pg_database shared across all databases of a cluster are excluded
from the calculations of sum.

Author: Masahiro Ikeda
Reviewed-by: Fujii Masao
Discussion: https://postgr.es/m/9eeeccdb-5dd7-90f9-2807-a4b5d2b76ca3@oss.nttdata.com
doc/src/sgml/monitoring.sgml