postgres.git / summary / log / commit / refs

commit    d69c404c4cc5985d8ae5b5ed38bed3400b317f82
Author:   Michael Paquier <michael@paquier.xyz>
Date:     Wed Mar 22 09:31:52 2023 +0000

    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


 doc/src/sgml/monitoring.sgml | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml
index 6249bb50d02..2ae24127a83 100644
--- a/doc/src/sgml/monitoring.sgml
+++ b/doc/src/sgml/monitoring.sgml
@@ -5697,6 +5697,34 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
        </para></entry>
       </row>
 
+      <row>
+       <entry role="func_table_entry"><para role="func_signature">
+        <indexterm>
+         <primary>pg_stat_get_xact_blocks_fetched</primary>
+        </indexterm>
+        <function>pg_stat_get_xact_blocks_fetched</function> ( <type>oid</type> )
+        <returnvalue>bigint</returnvalue>
+       </para>
+       <para>
+        Returns the number of buffers fetched for table or index, in the current
+        transaction.
+       </para></entry>
+      </row>
+
+      <row>
+       <entry role="func_table_entry"><para role="func_signature">
+        <indexterm>
+         <primary>pg_stat_get_xact_blocks_hit</primary>
+        </indexterm>
+        <function>pg_stat_get_xact_blocks_hit</function> ( <type>oid</type> )
+        <returnvalue>bigint</returnvalue>
+       </para>
+       <para>
+        Returns the number of buffer hits for table or index, in the current
+        transaction.
+       </para></entry>
+      </row>
+
       <row>
        <entry role="func_table_entry"><para role="func_signature">
         <indexterm>


[parent: 88199b9d5fda]