diff options
| author | Michael Paquier <michael@paquier.xyz> | 2023-03-22 18:32:09 +0900 |
|---|---|---|
| committer | Michael Paquier <michael@paquier.xyz> | 2023-03-22 18:32:09 +0900 |
| commit | 488ace333584d345b4bf76992e81b0b7ef52cbe0 (patch) | |
| tree | 149dc3edeb1db330b77e621cc71daaa53b95775b | |
| parent | fc63e6ba8670e0eb1bc40ae9fe4acdd4203bc36e (diff) | |
doc: Add description of some missing monitoring functions
This commit adds some documentation about two monitoring functions:
- pg_stat_get_xact_blocks_fetched()
- pg_stat_get_xact_blocks_hit()
The description of these functions has been removed in ddfc2d9, later
simplified by 5f2b089, assuming that all the functions whose
descriptions were removed are used in system views. Unfortunately, some
of them were are not used in any system views, so they lacked
documentation.
This gap exists in the docs for a long time, so backpatch all the way
down.
Reported-by: Michael Paquier
Author: Bertrand Drouvot
Reviewed-by: Kyotaro Horiguchi
Discussion: https://postgr.es/m/ZBeeH5UoNkTPrwHO@paquier.xyz
Backpatch-through: 11
| -rw-r--r-- | doc/src/sgml/monitoring.sgml | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml index b2a27c8c7fc..f2d99b5c117 100644 --- a/doc/src/sgml/monitoring.sgml +++ b/doc/src/sgml/monitoring.sgml @@ -3291,6 +3291,24 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i Discard the current statistics snapshot </entry> </row> + + <row> + <entry><literal><function>pg_stat_get_xact_blocks_fetched</function>(oid)</literal><indexterm><primary>pg_stat_get_xact_blocks_fetched</primary></indexterm></entry> + <entry><type>bigint</type></entry> + <entry> + Returns the number of buffers fetched for table or index, in the current + transaction. + </entry> + </row> + + <row> + <entry><literal><function>pg_stat_get_xact_blocks_hit</function>(oid)</literal><indexterm><primary>pg_stat_get_xact_blocks_hit</primary></indexterm></entry> + <entry><type>bigint</type></entry> + <entry> + Returns the number of buffer hits for table or index, in the current + transaction. + </entry> + </row> <row> <entry><literal><function>pg_stat_reset()</function></literal><indexterm><primary>pg_stat_reset</primary></indexterm></entry> |