1
0
mirror of https://github.com/postgres/postgres.git synced 2026-10-23 13:29:09 +03:00

doc: Mention pg_stat_force_next_flush()

pg_stat_force_next_flush() has primarily been used in in-core tests to
force cumulative statistics to be flushed at the end of a transaction
without waiting for the PGSTAT_MIN_INTERVAL throttle, to speed up
things.

It is also useful in tests outside the core tree.  Spoiler: I have used
it myself for some out-of-core work for the same reason as the in-core
tests, and would have unlikely known about it without my work on the
core code.

Author: Sami Imseih <samimseih.pg@gmail.com>
Discussion: https://postgr.es/m/aqEONVuLhgBiqHW6@paquier.xyz
This commit is contained in:
Michael Paquier
2026-09-10 13:19:11 +09:00
parent d8304bc661
commit c8985a09b7

View File

@@ -5936,6 +5936,24 @@ description | Waiting for a newly initialized WAL file to reach durable storage
</para></entry>
</row>
<row>
<entry role="func_table_entry"><para role="func_signature">
<indexterm>
<primary>pg_stat_force_next_flush</primary>
</indexterm>
<function>pg_stat_force_next_flush</function> ()
<returnvalue>void</returnvalue>
</para>
<para>
Forces the statistics accumulated by the current session to be
flushed to shared memory when the current transaction ends,
without waiting for the
<varname>PGSTAT_MIN_INTERVAL</varname> delay between flushes. This
is mainly useful in tests that need this flush to happen without
that delay.
</para></entry>
</row>
<row>
<entry role="func_table_entry"><para role="func_signature">
<indexterm>