diff options
| author | Mads Jensen <mje@inducks.org> | 2016-10-13 14:39:44 +0200 |
|---|---|---|
| committer | Mads Jensen <mje@inducks.org> | 2017-01-15 13:37:18 +0100 |
| commit | e585c43be91fb3e5005ddb4191f64142c62a2ec3 (patch) | |
| tree | 6d4aade646ed38ed5cf94b080ec0a26bc8327a4f /docs | |
| parent | 236ebe94bfe24d394d5b49f4405da445550e8aa6 (diff) | |
Fixed #25809 -- Added BrinIndex support in django.contrib.postgres.
Thanks Tim Graham and Markus Holtermann for review.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ref/contrib/postgres/indexes.txt | 10 | ||||
| -rw-r--r-- | docs/releases/1.11.txt | 5 |
2 files changed, 13 insertions, 2 deletions
diff --git a/docs/ref/contrib/postgres/indexes.txt b/docs/ref/contrib/postgres/indexes.txt index 9b8ab5ffa2..0995d1b75e 100644 --- a/docs/ref/contrib/postgres/indexes.txt +++ b/docs/ref/contrib/postgres/indexes.txt @@ -9,6 +9,16 @@ PostgreSQL specific model indexes The following are PostgreSQL specific :doc:`indexes </ref/models/indexes>` available from the ``django.contrib.postgres.indexes`` module. +``BrinIndex`` +============= + +.. class:: BrinIndex(pages_per_range=None) + + Creates a `BRIN index + <https://www.postgresql.org/docs/current/static/brin-intro.html>`_. For + performance considerations and use cases of the index, please consult the + documentation. + ``GinIndex`` ============ diff --git a/docs/releases/1.11.txt b/docs/releases/1.11.txt index e5b0efffef..0e47203549 100644 --- a/docs/releases/1.11.txt +++ b/docs/releases/1.11.txt @@ -212,8 +212,9 @@ Minor features :class:`~django.contrib.postgres.aggregates.StringAgg` determines if concatenated values will be distinct. -* The new :class:`~django.contrib.postgres.indexes.GinIndex` class allows - creating gin indexes in the database. +* The new :class:`~django.contrib.postgres.indexes.GinIndex` and + :class:`~django.contrib.postgres.indexes.BrinIndex` classes allow + creating ``GIN`` and ``BRIN`` indexes in the database. * :class:`~django.contrib.postgres.fields.JSONField` accepts a new ``encoder`` parameter to specify a custom class to encode data types not supported by the |
