From 6573643501e982b85f893f45a0cdc237cdb3c653 Mon Sep 17 00:00:00 2001 From: Peter Eisentraut Date: Fri, 25 Nov 2022 11:50:36 +0100 Subject: [PATCH] doc: Re-order sections of "28.4. Progress Reporting" BEFORE 28.4.1. ANALYZE Progress Reporting 28.4.2. CREATE INDEX Progress Reporting 28.4.3. VACUUM Progress Reporting 28.4.4. CLUSTER Progress Reporting 28.4.5. Base Backup Progress Reporting 28.4.6. COPY Progress Reporting AFTER 28.4.1. ANALYZE Progress Reporting 28.4.2. CLUSTER Progress Reporting 28.4.3. COPY Progress Reporting 28.4.4. CREATE INDEX Progress Reporting 28.4.5. VACUUM Progress Reporting 28.4.6. Base Backup Progress Reporting Author: Peter Smith Reviewed-by: Tom Lane Discussion: https://www.postgresql.org/message-id/flat/CAHut+Pv8Oa7v06hJb3+HzCtM2u-3oHWMdvXVHhvi7ofB83pNbg@mail.gmail.com --- doc/src/sgml/monitoring.sgml | 713 +++++++++++++++++------------------ 1 file changed, 356 insertions(+), 357 deletions(-) diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml index e2426f7210c..b0823a90500 100644 --- a/doc/src/sgml/monitoring.sgml +++ b/doc/src/sgml/monitoring.sgml @@ -6012,6 +6012,362 @@ FROM pg_stat_get_backend_idset() AS backendid; + + CLUSTER Progress Reporting + + + pg_stat_progress_cluster + + + + Whenever CLUSTER or VACUUM FULL is + running, the pg_stat_progress_cluster view will + contain a row for each backend that is currently running either command. + The tables below describe the information that will be reported and + provide information about how to interpret it. + + + + <structname>pg_stat_progress_cluster</structname> View + + + + + Column Type + + + Description + + + + + + + + pid integer + + + Process ID of backend. + + + + + + datid oid + + + OID of the database to which this backend is connected. + + + + + + datname name + + + Name of the database to which this backend is connected. + + + + + + relid oid + + + OID of the table being clustered. + + + + + + command text + + + The command that is running. Either CLUSTER or VACUUM FULL. + + + + + + phase text + + + Current processing phase. See . + + + + + + cluster_index_relid oid + + + If the table is being scanned using an index, this is the OID of the + index being used; otherwise, it is zero. + + + + + + heap_tuples_scanned bigint + + + Number of heap tuples scanned. + This counter only advances when the phase is + seq scanning heap, + index scanning heap + or writing new heap. + + + + + + heap_tuples_written bigint + + + Number of heap tuples written. + This counter only advances when the phase is + seq scanning heap, + index scanning heap + or writing new heap. + + + + + + heap_blks_total bigint + + + Total number of heap blocks in the table. This number is reported + as of the beginning of seq scanning heap. + + + + + + heap_blks_scanned bigint + + + Number of heap blocks scanned. This counter only advances when the + phase is seq scanning heap. + + + + + + index_rebuild_count bigint + + + Number of indexes rebuilt. This counter only advances when the phase + is rebuilding index. + + + + +
+ + + CLUSTER and VACUUM FULL Phases + + + + + + Phase + Description + + + + + + initializing + + The command is preparing to begin scanning the heap. This phase is + expected to be very brief. + + + + seq scanning heap + + The command is currently scanning the table using a sequential scan. + + + + index scanning heap + + CLUSTER is currently scanning the table using an index scan. + + + + sorting tuples + + CLUSTER is currently sorting tuples. + + + + writing new heap + + CLUSTER is currently writing the new heap. + + + + swapping relation files + + The command is currently swapping newly-built files into place. + + + + rebuilding index + + The command is currently rebuilding an index. + + + + performing final cleanup + + The command is performing final cleanup. When this phase is + completed, CLUSTER + or VACUUM FULL will end. + + + + +
+ + + + COPY Progress Reporting + + + pg_stat_progress_copy + + + + Whenever COPY is running, the + pg_stat_progress_copy view will contain one row + for each backend that is currently running a COPY command. + The table below describes the information that will be reported and provides + information about how to interpret it. + + + + <structname>pg_stat_progress_copy</structname> View + + + + + Column Type + + + Description + + + + + + + + pid integer + + + Process ID of backend. + + + + + + datid oid + + + OID of the database to which this backend is connected. + + + + + + datname name + + + Name of the database to which this backend is connected. + + + + + + relid oid + + + OID of the table on which the COPY command is + executed. It is set to 0 if copying from a + SELECT query. + + + + + + command text + + + The command that is running: COPY FROM, or + COPY TO. + + + + + + type text + + + The io type that the data is read from or written to: + FILE, PROGRAM, + PIPE (for COPY FROM STDIN and + COPY TO STDOUT), or CALLBACK + (used for example during the initial table synchronization in + logical replication). + + + + + + bytes_processed bigint + + + Number of bytes already processed by COPY command. + + + + + + bytes_total bigint + + + Size of source file for COPY FROM command in bytes. + It is set to 0 if not available. + + + + + + tuples_processed bigint + + + Number of tuples already processed by COPY command. + + + + + + tuples_excluded bigint + + + Number of tuples not processed because they were excluded by the + WHERE clause of the COPY command. + + + + +
+ + CREATE INDEX Progress Reporting @@ -6542,229 +6898,6 @@ FROM pg_stat_get_backend_idset() AS backendid; - - - - - CLUSTER Progress Reporting - - - pg_stat_progress_cluster - - - - Whenever CLUSTER or VACUUM FULL is - running, the pg_stat_progress_cluster view will - contain a row for each backend that is currently running either command. - The tables below describe the information that will be reported and - provide information about how to interpret it. - - - - <structname>pg_stat_progress_cluster</structname> View - - - - - Column Type - - - Description - - - - - - - - pid integer - - - Process ID of backend. - - - - - - datid oid - - - OID of the database to which this backend is connected. - - - - - - datname name - - - Name of the database to which this backend is connected. - - - - - - relid oid - - - OID of the table being clustered. - - - - - - command text - - - The command that is running. Either CLUSTER or VACUUM FULL. - - - - - - phase text - - - Current processing phase. See . - - - - - - cluster_index_relid oid - - - If the table is being scanned using an index, this is the OID of the - index being used; otherwise, it is zero. - - - - - - heap_tuples_scanned bigint - - - Number of heap tuples scanned. - This counter only advances when the phase is - seq scanning heap, - index scanning heap - or writing new heap. - - - - - - heap_tuples_written bigint - - - Number of heap tuples written. - This counter only advances when the phase is - seq scanning heap, - index scanning heap - or writing new heap. - - - - - - heap_blks_total bigint - - - Total number of heap blocks in the table. This number is reported - as of the beginning of seq scanning heap. - - - - - - heap_blks_scanned bigint - - - Number of heap blocks scanned. This counter only advances when the - phase is seq scanning heap. - - - - - - index_rebuild_count bigint - - - Number of indexes rebuilt. This counter only advances when the phase - is rebuilding index. - - - - -
- - - CLUSTER and VACUUM FULL Phases - - - - - - Phase - Description - - - - - - initializing - - The command is preparing to begin scanning the heap. This phase is - expected to be very brief. - - - - seq scanning heap - - The command is currently scanning the table using a sequential scan. - - - - index scanning heap - - CLUSTER is currently scanning the table using an index scan. - - - - sorting tuples - - CLUSTER is currently sorting tuples. - - - - writing new heap - - CLUSTER is currently writing the new heap. - - - - swapping relation files - - The command is currently swapping newly-built files into place. - - - - rebuilding index - - The command is currently rebuilding an index. - - - - performing final cleanup - - The command is performing final cleanup. When this phase is - completed, CLUSTER - or VACUUM FULL will end. - - - - -
@@ -6942,140 +7075,6 @@ FROM pg_stat_get_backend_idset() AS backendid; - - COPY Progress Reporting - - - pg_stat_progress_copy - - - - Whenever COPY is running, the - pg_stat_progress_copy view will contain one row - for each backend that is currently running a COPY command. - The table below describes the information that will be reported and provides - information about how to interpret it. - - - - <structname>pg_stat_progress_copy</structname> View - - - - - Column Type - - - Description - - - - - - - - pid integer - - - Process ID of backend. - - - - - - datid oid - - - OID of the database to which this backend is connected. - - - - - - datname name - - - Name of the database to which this backend is connected. - - - - - - relid oid - - - OID of the table on which the COPY command is - executed. It is set to 0 if copying from a - SELECT query. - - - - - - command text - - - The command that is running: COPY FROM, or - COPY TO. - - - - - - type text - - - The io type that the data is read from or written to: - FILE, PROGRAM, - PIPE (for COPY FROM STDIN and - COPY TO STDOUT), or CALLBACK - (used for example during the initial table synchronization in - logical replication). - - - - - - bytes_processed bigint - - - Number of bytes already processed by COPY command. - - - - - - bytes_total bigint - - - Size of source file for COPY FROM command in bytes. - It is set to 0 if not available. - - - - - - tuples_processed bigint - - - Number of tuples already processed by COPY command. - - - - - - tuples_excluded bigint - - - Number of tuples not processed because they were excluded by the - WHERE clause of the COPY command. - - - - -
- -