upstream/postgresql
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2026-07-09 17:51:00 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Fix data checksum progress reporting documentation

Browse source 
Add pg_stat_progress_data_checksums to the progress reporting summary
and the list of commands with progress reporting.

Also clarify that the view reports both enabling and disabling data
checksums, and correct the documented types of its progress counters
to bigint.

Author: Fujii Masao <masao.fujii@gmail.com>
Reviewed-by: Daniel Gustafsson <daniel@yesql.se>
Discussion: https://postgr.es/m/CAHGQGwHJHJYAkYZBi3_O13np-Rou9UL637=hB3Y_-qdCgcZn-w@mail.gmail.com
Backpatch-through: 19
This commit is contained in:
Fujii Masao 2026-07-09 09:12:13 +09:00
parent 6120d01c9f
commit dff11f846c
1 changed files with 25 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
doc/src/sgml/monitoring.sgml
View file

@ -435,6 +435,16 @@ postgres 27093 0.0 0.0 30096 2752 ? Ss 11:34 0:00 postgres: ser
See <xref linkend="copy-progress-reporting"/>.
</entry>
</row>
<row>
<entry><structname>pg_stat_progress_data_checksums</structname><indexterm><primary>pg_stat_progress_data_checksums</primary></indexterm></entry>
<entry>One row for the data checksum launcher process while data
checksums are being enabled or disabled. When enabling data
checksums, the view also has one row for each worker process,
showing current progress.
See <xref linkend="data-checksum-progress-reporting"/>.
</entry>
</row>
</tbody>
</tgroup>
</table>
@ -6121,9 +6131,9 @@ FROM pg_stat_get_backend_idset() AS backendid;
<command>COPY</command>, <command>CREATE INDEX</command>,
<command>REPACK</command> (and its obsolete spelling <command>CLUSTER</command>),
<command>VACUUM</command>,
and <xref linkend="protocol-replication-base-backup"/> (i.e., replication
<xref linkend="protocol-replication-base-backup"/> (i.e., replication
command that <xref linkend="app-pgbasebackup"/> issues to take
a base backup).
a base backup), and online data checksum operations.
This may be expanded in the future.
</para>
@ -7855,13 +7865,14 @@ FROM pg_stat_get_backend_idset() AS backendid;
</indexterm>
<para>
When data checksums are being enabled on a running cluster, the
When data checksums are being enabled or disabled on a running cluster, the
<structname>pg_stat_progress_data_checksums</structname> view will contain
a row for the launcher process, and one row for each worker process which
is currently calculating and writing checksums for the data pages in a database.
The launcher provides overview of the overall progress (how many databases
have been processed, how many remain), while the workers track progress for
currently processed databases.
a row for the launcher process. When enabling data checksums, the view
will also contain one row for each worker process which is currently
calculating and writing checksums for the data pages in a database. The
launcher provides an overview of the overall progress, such as how many
databases have been processed and how many remain, while the workers track
progress for currently processed databases.
</para>
<table id="pg-stat-progress-data-checksums-view" xreflabel="pg_stat_progress_data_checksums">
@ -7930,7 +7941,7 @@ FROM pg_stat_get_backend_idset() AS backendid;
<row>
<entry role="catalog_table_entry">
<para role="column_definition">
<structfield>databases_total</structfield> <type>integer</type>
<structfield>databases_total</structfield> <type>bigint</type>
</para>
<para>
The total number of databases which will be processed. Only the
@ -7943,7 +7954,7 @@ FROM pg_stat_get_backend_idset() AS backendid;
<row>
<entry role="catalog_table_entry">
<para role="column_definition">
<structfield>databases_done</structfield> <type>integer</type>
<structfield>databases_done</structfield> <type>bigint</type>
</para>
<para>
The number of databases which have been processed. Only the launcher
@ -7956,7 +7967,7 @@ FROM pg_stat_get_backend_idset() AS backendid;
<row>
<entry role="catalog_table_entry">
<para role="column_definition">
<structfield>relations_total</structfield> <type>integer</type>
<structfield>relations_total</structfield> <type>bigint</type>
</para>
<para>
The total number of relations which will be processed, or
@ -7971,7 +7982,7 @@ FROM pg_stat_get_backend_idset() AS backendid;
<row>
<entry role="catalog_table_entry">
<para role="column_definition">
<structfield>relations_done</structfield> <type>integer</type>
<structfield>relations_done</structfield> <type>bigint</type>
</para>
<para>
The number of relations which have been processed. The launcher
@ -7983,7 +7994,7 @@ FROM pg_stat_get_backend_idset() AS backendid;
<row>
<entry role="catalog_table_entry">
<para role="column_definition">
<structfield>blocks_total</structfield> <type>integer</type>
<structfield>blocks_total</structfield> <type>bigint</type>
</para>
<para>
The number of blocks in the current relation which will be processed,
@ -7997,7 +8008,7 @@ FROM pg_stat_get_backend_idset() AS backendid;
<row>
<entry role="catalog_table_entry">
<para role="column_definition">
<structfield>blocks_done</structfield> <type>integer</type>
<structfield>blocks_done</structfield> <type>bigint</type>
</para>
<para>
The number of blocks in the current relation which have been processed.