summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Paquier <michael@paquier.xyz>2023-04-05 07:59:54 +0900
committerMichael Paquier <michael@paquier.xyz>2023-04-05 07:59:54 +0900
commitf7a057ac7eb1d9b2257d703b0958d82e30d17e13 (patch)
tree6c8eb31b9b3c3ed1b569ff2783e048c4a9f0cb09
parentbfb993b1bbd137b5ea0a4f14bddd57ac46dac494 (diff)
doc: Add more details about pg_stat_get_xact_blocks_{fetched,hit}
The explanation describing the dependency to system read() calls for these two functions has been removed in ddfc2d9. And after more discussion about d69c404, we have concluded that adding more details makes them easier to understand. While on it, use the term "block read requests" (maybe found in cache) rather than "buffers fetched" and "buffer hits". Per discussion with Melanie Plageman, Kyotaro Horiguchi, Bertrand Drouvot and myself. Discussion: https://postgr.es/m/CAAKRu_ZmdiScT4q83OAbfmR5AH-L5zWya3SXjaxiJvhCob-e2A@mail.gmail.com Backpatch-through: 11
-rw-r--r--doc/src/sgml/monitoring.sgml12
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml
index 5da26de30a0..01803dc53ff 100644
--- a/doc/src/sgml/monitoring.sgml
+++ b/doc/src/sgml/monitoring.sgml
@@ -4615,8 +4615,11 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
<returnvalue>bigint</returnvalue>
</para>
<para>
- Returns the number of buffers fetched for table or index, in the current
- transaction.
+ Returns the number of block read requests for table or index, in the
+ current transaction. This number minus
+ <function>pg_stat_get_xact_blocks_hit</function> gives the number of
+ kernel <function>read()</function> calls; the number of actual
+ physical reads is usually lower due to kernel-level buffering.
</para></entry>
</row>
@@ -4629,8 +4632,9 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
<returnvalue>bigint</returnvalue>
</para>
<para>
- Returns the number of buffer hits for table or index, in the current
- transaction.
+ Returns the number of block read requests for table or index, in the
+ current transaction, found in cache (not triggering kernel
+ <function>read()</function> calls).
</para></entry>
</row>