From d526b07784d8caa208055c1f2bd1cedc88fb52dc Mon Sep 17 00:00:00 2001 From: Nick Pope Date: Tue, 5 Dec 2017 09:43:56 +0000 Subject: Fixed #26974 -- Added HashIndex to django.contrib.postgres. Thanks Akshesh Doshi for the initial implementation. --- docs/ref/contrib/postgres/indexes.txt | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'docs/ref') diff --git a/docs/ref/contrib/postgres/indexes.txt b/docs/ref/contrib/postgres/indexes.txt index e7c681e6ba..2d966553c3 100644 --- a/docs/ref/contrib/postgres/indexes.txt +++ b/docs/ref/contrib/postgres/indexes.txt @@ -72,3 +72,22 @@ available from the ``django.contrib.postgres.indexes`` module. .. _buffering build: https://www.postgresql.org/docs/current/static/gist-implementation.html#GIST-BUFFERING-BUILD .. _fillfactor: https://www.postgresql.org/docs/current/static/sql-createindex.html#SQL-CREATEINDEX-STORAGE-PARAMETERS + +``HashIndex`` +============= + +.. class:: HashIndex(fillfactor=None, **options) + + .. versionadded:: 2.2 + + Creates a hash index. + + Provide an integer value from 10 to 100 to the fillfactor_ parameter to + tune how packed the index pages will be. PostgreSQL's default is 90. + + .. admonition:: Use this index only on PostgreSQL 10 and later + + Hash indexes have been available in PostgreSQL for a long time, but + they suffer from a number of data integrity issues in older versions. + + .. _fillfactor: https://www.postgresql.org/docs/current/static/sql-createindex.html#SQL-CREATEINDEX-STORAGE-PARAMETERS -- cgit v1.3