↑↓ select↵ open⌫ change scopeOpen full search

PG.CENTER connects PostgreSQL documentation, reference, and ecosystem knowledge. Maintained by Pigsty.

Wiki / System Catalogs

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.

English manual coverage begins with PostgreSQL 7.4. Source history and runtime observations have their own recorded version boundaries.

Reading PG 18·Select a recorded version

kind
progress
lang
en
measured attributes
true
metadata release
18.6
runtime columns
pid, datid, datname, relid, command, phase, cluster_index_relid, heap_tuples_scanned, heap_tuples_written, heap_blks_total, heap_blks_scanned, index_rebuild_count
runtime verified
false
source
english-manual

Definition PG 18

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.

Catalog columns

ColumnTypeNullabilityDescription
pidintegerNullableProcess ID of backend.
datidoidNullableOID of the database to which this backend is connected.
datnamenameNullableName of the database to which this backend is connected.
relidoidNullableOID of the table being clustered.
commandtextNullableThe command that is running. Either CLUSTER or VACUUM FULL.
phasetextNullableCurrent processing phase. See Table 27.41.
cluster_index_relidoidNullableIf the table is being scanned using an index, this is the OID of the index being used; otherwise, it is zero.
heap_tuples_scannedbigintNullableNumber of heap tuples scanned. This counter only advances when the phase is seq scanning heap, index scanning heap or writing new heap.
heap_tuples_writtenbigintNullableNumber of heap tuples written. This counter only advances when the phase is seq scanning heap, index scanning heap or writing new heap.
heap_blks_totalbigintNullableTotal number of heap blocks in the table. This number is reported as of the beginning of seq scanning heap.
heap_blks_scannedbigintNullableNumber of heap blocks scanned. This counter only advances when the phase is seq scanning heap.
index_rebuild_countbigintNullableNumber of indexes rebuilt. This counter only advances when the phase is rebuilding index.

Compare versions

Complete source facts

documentation revision

{"inputs":[{"file":"progress-reporting.html","kind":"same-version-reviewed-manual","locale":"en","sha256":"4a6cdd8228f2d858318f2056687ac4e2467e2c58e5fed10bdb583ba8eb66fec5","version":"18.7"},{"file":"progress-reporting.html","kind":"same-version-reviewed-manual","locale":"zh-Hans","sha256":"0ab33caa1959f857312f1a866b2b0f0afde18c3fd85db5d957eefa1b7a2e441f","version":"18.7"}],"release":"18.7","runtime_remeasured":false,"source_revision":"pgdoc:b9f0e7232f60f380d642ac9b99226606c254b552"}

Source references

Full definition and evidence JSON

Definition sources

center · PostgreSQL 18 · catalog-bilingual-repair:866232b1909ea9b26a12ebd2fbde200f036f87e3d92fe60a23e762f0907b832d

Text language: en · catalog-bilingual-repair:866232b1909ea9b26a12ebd2fbde200f036f87e3d92fe60a23e762f0907b832d