django/docs/ref/contrib/postgres/indexes.txt

25 lines
731 B
Plaintext
Raw Normal View History

=================================
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.