1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
|
'\" t
.\" Title: REINDEX
.\" Author: The PostgreSQL Global Development Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 2024
.\" Manual: PostgreSQL 16.3 Documentation
.\" Source: PostgreSQL 16.3
.\" Language: English
.\"
.TH "REINDEX" "7" "2024" "PostgreSQL 16.3" "PostgreSQL 16.3 Documentation"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
REINDEX \- rebuild indexes
.SH "SYNOPSIS"
.sp
.nf
REINDEX [ ( \fIoption\fR [, \&.\&.\&.] ) ] { INDEX | TABLE | SCHEMA } [ CONCURRENTLY ] \fIname\fR
REINDEX [ ( \fIoption\fR [, \&.\&.\&.] ) ] { DATABASE | SYSTEM } [ CONCURRENTLY ] [ \fIname\fR ]
where \fIoption\fR can be one of:
CONCURRENTLY [ \fIboolean\fR ]
TABLESPACE \fInew_tablespace\fR
VERBOSE [ \fIboolean\fR ]
.fi
.SH "DESCRIPTION"
.PP
\fBREINDEX\fR
rebuilds an index using the data stored in the index\*(Aqs table, replacing the old copy of the index\&. There are several scenarios in which to use
\fBREINDEX\fR:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
An index has become corrupted, and no longer contains valid data\&. Although in theory this should never happen, in practice indexes can become corrupted due to software bugs or hardware failures\&.
\fBREINDEX\fR
provides a recovery method\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
An index has become
\(lqbloated\(rq, that is it contains many empty or nearly\-empty pages\&. This can occur with B\-tree indexes in
PostgreSQL
under certain uncommon access patterns\&.
\fBREINDEX\fR
provides a way to reduce the space consumption of the index by writing a new version of the index without the dead pages\&. See
Section\ \&25.2
for more information\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
You have altered a storage parameter (such as fillfactor) for an index, and wish to ensure that the change has taken full effect\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
If an index build fails with the
CONCURRENTLY
option, this index is left as
\(lqinvalid\(rq\&. Such indexes are useless but it can be convenient to use
\fBREINDEX\fR
to rebuild them\&. Note that only
\fBREINDEX INDEX\fR
is able to perform a concurrent build on an invalid index\&.
.RE
.SH "PARAMETERS"
.PP
INDEX
.RS 4
Recreate the specified index\&. This form of
\fBREINDEX\fR
cannot be executed inside a transaction block when used with a partitioned index\&.
.RE
.PP
TABLE
.RS 4
Recreate all indexes of the specified table\&. If the table has a secondary
\(lqTOAST\(rq
table, that is reindexed as well\&. This form of
\fBREINDEX\fR
cannot be executed inside a transaction block when used with a partitioned table\&.
.RE
.PP
SCHEMA
.RS 4
Recreate all indexes of the specified schema\&. If a table of this schema has a secondary
\(lqTOAST\(rq
table, that is reindexed as well\&. Indexes on shared system catalogs are also processed\&. This form of
\fBREINDEX\fR
cannot be executed inside a transaction block\&.
.RE
.PP
DATABASE
.RS 4
Recreate all indexes within the current database, except system catalogs\&. Indexes on system catalogs are not processed\&. This form of
\fBREINDEX\fR
cannot be executed inside a transaction block\&.
.RE
.PP
SYSTEM
.RS 4
Recreate all indexes on system catalogs within the current database\&. Indexes on shared system catalogs are included\&. Indexes on user tables are not processed\&. This form of
\fBREINDEX\fR
cannot be executed inside a transaction block\&.
.RE
.PP
\fIname\fR
.RS 4
The name of the specific index, table, or database to be reindexed\&. Index and table names can be schema\-qualified\&. Presently,
\fBREINDEX DATABASE\fR
and
\fBREINDEX SYSTEM\fR
can only reindex the current database\&. Their parameter is optional, and it must match the current database\*(Aqs name\&.
.RE
.PP
CONCURRENTLY
.RS 4
When this option is used,
PostgreSQL
will rebuild the index without taking any locks that prevent concurrent inserts, updates, or deletes on the table; whereas a standard index rebuild locks out writes (but not reads) on the table until it\*(Aqs done\&. There are several caveats to be aware of when using this option \(em see
Rebuilding Indexes Concurrently
below\&.
.sp
For temporary tables,
\fBREINDEX\fR
is always non\-concurrent, as no other session can access them, and non\-concurrent reindex is cheaper\&.
.RE
.PP
TABLESPACE
.RS 4
Specifies that indexes will be rebuilt on a new tablespace\&.
.RE
.PP
VERBOSE
.RS 4
Prints a progress report as each index is reindexed\&.
.RE
.PP
\fIboolean\fR
.RS 4
Specifies whether the selected option should be turned on or off\&. You can write
TRUE,
ON, or
1
to enable the option, and
FALSE,
OFF, or
0
to disable it\&. The
\fIboolean\fR
value can also be omitted, in which case
TRUE
is assumed\&.
.RE
.PP
\fInew_tablespace\fR
.RS 4
The tablespace where indexes will be rebuilt\&.
.RE
.SH "NOTES"
.PP
If you suspect corruption of an index on a user table, you can simply rebuild that index, or all indexes on the table, using
\fBREINDEX INDEX\fR
or
\fBREINDEX TABLE\fR\&.
.PP
Things are more difficult if you need to recover from corruption of an index on a system table\&. In this case it\*(Aqs important for the system to not have used any of the suspect indexes itself\&. (Indeed, in this sort of scenario you might find that server processes are crashing immediately at start\-up, due to reliance on the corrupted indexes\&.) To recover safely, the server must be started with the
\fB\-P\fR
option, which prevents it from using indexes for system catalog lookups\&.
.PP
One way to do this is to shut down the server and start a single\-user
PostgreSQL
server with the
\fB\-P\fR
option included on its command line\&. Then,
\fBREINDEX DATABASE\fR,
\fBREINDEX SYSTEM\fR,
\fBREINDEX TABLE\fR, or
\fBREINDEX INDEX\fR
can be issued, depending on how much you want to reconstruct\&. If in doubt, use
\fBREINDEX SYSTEM\fR
to select reconstruction of all system indexes in the database\&. Then quit the single\-user server session and restart the regular server\&. See the
\fBpostgres\fR(1)
reference page for more information about how to interact with the single\-user server interface\&.
.PP
Alternatively, a regular server session can be started with
\fB\-P\fR
included in its command line options\&. The method for doing this varies across clients, but in all
libpq\-based clients, it is possible to set the
\fBPGOPTIONS\fR
environment variable to
\-P
before starting the client\&. Note that while this method does not require locking out other clients, it might still be wise to prevent other users from connecting to the damaged database until repairs have been completed\&.
.PP
\fBREINDEX\fR
is similar to a drop and recreate of the index in that the index contents are rebuilt from scratch\&. However, the locking considerations are rather different\&.
\fBREINDEX\fR
locks out writes but not reads of the index\*(Aqs parent table\&. It also takes an
ACCESS EXCLUSIVE
lock on the specific index being processed, which will block reads that attempt to use that index\&. In particular, the query planner tries to take an
ACCESS SHARE
lock on every index of the table, regardless of the query, and so
\fBREINDEX\fR
blocks virtually any queries except for some prepared queries whose plan has been cached and which don\*(Aqt use this very index\&. In contrast,
\fBDROP INDEX\fR
momentarily takes an
ACCESS EXCLUSIVE
lock on the parent table, blocking both writes and reads\&. The subsequent
\fBCREATE INDEX\fR
locks out writes but not reads; since the index is not there, no read will attempt to use it, meaning that there will be no blocking but reads might be forced into expensive sequential scans\&.
.PP
Reindexing a single index or table requires being the owner of that index or table\&. Reindexing a schema or database requires being the owner of that schema or database\&. Note specifically that it\*(Aqs thus possible for non\-superusers to rebuild indexes of tables owned by other users\&. However, as a special exception, when
\fBREINDEX DATABASE\fR,
\fBREINDEX SCHEMA\fR
or
\fBREINDEX SYSTEM\fR
is issued by a non\-superuser, indexes on shared catalogs will be skipped unless the user owns the catalog (which typically won\*(Aqt be the case)\&. Of course, superusers can always reindex anything\&.
.PP
Reindexing partitioned indexes or partitioned tables is supported with
\fBREINDEX INDEX\fR
or
\fBREINDEX TABLE\fR, respectively\&. Each partition of the specified partitioned relation is reindexed in a separate transaction\&. Those commands cannot be used inside a transaction block when working on a partitioned table or index\&.
.PP
When using the
TABLESPACE
clause with
\fBREINDEX\fR
on a partitioned index or table, only the tablespace references of the leaf partitions are updated\&. As partitioned indexes are not updated, it is recommended to separately use
\fBALTER TABLE ONLY\fR
on them so as any new partitions attached inherit the new tablespace\&. On failure, it may not have moved all the indexes to the new tablespace\&. Re\-running the command will rebuild all the leaf partitions and move previously\-unprocessed indexes to the new tablespace\&.
.PP
If
SCHEMA,
DATABASE
or
SYSTEM
is used with
TABLESPACE, system relations are skipped and a single
WARNING
will be generated\&. Indexes on TOAST tables are rebuilt, but not moved to the new tablespace\&.
.SS "Rebuilding Indexes Concurrently"
.PP
Rebuilding an index can interfere with regular operation of a database\&. Normally
PostgreSQL
locks the table whose index is rebuilt against writes and performs the entire index build with a single scan of the table\&. Other transactions can still read the table, but if they try to insert, update, or delete rows in the table they will block until the index rebuild is finished\&. This could have a severe effect if the system is a live production database\&. Very large tables can take many hours to be indexed, and even for smaller tables, an index rebuild can lock out writers for periods that are unacceptably long for a production system\&.
.PP
PostgreSQL
supports rebuilding indexes with minimum locking of writes\&. This method is invoked by specifying the
CONCURRENTLY
option of
\fBREINDEX\fR\&. When this option is used,
PostgreSQL
must perform two scans of the table for each index that needs to be rebuilt and wait for termination of all existing transactions that could potentially use the index\&. This method requires more total work than a standard index rebuild and takes significantly longer to complete as it needs to wait for unfinished transactions that might modify the index\&. However, since it allows normal operations to continue while the index is being rebuilt, this method is useful for rebuilding indexes in a production environment\&. Of course, the extra CPU, memory and I/O load imposed by the index rebuild may slow down other operations\&.
.PP
The following steps occur in a concurrent reindex\&. Each step is run in a separate transaction\&. If there are multiple indexes to be rebuilt, then each step loops through all the indexes before moving to the next step\&.
.sp
.RS 4
.ie n \{\
\h'-04' 1.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 1." 4.2
.\}
A new transient index definition is added to the catalog
pg_index\&. This definition will be used to replace the old index\&. A
SHARE UPDATE EXCLUSIVE
lock at session level is taken on the indexes being reindexed as well as their associated tables to prevent any schema modification while processing\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 2.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 2." 4.2
.\}
A first pass to build the index is done for each new index\&. Once the index is built, its flag
pg_index\&.indisready
is switched to
\(lqtrue\(rq
to make it ready for inserts, making it visible to other sessions once the transaction that performed the build is finished\&. This step is done in a separate transaction for each index\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 3.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 3." 4.2
.\}
Then a second pass is performed to add tuples that were added while the first pass was running\&. This step is also done in a separate transaction for each index\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 4.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 4." 4.2
.\}
All the constraints that refer to the index are changed to refer to the new index definition, and the names of the indexes are changed\&. At this point,
pg_index\&.indisvalid
is switched to
\(lqtrue\(rq
for the new index and to
\(lqfalse\(rq
for the old, and a cache invalidation is done causing all sessions that referenced the old index to be invalidated\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 5.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 5." 4.2
.\}
The old indexes have
pg_index\&.indisready
switched to
\(lqfalse\(rq
to prevent any new tuple insertions, after waiting for running queries that might reference the old index to complete\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 6.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 6." 4.2
.\}
The old indexes are dropped\&. The
SHARE UPDATE EXCLUSIVE
session locks for the indexes and the table are released\&.
.RE
.PP
If a problem arises while rebuilding the indexes, such as a uniqueness violation in a unique index, the
\fBREINDEX\fR
command will fail but leave behind an
\(lqinvalid\(rq
new index in addition to the pre\-existing one\&. This index will be ignored for querying purposes because it might be incomplete; however it will still consume update overhead\&. The
psql
\fB\ed\fR
command will report such an index as
INVALID:
.sp
.if n \{\
.RS 4
.\}
.nf
postgres=# \ed tab
Table "public\&.tab"
Column | Type | Modifiers
\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-
col | integer |
Indexes:
"idx" btree (col)
"idx_ccnew" btree (col) INVALID
.fi
.if n \{\
.RE
.\}
.sp
If the index marked
INVALID
is suffixed
ccnew, then it corresponds to the transient index created during the concurrent operation, and the recommended recovery method is to drop it using
DROP INDEX, then attempt
\fBREINDEX CONCURRENTLY\fR
again\&. If the invalid index is instead suffixed
ccold, it corresponds to the original index which could not be dropped; the recommended recovery method is to just drop said index, since the rebuild proper has been successful\&.
.PP
Regular index builds permit other regular index builds on the same table to occur simultaneously, but only one concurrent index build can occur on a table at a time\&. In both cases, no other types of schema modification on the table are allowed meanwhile\&. Another difference is that a regular
\fBREINDEX TABLE\fR
or
\fBREINDEX INDEX\fR
command can be performed within a transaction block, but
\fBREINDEX CONCURRENTLY\fR
cannot\&.
.PP
Like any long\-running transaction,
\fBREINDEX\fR
on a table can affect which tuples can be removed by concurrent
\fBVACUUM\fR
on any other table\&.
.PP
\fBREINDEX SYSTEM\fR
does not support
\fBCONCURRENTLY\fR
since system catalogs cannot be reindexed concurrently\&.
.PP
Furthermore, indexes for exclusion constraints cannot be reindexed concurrently\&. If such an index is named directly in this command, an error is raised\&. If a table or database with exclusion constraint indexes is reindexed concurrently, those indexes will be skipped\&. (It is possible to reindex such indexes without the
\fBCONCURRENTLY\fR
option\&.)
.PP
Each backend running
\fBREINDEX\fR
will report its progress in the
pg_stat_progress_create_index
view\&. See
Section\ \&28.4.4
for details\&.
.SH "EXAMPLES"
.PP
Rebuild a single index:
.sp
.if n \{\
.RS 4
.\}
.nf
REINDEX INDEX my_index;
.fi
.if n \{\
.RE
.\}
.PP
Rebuild all the indexes on the table
my_table:
.sp
.if n \{\
.RS 4
.\}
.nf
REINDEX TABLE my_table;
.fi
.if n \{\
.RE
.\}
.PP
Rebuild all indexes in a particular database, without trusting the system indexes to be valid already:
.sp
.if n \{\
.RS 4
.\}
.nf
$ \fBexport PGOPTIONS="\-P"\fR
$ \fBpsql broken_db\fR
\&.\&.\&.
broken_db=> REINDEX DATABASE broken_db;
broken_db=> \eq
.fi
.if n \{\
.RE
.\}
.PP
Rebuild indexes for a table, without blocking read and write operations on involved relations while reindexing is in progress:
.sp
.if n \{\
.RS 4
.\}
.nf
REINDEX TABLE CONCURRENTLY my_broken_table;
.fi
.if n \{\
.RE
.\}
.SH "COMPATIBILITY"
.PP
There is no
\fBREINDEX\fR
command in the SQL standard\&.
.SH "SEE ALSO"
CREATE INDEX (\fBCREATE_INDEX\fR(7)), DROP INDEX (\fBDROP_INDEX\fR(7)), \fBreindexdb\fR(1), Section\ \&28.4.4
|