Skip to content

Commit 9818844

Browse files
Clarify hash index caution and copy to CREATE INDEX docs
1 parent 1c95b5e commit 9818844

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
@@ -191,8 +191,10 @@ CREATE INDEX <replaceable>name</replaceable> ON <replaceable>table</replaceable>
191191
<para>
192192
Hash index operations are not presently WAL-logged,
193193
so hash indexes might need to be rebuilt with <command>REINDEX</>
194-
after a database crash. They are also not replicated over streaming or
195-
file-based replication.
194+
after a database crash if there were unwritten changes.
195+
Also, changes to hash indexes are not replicated over streaming or
196+
file-based replication after the initial base backup, so they
197+
give wrong anwers to queries that subsequently use them.
196198
For these reasons, hash index use is presently discouraged.
197199
</para>
198200
</caution>

doc/src/sgml/ref/create_index.sgml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -439,6 +439,18 @@ Indexes:
439439
they can be useful.
440440
</para>
441441

442+
<caution>
443+
<para>
444+
Hash index operations are not presently WAL-logged,
445+
so hash indexes might need to be rebuilt with <command>REINDEX</>
446+
after a database crash if there were unwritten changes.
447+
Also, changes to hash indexes are not replicated over streaming or
448+
file-based replication after the initial base backup, so they
449+
give wrong anwers to queries that subsequently use them.
450+
For these reasons, hash index use is presently discouraged.
451+
</para>
452+
</caution>
453+
442454
<para>
443455
Currently, only the B-tree, GiST and GIN index methods support
444456
multicolumn indexes. Up to 32 fields can be specified by default.

0 commit comments

Comments
 (0)