pg_stat_progress_cluster — PostgreSQL statistics view

The PostgreSQL pg_stat_progress_cluster statistics view: full column reference (names, types, descriptions), catalog relationships and version support.

The Sev-1 Admin
The Sev-1 Admin  ·  2 min read

Summary

Whenever REPACK, CLUSTER or VACUUM FULL is running, the backwards-compatibility 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.

(Description quoted from the official PostgreSQL documentation.)

Columns

The pg_stat_progress_cluster statistics view exposes the following columns (names, types and descriptions are taken verbatim from the PostgreSQL documentation):

  • 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. Because this view exists for backwards-compatibility purposes only, it will translate any REPACK command into one of these other two.
  • phase text
    Current processing phase. See cluster_phases.
  • 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.

Version applicability

Present in PostgreSQL 17, 18, 19 (verified against each release’s documentation). This is a long-standing system object that also exists in earlier PostgreSQL releases.

Related & references

Reference: PostgreSQL documentation — pg_stat_progress_cluster.