</entry>

</row>

<row>

<entry><structname>pg_stat_progress_cluster</structname><indexterm><primary>pg_stat_progress_cluster</primary></indexterm></entry>

<entry>One row for each backend running

<command>CLUSTER</command> or <command>VACUUM FULL</command>, showing current progress.

See <xref linkend='cluster-progress-reporting'/>.

</entry>

</row>

</tbody>

</tgroup>

</table>

<para>

<productname>PostgreSQL</productname> has the ability to report the progress of

certain commands during command execution. Currently, the onlycommand

whichsupports progress reportingis <command>VACUUM</command>. This may be

expanded in the future.

certain commands during command execution. Currently, the onlycommands

whichsupport progress reportingare <command>VACUUM</command> and

<command>CLUSTER</command>. This may beexpanded in the future.

</para>

<sect2 id="vacuum-progress-reporting">

one row for each backend (including autovacuum worker processes) that is

currently vacuuming. The tables below describe the information

that will be reported and provide information about how to interpret it.

Progress reporting is not currently supported for <command>VACUUM FULL</command>

and backends running <command>VACUUM FULL</command> will not be listed in this

view.

Progress for <command>VACUUM FULL</command> commands is reported via

<structname>pg_stat_progress_cluster</structname>

because both <command>VACUUM FULL</command> and <command>CLUSTER</command>

rewrite the table, while regular <command>VACUUM</command> only modifies it

in place. See <xref linkend='cluster-progress-reporting'/>.

</para>

<table id="pg-stat-progress-vacuum-view" xreflabel="pg_stat_progress_vacuum">

</tgroup>

</table>

</sect2>

<sect2 id="cluster-progress-reporting">

<title>CLUSTER Progress Reporting</title>

<para>

Whenever <command>CLUSTER</command> or <command>VACUUM FULL</command> is

running, the <structname>pg_stat_progress_cluster</structname> 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.

</para>

<table id="pg-stat-progress-cluster-view" xreflabel="pg_stat_progress_cluster">

<title><structname>pg_stat_progress_cluster</structname> View</title>

<tgroup cols="3">

<thead>

<row>

<entry>Column</entry>

<entry>Type</entry>

<entry>Description</entry>

</row>

</thead>

<tbody>

<row>

<entry><structfield>pid</structfield></entry>

<entry><type>integer</type></entry>

<entry>Process ID of backend.</entry>

</row>

<row>

<entry><structfield>datid</structfield></entry>

<entry><type>oid</type></entry>

<entry>OID of the database to which this backend is connected.</entry>

</row>

<row>

<entry><structfield>datname</structfield></entry>

<entry><type>name</type></entry>

<entry>Name of the database to which this backend is connected.</entry>

</row>

<row>

<entry><structfield>relid</structfield></entry>

<entry><type>oid</type></entry>

<entry>OID of the table being clustered.</entry>

</row>

<row>

<entry><structfield>command</structfield></entry>

<entry><type>text</type></entry>

<entry>

The command that is running. Either CLUSTER or VACUUM FULL.

</entry>

</row>

<row>

<entry><structfield>phase</structfield></entry>

<entry><type>text</type></entry>

<entry>

Current processing phase. See <xref linkend='cluster-phases' />.

</entry>

</row>

<row>

<entry><structfield>cluster_index_relid</structfield></entry>

<entry><type>bigint</type></entry>

<entry>

If the table is being scanned using an index, this is the OID of the

index being used; otherwise, it is zero.

</entry>

</row>

<row>

<entry><structfield>heap_tuples_scanned</structfield></entry>

<entry><type>bigint</type></entry>

<entry>

Number of heap tuples scanned.

This counter only advances when the phase is

<literal>seq scanning heap</literal>,

<literal>index scanning heap</literal>

or <literal>writing new heap</literal>.

</entry>

</row>

<row>

<entry><structfield>heap_tuples_written</structfield></entry>

<entry><type>bigint</type></entry>

<entry>

Number of heap tuples written.

This counter only advances when the phase is

<literal>seq scanning heap</literal>,

<literal>index scanning heap</literal>

or <literal>writing new heap</literal>.

</entry>

</row>

<row>

<entry><structfield>heap_blks_total</structfield></entry>

<entry><type>bigint</type></entry>

<entry>

Total number of heap blocks in the table. This number is reported

as of the beginning of <literal>seq scanning heap</literal>.

</entry>

</row>

<row>

<entry><structfield>heap_blks_scanned</structfield></entry>

<entry><type>bigint</type></entry>

<entry>

Number of heap blocks scanned. This counter only advances when the

phase is <literal>seq scanning heap</literal>.

</entry>

</row>

<row>

<entry><structfield>index_rebuild_count</structfield></entry>

<entry><type>bigint</type></entry>

<entry>

Number of indexes rebuilt. This counter only advances when the phase

is <literal>rebuilding index</literal>.

</entry>

</row>

</tbody>

</tgroup>

</table>

<table id="cluster-phases">

<title>CLUSTER and VACUUM FULL phases</title>

<tgroup cols="2">

<thead>

<row>

<entry>Phase</entry>

<entry>Description</entry>

</row>

</thead>

<tbody>

<row>

<entry><literal>initializing</literal></entry>

<entry>

The command is preparing to begin scanning the heap. This phase is

expected to be very brief.

</entry>

</row>

<row>

<entry><literal>seq scanning heap</literal></entry>

<entry>

The command is currently scanning the table using a sequential scan.

</entry>

</row>

<row>

<entry><literal>index scanning heap</literal></entry>

<entry>

<command>CLUSTER</command> is currently scanning the table using an index scan.

</entry>

</row>

<row>

<entry><literal>sorting tuples</literal></entry>

<entry>

<command>CLUSTER</command> is currently sorting tuples.

</entry>

</row>

<row>

<entry><literal>swapping relation files</literal></entry>

<entry>

The command is currently swapping newly-built files into place.

</entry>

</row>

<row>

<entry><literal>rebuilding index</literal></entry>

<entry>

The command is currently rebuilding an index.

</entry>

</row>

<row>

<entry><literal>performing final cleanup</literal></entry>

<entry>

The command is performing final cleanup. When this phase is

completed, <command>CLUSTER</command>

or <command>VACUUM FULL</command> will end.

</entry>

</row>

</tbody>

</tgroup>

</table>

</sect2>

</sect1>

List*indexIds;

boolis_pg_class;

boolresult;

inti;

doneIndexes=NIL;

i=1;

foreach(indexId,indexIds)

{

OidindexOid=lfirst_oid(indexId);

if (is_pg_class)

doneIndexes=lappend_oid(doneIndexes,indexOid);

pgstat_progress_update_param(PROGRESS_CLUSTER_INDEX_REBUILD_COUNT,

i);

i++;

}

}

PG_CATCH();

FROM pg_stat_get_progress_info('VACUUM')AS S

LEFT JOIN pg_database DONS.datid=D.oid;

S.pidAS pid,

S.datidAS datid,

D.datnameAS datname,

S.relidAS relid,

CASES.param1 WHEN1 THEN'CLUSTER'

WHEN2 THEN'VACUUM FULL'

ENDAS command,

CASES.param2 WHEN0 THEN'initializing'

WHEN1 THEN'seq scanning heap'

WHEN2 THEN'index scanning heap'

WHEN3 THEN'sorting tuples'

WHEN4 THEN'writing new heap'

WHEN5 THEN'swapping relation files'

WHEN6 THEN'rebuilding index'

WHEN7 THEN'performing final cleanup'

ENDAS phase,

S.param3AS cluster_index_relid,

S.param4AS heap_tuples_scanned,

S.param5AS heap_tuples_written,

S.param6AS heap_blks_total,

S.param7AS heap_blks_scanned,

S.param8AS index_rebuild_count

FROM pg_stat_get_progress_info('CLUSTER')AS S

LEFT JOIN pg_database DONS.datid=D.oid;

U.oidAS umid,