Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 7f6bc3b

Browse files
committed
doc: Improve description of targets for pg_stat_reset_shared()
This commit changes the documentation so as the supported targets are documented with itemized list, making it easier to understand the view a given target affects. Author: Atsushi Torikoshi Discussion: https://postgr.es/m/e3c25d72e81378e7b64f3c52e0306fc9@oss.nttdata.com
1 parent 025584a commit 7f6bc3b

File tree

1 file changed

+45
-16
lines changed

1 file changed

+45
-16
lines changed

doc/src/sgml/monitoring.sgml

Lines changed: 45 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4717,22 +4717,51 @@ description | Waiting for a newly initialized WAL file to reach durable storage
47174717
</para>
47184718
<para>
47194719
Resets some cluster-wide statistics counters to zero, depending on the
4720-
argument. The argument can be <literal>bgwriter</literal> to reset
4721-
all the counters shown in
4722-
the <structname>pg_stat_bgwriter</structname> view,
4723-
<literal>checkpointer</literal> to reset all the counters shown in
4724-
the <structname>pg_stat_checkpointer</structname> view,
4725-
<literal>archiver</literal> to reset all the counters shown in
4726-
the <structname>pg_stat_archiver</structname> view,
4727-
<literal>io</literal> to reset all the counters shown in the
4728-
<structname>pg_stat_io</structname> view,
4729-
<literal>wal</literal> to reset all the counters shown in the
4730-
<structname>pg_stat_wal</structname> view or
4731-
<literal>recovery_prefetch</literal> to reset all the counters shown
4732-
in the <structname>pg_stat_recovery_prefetch</structname> view.
4733-
If <parameter>target</parameter> is <literal>NULL</literal> or
4734-
is not specified, all the counters from the views listed above are
4735-
reset.
4720+
argument. <parameter>target</parameter> can be:
4721+
<itemizedlist>
4722+
<listitem>
4723+
<para>
4724+
<literal>archiver</literal>: Reset all the counters shown in the
4725+
<structname>pg_stat_archiver</structname> view.
4726+
</para>
4727+
</listitem>
4728+
<listitem>
4729+
<para>
4730+
<literal>bgwriter</literal>: Reset all the counters shown in the
4731+
<structname>pg_stat_bgwriter</structname> view.
4732+
</para>
4733+
</listitem>
4734+
<listitem>
4735+
<para>
4736+
<literal>checkpointer</literal>: Reset all the counters shown in the
4737+
<structname>pg_stat_checkpointer</structname> view.
4738+
</para>
4739+
</listitem>
4740+
<listitem>
4741+
<para>
4742+
<literal>io</literal>: Reset all the counters shown in the
4743+
<structname>pg_stat_io</structname> view.
4744+
</para>
4745+
</listitem>
4746+
<listitem>
4747+
<para>
4748+
<literal>recovery_prefetch</literal>: Reset all the counters shown in
4749+
the <structname>pg_stat_recovery_prefetch</structname> view.
4750+
</para>
4751+
</listitem>
4752+
<listitem>
4753+
<para>
4754+
<literal>wal</literal>: Reset all the counters shown in the
4755+
<structname>pg_stat_wal</structname> view.
4756+
</para>
4757+
</listitem>
4758+
<listitem>
4759+
<para>
4760+
<literal>NULL</literal> or not specified: All the counters from the
4761+
views listed above are reset.
4762+
</para>
4763+
</listitem>
4764+
</itemizedlist>
47364765
</para>
47374766
<para>
47384767
This function is restricted to superusers by default, but other users

0 commit comments

Comments
 (0)