PostgreSQL Source Code git master
Loading...
Searching...
No Matches
progress.h
Go to the documentation of this file.
1/*-------------------------------------------------------------------------
2 *
3 * progress.h
4 * Constants used with the progress reporting facilities defined in
5 * backend_status.h. These are possibly interesting to extensions, so we
6 * expose them via this header file. Note that if you update these
7 * constants, you probably also need to update the views based on them
8 * in system_views.sql.
9 *
10 * Portions Copyright (c) 1996-2026, PostgreSQL Global Development Group
11 * Portions Copyright (c) 1994, Regents of the University of California
12 *
13 * src/include/commands/progress.h
14 *
15 *-------------------------------------------------------------------------
16 */
17#ifndef PROGRESS_H
18#define PROGRESS_H
19
20/* Progress parameters for (lazy) vacuum */
21#define PROGRESS_VACUUM_PHASE 0
22#define PROGRESS_VACUUM_TOTAL_HEAP_BLKS 1
23#define PROGRESS_VACUUM_HEAP_BLKS_SCANNED 2
24#define PROGRESS_VACUUM_HEAP_BLKS_VACUUMED 3
25#define PROGRESS_VACUUM_NUM_INDEX_VACUUMS 4
26#define PROGRESS_VACUUM_MAX_DEAD_TUPLE_BYTES 5
27#define PROGRESS_VACUUM_DEAD_TUPLE_BYTES 6
28#define PROGRESS_VACUUM_NUM_DEAD_ITEM_IDS 7
29#define PROGRESS_VACUUM_INDEXES_TOTAL 8
30#define PROGRESS_VACUUM_INDEXES_PROCESSED 9
31#define PROGRESS_VACUUM_DELAY_TIME 10
32#define PROGRESS_VACUUM_MODE 11
33#define PROGRESS_VACUUM_STARTED_BY 12
34
35/* Phases of vacuum (as advertised via PROGRESS_VACUUM_PHASE) */
36#define PROGRESS_VACUUM_PHASE_SCAN_HEAP 1
37#define PROGRESS_VACUUM_PHASE_VACUUM_INDEX 2
38#define PROGRESS_VACUUM_PHASE_VACUUM_HEAP 3
39#define PROGRESS_VACUUM_PHASE_INDEX_CLEANUP 4
40#define PROGRESS_VACUUM_PHASE_TRUNCATE 5
41#define PROGRESS_VACUUM_PHASE_FINAL_CLEANUP 6
42
43/* Modes of vacuum (as advertised via PROGRESS_VACUUM_MODE) */
44#define PROGRESS_VACUUM_MODE_NORMAL 1
45#define PROGRESS_VACUUM_MODE_AGGRESSIVE 2
46#define PROGRESS_VACUUM_MODE_FAILSAFE 3
47
48/* Reasons for vacuum (as advertised via PROGRESS_VACUUM_STARTED_BY) */
49#define PROGRESS_VACUUM_STARTED_BY_MANUAL 1
50#define PROGRESS_VACUUM_STARTED_BY_AUTOVACUUM 2
51#define PROGRESS_VACUUM_STARTED_BY_AUTOVACUUM_WRAPAROUND 3
52
53/* Progress parameters for analyze */
54#define PROGRESS_ANALYZE_PHASE 0
55#define PROGRESS_ANALYZE_BLOCKS_TOTAL 1
56#define PROGRESS_ANALYZE_BLOCKS_DONE 2
57#define PROGRESS_ANALYZE_EXT_STATS_TOTAL 3
58#define PROGRESS_ANALYZE_EXT_STATS_COMPUTED 4
59#define PROGRESS_ANALYZE_CHILD_TABLES_TOTAL 5
60#define PROGRESS_ANALYZE_CHILD_TABLES_DONE 6
61#define PROGRESS_ANALYZE_CURRENT_CHILD_TABLE_RELID 7
62#define PROGRESS_ANALYZE_DELAY_TIME 8
63#define PROGRESS_ANALYZE_STARTED_BY 9
64
65/* Phases of analyze (as advertised via PROGRESS_ANALYZE_PHASE) */
66#define PROGRESS_ANALYZE_PHASE_ACQUIRE_SAMPLE_ROWS 1
67#define PROGRESS_ANALYZE_PHASE_ACQUIRE_SAMPLE_ROWS_INH 2
68#define PROGRESS_ANALYZE_PHASE_COMPUTE_STATS 3
69#define PROGRESS_ANALYZE_PHASE_COMPUTE_EXT_STATS 4
70#define PROGRESS_ANALYZE_PHASE_FINALIZE_ANALYZE 5
71
72/* Reasons for analyze (as advertised via PROGRESS_ANALYZE_STARTED_BY) */
73#define PROGRESS_ANALYZE_STARTED_BY_MANUAL 1
74#define PROGRESS_ANALYZE_STARTED_BY_AUTOVACUUM 2
75
76/*
77 * Progress parameters for REPACK.
78 *
79 * Values for PROGRESS_REPACK_COMMAND are as in RepackCommand.
80 *
81 * Note: Since REPACK shares code with CLUSTER, these values are also
82 * used by CLUSTER. (CLUSTER being now deprecated, it makes little sense to
83 * maintain a separate set of constants.)
84 */
85#define PROGRESS_REPACK_COMMAND 0
86#define PROGRESS_REPACK_PHASE 1
87#define PROGRESS_REPACK_INDEX_RELID 2
88#define PROGRESS_REPACK_HEAP_TUPLES_SCANNED 3
89#define PROGRESS_REPACK_HEAP_TUPLES_WRITTEN 4
90#define PROGRESS_REPACK_TOTAL_HEAP_BLKS 5
91#define PROGRESS_REPACK_HEAP_BLKS_SCANNED 6
92#define PROGRESS_REPACK_INDEX_REBUILD_COUNT 7
93
94/*
95 * Phases of repack (as advertised via PROGRESS_REPACK_PHASE).
96 */
97#define PROGRESS_REPACK_PHASE_SEQ_SCAN_HEAP 1
98#define PROGRESS_REPACK_PHASE_INDEX_SCAN_HEAP 2
99#define PROGRESS_REPACK_PHASE_SORT_TUPLES 3
100#define PROGRESS_REPACK_PHASE_WRITE_NEW_HEAP 4
101#define PROGRESS_REPACK_PHASE_SWAP_REL_FILES 5
102#define PROGRESS_REPACK_PHASE_REBUILD_INDEX 6
103#define PROGRESS_REPACK_PHASE_FINAL_CLEANUP 7
104
105/* Progress parameters for CREATE INDEX */
106/* 3, 4 and 5 reserved for "waitfor" metrics */
107#define PROGRESS_CREATEIDX_COMMAND 0
108#define PROGRESS_CREATEIDX_INDEX_OID 6
109#define PROGRESS_CREATEIDX_ACCESS_METHOD_OID 8
110#define PROGRESS_CREATEIDX_PHASE 9 /* AM-agnostic phase # */
111#define PROGRESS_CREATEIDX_SUBPHASE 10 /* phase # filled by AM */
112#define PROGRESS_CREATEIDX_TUPLES_TOTAL 11
113#define PROGRESS_CREATEIDX_TUPLES_DONE 12
114#define PROGRESS_CREATEIDX_PARTITIONS_TOTAL 13
115#define PROGRESS_CREATEIDX_PARTITIONS_DONE 14
116/* 15 and 16 reserved for "block number" metrics */
117
118/* Phases of CREATE INDEX (as advertised via PROGRESS_CREATEIDX_PHASE) */
119#define PROGRESS_CREATEIDX_PHASE_WAIT_1 1
120#define PROGRESS_CREATEIDX_PHASE_BUILD 2
121#define PROGRESS_CREATEIDX_PHASE_WAIT_2 3
122#define PROGRESS_CREATEIDX_PHASE_VALIDATE_IDXSCAN 4
123#define PROGRESS_CREATEIDX_PHASE_VALIDATE_SORT 5
124#define PROGRESS_CREATEIDX_PHASE_VALIDATE_TABLESCAN 6
125#define PROGRESS_CREATEIDX_PHASE_WAIT_3 7
126#define PROGRESS_CREATEIDX_PHASE_WAIT_4 8
127#define PROGRESS_CREATEIDX_PHASE_WAIT_5 9
128
129/*
130 * Subphases of CREATE INDEX, for index_build.
131 */
132#define PROGRESS_CREATEIDX_SUBPHASE_INITIALIZE 1
133/* Additional phases are defined by each AM */
134
135/* Commands of PROGRESS_CREATEIDX */
136#define PROGRESS_CREATEIDX_COMMAND_CREATE 1
137#define PROGRESS_CREATEIDX_COMMAND_CREATE_CONCURRENTLY 2
138#define PROGRESS_CREATEIDX_COMMAND_REINDEX 3
139#define PROGRESS_CREATEIDX_COMMAND_REINDEX_CONCURRENTLY 4
140
141/* Lock holder wait counts */
142#define PROGRESS_WAITFOR_TOTAL 3
143#define PROGRESS_WAITFOR_DONE 4
144#define PROGRESS_WAITFOR_CURRENT_PID 5
145
146/* Block numbers in a generic relation scan */
147#define PROGRESS_SCAN_BLOCKS_TOTAL 15
148#define PROGRESS_SCAN_BLOCKS_DONE 16
149
150/* Progress parameters for pg_basebackup */
151#define PROGRESS_BASEBACKUP_PHASE 0
152#define PROGRESS_BASEBACKUP_BACKUP_TOTAL 1
153#define PROGRESS_BASEBACKUP_BACKUP_STREAMED 2
154#define PROGRESS_BASEBACKUP_TBLSPC_TOTAL 3
155#define PROGRESS_BASEBACKUP_TBLSPC_STREAMED 4
156#define PROGRESS_BASEBACKUP_BACKUP_TYPE 5
157
158/* Phases of pg_basebackup (as advertised via PROGRESS_BASEBACKUP_PHASE) */
159#define PROGRESS_BASEBACKUP_PHASE_WAIT_CHECKPOINT 1
160#define PROGRESS_BASEBACKUP_PHASE_ESTIMATE_BACKUP_SIZE 2
161#define PROGRESS_BASEBACKUP_PHASE_STREAM_BACKUP 3
162#define PROGRESS_BASEBACKUP_PHASE_WAIT_WAL_ARCHIVE 4
163#define PROGRESS_BASEBACKUP_PHASE_TRANSFER_WAL 5
164
165/* Types of pg_basebackup (as advertised via PROGRESS_BASEBACKUP_BACKUP_TYPE) */
166#define PROGRESS_BASEBACKUP_BACKUP_TYPE_FULL 1
167#define PROGRESS_BASEBACKUP_BACKUP_TYPE_INCREMENTAL 2
168
169/* Progress parameters for PROGRESS_COPY */
170#define PROGRESS_COPY_BYTES_PROCESSED 0
171#define PROGRESS_COPY_BYTES_TOTAL 1
172#define PROGRESS_COPY_TUPLES_PROCESSED 2
173#define PROGRESS_COPY_TUPLES_EXCLUDED 3
174#define PROGRESS_COPY_COMMAND 4
175#define PROGRESS_COPY_TYPE 5
176#define PROGRESS_COPY_TUPLES_SKIPPED 6
177
178/* Commands of COPY (as advertised via PROGRESS_COPY_COMMAND) */
179#define PROGRESS_COPY_COMMAND_FROM 1
180#define PROGRESS_COPY_COMMAND_TO 2
181
182/* Types of COPY commands (as advertised via PROGRESS_COPY_TYPE) */
183#define PROGRESS_COPY_TYPE_FILE 1
184#define PROGRESS_COPY_TYPE_PROGRAM 2
185#define PROGRESS_COPY_TYPE_PIPE 3
186#define PROGRESS_COPY_TYPE_CALLBACK 4
187
188#endif