diff options
Diffstat (limited to 'docs/ref/contrib/postgres')
| -rw-r--r-- | docs/ref/contrib/postgres/index.txt | 1 | ||||
| -rw-r--r-- | docs/ref/contrib/postgres/indexes.txt | 24 |
2 files changed, 25 insertions, 0 deletions
diff --git a/docs/ref/contrib/postgres/index.txt b/docs/ref/contrib/postgres/index.txt index d04ed14889..5a212fbdcd 100644 --- a/docs/ref/contrib/postgres/index.txt +++ b/docs/ref/contrib/postgres/index.txt @@ -35,6 +35,7 @@ release. Some fields require higher versions. fields forms functions + indexes lookups operations search diff --git a/docs/ref/contrib/postgres/indexes.txt b/docs/ref/contrib/postgres/indexes.txt new file mode 100644 index 0000000000..7bf26fb117 --- /dev/null +++ b/docs/ref/contrib/postgres/indexes.txt @@ -0,0 +1,24 @@ +================================= +PostgreSQL specific model indexes +================================= + +.. module:: django.contrib.postgres.indexes + +.. versionadded:: 1.11 + +The following are PostgreSQL specific :doc:`indexes </ref/models/indexes>` +available from the ``django.contrib.postgres.indexes`` module. + +``GinIndex`` +============ + +.. class:: GinIndex() + + Creates a `gin index + <https://www.postgresql.org/docs/current/static/gin.html>`_. + + To use this index, you need to activate the `btree_gin extension + <https://www.postgresql.org/docs/current/static/btree-gin.html>`_ on + PostgreSQL. You can install it using the + :class:`~django.contrib.postgres.operations.BtreeGinExtension` migration + operation. |