doc: Add description of some missing monitoring functions
authorMichael Paquier
Wed, 22 Mar 2023 09:32:04 +0000 (18:32 +0900)
committerMichael Paquier
Wed, 22 Mar 2023 09:32:04 +0000 (18:32 +0900)
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/[email protected]
Backpatch-through: 11

doc/src/sgml/monitoring.sgml

index ee0f7b4204dd6b6b517b3122bcb14afa2a4a0712..67aced7e5fd862807fb59f427e3f66510ab36ec3 100644 (file)
@@ -5038,6 +5038,34 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
        
       
 
+      
+       
+        
+         pg_stat_get_xact_blocks_fetched
+        
+        pg_stat_get_xact_blocks_fetched ( oid )
+        bigint
+       
+       
+        Returns the number of buffers fetched for table or index, in the current
+        transaction.
+       
+      
+
+      
+       
+        
+         pg_stat_get_xact_blocks_hit
+        
+        pg_stat_get_xact_blocks_hit ( oid )
+        bigint
+       
+       
+        Returns the number of buffer hits for table or index, in the current
+        transaction.
+       
+      
+