Skip to content

Commit 4a1e9e7

Browse files
committed
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
1 parent 751d667 commit 4a1e9e7

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

doc/src/sgml/monitoring.sgml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4606,6 +4606,34 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
46064606
</para></entry>
46074607
</row>
46084608

4609+
<row>
4610+
<entry role="func_table_entry"><para role="func_signature">
4611+
<indexterm>
4612+
<primary>pg_stat_get_xact_blocks_fetched</primary>
4613+
</indexterm>
4614+
<function>pg_stat_get_xact_blocks_fetched</function> ( <type>oid</type> )
4615+
<returnvalue>bigint</returnvalue>
4616+
</para>
4617+
<para>
4618+
Returns the number of buffers fetched for table or index, in the current
4619+
transaction.
4620+
</para></entry>
4621+
</row>
4622+
4623+
<row>
4624+
<entry role="func_table_entry"><para role="func_signature">
4625+
<indexterm>
4626+
<primary>pg_stat_get_xact_blocks_hit</primary>
4627+
</indexterm>
4628+
<function>pg_stat_get_xact_blocks_hit</function> ( <type>oid</type> )
4629+
<returnvalue>bigint</returnvalue>
4630+
</para>
4631+
<para>
4632+
Returns the number of buffer hits for table or index, in the current
4633+
transaction.
4634+
</para></entry>
4635+
</row>
4636+
46094637
<row>
46104638
<entry role="func_table_entry"><para role="func_signature">
46114639
<indexterm>

0 commit comments

Comments
 (0)