diff options
| author | Alvaro Herrera <alvherre@alvh.no-ip.org> | 2022-05-20 10:05:31 +0200 |
|---|---|---|
| committer | Alvaro Herrera <alvherre@alvh.no-ip.org> | 2022-05-20 10:05:31 +0200 |
| commit | aa783575294f6e3579b9c78a75d54a693f010213 (patch) | |
| tree | aeb7a46ea1d09ff97a505cf71a40665602aabf34 | |
| parent | 3a8d83cae35e887be0011fa6139c83423037bc67 (diff) | |
| download | postgresql-aa783575294f6e3579b9c78a75d54a693f010213.tar.gz postgresql-aa783575294f6e3579b9c78a75d54a693f010213.zip | |
doc: Explain 'invalid' index state for CREATE INDEX CONCURRENTLY
It wasn't previously mentioned that the index is created as invalid,
which is confusing to new users.
Backpatch to 14 (only because of a conflict in 13).
Author: Laurenz Albe <laurenz.albe@cybertec.at>
Reported-by: Lauren Fliksteen <dancernerd32@gmail.com>
Reviewed-by: Rajakavitha Kodhandapani <krajakavitha@gmail.com>
Discussion: https://postgr.es/m/165290238488.670.7500177735573254738@wrigleys.postgresql.org
| -rw-r--r-- | doc/src/sgml/ref/create_index.sgml | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/src/sgml/ref/create_index.sgml b/doc/src/sgml/ref/create_index.sgml index cc484d5b398..11179f0b9d9 100644 --- a/doc/src/sgml/ref/create_index.sgml +++ b/doc/src/sgml/ref/create_index.sgml @@ -606,7 +606,8 @@ CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class= </para> <para> - In a concurrent index build, the index is actually entered into + In a concurrent index build, the index is actually entered as an + <quote>invalid</quote> index into the system catalogs in one transaction, then two table scans occur in two more transactions. Before each table scan, the index build must wait for existing transactions that have modified the table to terminate. @@ -615,7 +616,7 @@ CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class= scan to terminate, including transactions used by any phase of concurrent index builds on other tables, if the indexes involved are partial or have columns that are not simple column references. - Then finally the index can be marked ready for use, + Then finally the index can be marked <quote>valid</quote> and ready for use, and the <command>CREATE INDEX</command> command terminates. Even then, however, the index may not be immediately usable for queries: in the worst case, it cannot be used as long as transactions exist that |