diff options
Diffstat (limited to 'docs/ref')
| -rw-r--r-- | docs/ref/contrib/postgres/indexes.txt | 23 | ||||
| -rw-r--r-- | docs/ref/contrib/postgres/operations.txt | 9 |
2 files changed, 32 insertions, 0 deletions
diff --git a/docs/ref/contrib/postgres/indexes.txt b/docs/ref/contrib/postgres/indexes.txt index 3c5ff89c67..f9c0fb2f97 100644 --- a/docs/ref/contrib/postgres/indexes.txt +++ b/docs/ref/contrib/postgres/indexes.txt @@ -7,6 +7,29 @@ PostgreSQL specific model indexes The following are PostgreSQL specific :doc:`indexes </ref/models/indexes>` available from the ``django.contrib.postgres.indexes`` module. +``BloomIndex`` +============== + +.. class:: BloomIndex(length=None, columns=(), **options) + + .. versionadded:: 3.1 + + Creates a bloom_ index. + + To use this index access you need to activate the bloom_ extension on + PostgreSQL. You can install it using the + :class:`~django.contrib.postgres.operations.BloomExtension` migration + operation. + + Provide an integer number of bits from 1 to 4096 to the ``length`` + parameter to specify the length of each index entry. PostgreSQL's default + is 80. + + The ``columns`` argument takes a tuple or list of up to 32 values that are + integer number of bits from 1 to 4095. + + .. _bloom: https://www.postgresql.org/docs/current/bloom.html + ``BrinIndex`` ============= diff --git a/docs/ref/contrib/postgres/operations.txt b/docs/ref/contrib/postgres/operations.txt index 1329ff1f9e..620e5db8b7 100644 --- a/docs/ref/contrib/postgres/operations.txt +++ b/docs/ref/contrib/postgres/operations.txt @@ -49,6 +49,15 @@ run the query ``CREATE EXTENSION IF NOT EXISTS hstore;``. This is a required argument. The name of the extension to be installed. +``BloomExtension`` +================== + +.. class:: BloomExtension() + + .. versionadded:: 3.1 + + Install the ``bloom`` extension. + ``BtreeGinExtension`` ===================== |