Skip to content

Commit 3877b1f

Browse files
Clarify hash index caution and copy to CREATE INDEX docs
1 parent 2883674 commit 3877b1f

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

doc/src/sgml/indices.sgml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,8 +196,10 @@ CREATE INDEX <replaceable>name</replaceable> ON <replaceable>table</replaceable>
196196
<para>
197197
Hash index operations are not presently WAL-logged,
198198
so hash indexes might need to be rebuilt with <command>REINDEX</>
199-
after a database crash. They are also not replicated over streaming or
200-
file-based replication.
199+
after a database crash if there were unwritten changes.
200+
Also, changes to hash indexes are not replicated over streaming or
201+
file-based replication after the initial base backup, so they
202+
give wrong anwers to queries that subsequently use them.
201203
For these reasons, hash index use is presently discouraged.
202204
</para>
203205
</caution>

doc/src/sgml/ref/create_index.sgml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -451,6 +451,18 @@ Indexes:
451451
they can be useful.
452452
</para>
453453

454+
<caution>
455+
<para>
456+
Hash index operations are not presently WAL-logged,
457+
so hash indexes might need to be rebuilt with <command>REINDEX</>
458+
after a database crash if there were unwritten changes.
459+
Also, changes to hash indexes are not replicated over streaming or
460+
file-based replication after the initial base backup, so they
461+
give wrong anwers to queries that subsequently use them.
462+
For these reasons, hash index use is presently discouraged.
463+
</para>
464+
</caution>
465+
454466
<para>
455467
Currently, only the B-tree, GiST and GIN index methods support
456468
multicolumn indexes. Up to 32 fields can be specified by default.

0 commit comments

Comments
 (0)