The following are PostgreSQL specific indexes\navailable from the django.contrib.postgres.indexes module.
BloomIndexLink to this heading#Creates a bloom index.
\nTo use this index access you need to activate the bloom extension on\nPostgreSQL. You can install it using the\nBloomExtension migration\noperation.
Provide an integer number of bits from 1 to 4096 to the length\nparameter to specify the length of each index entry. PostgreSQL’s default\nis 80.
The columns argument takes a tuple or list of up to 32 values that are\ninteger number of bits from 1 to 4095.
BrinIndexLink to this heading#Creates a BRIN index.
\nSet the autosummarize parameter to True to enable automatic\nsummarization to be performed by autovacuum.
The pages_per_range argument takes a positive integer.
BTreeIndexLink to this heading#Creates a B-Tree index.
\nProvide an integer value from 10 to 100 to the fillfactor parameter to\ntune how packed the index pages will be. PostgreSQL’s default is 90.
\nProvide a boolean value to the deduplicate_items parameter to control\nwhether deduplication is enabled. PostgreSQL enables deduplication by\ndefault.
\n\nGinIndexLink to this heading#Creates a gin index.
\nTo use this index on data types not in the built-in operator classes,\nyou need to activate the btree_gin extension on\nPostgreSQL. You can install it using the\nBtreeGinExtension migration\noperation.
Set the fastupdate parameter to False to disable the GIN Fast\nUpdate Technique that’s enabled by default in PostgreSQL.
Provide an integer number of kilobytes to the gin_pending_list_limit\nparameter to tune the maximum size of the GIN pending list which is used\nwhen fastupdate is enabled.
GistIndexLink to this heading#Creates a GiST index. These indexes are\nautomatically created on spatial fields with spatial_index=True. They’re\nalso useful on other types, such as\nHStoreField or the range\nfields.
To use this index on data types not in the built-in gist operator classes,\nyou need to activate the btree_gist extension on PostgreSQL.\nYou can install it using the\nBtreeGistExtension migration\noperation.
Set the buffering parameter to True or False to manually enable\nor disable buffering build of the index.
Provide an integer value from 10 to 100 to the fillfactor parameter to\ntune how packed the index pages will be. PostgreSQL’s default is 90.
\nHashIndexLink to this heading#Creates a hash index.
\nProvide an integer value from 10 to 100 to the fillfactor parameter to\ntune how packed the index pages will be. PostgreSQL’s default is 90.
\nSpGistIndexLink to this heading#Creates an SP-GiST index.
\nProvide an integer value from 10 to 100 to the fillfactor parameter to\ntune how packed the index pages will be. PostgreSQL’s default is 90.
\nOpClass() expressionsLink to this heading#An OpClass() expression represents the expression with a custom\noperator class that can be used to define functional indexes, functional\nunique constraints, or exclusion constraints. To use it, you need to add\n'django.contrib.postgres' in your INSTALLED_APPS. Set the\nname parameter to the name of the operator class.
For example:
\nIndex(\n OpClass(Lower("username"), name="varchar_pattern_ops"),\n name="lower_username_idx",\n)\ncreates an index on Lower('username') using varchar_pattern_ops.
UniqueConstraint(\n OpClass(Upper("description"), name="text_pattern_ops"),\n name="upper_description_unique",\n)\ncreates a unique constraint on Upper('description') using\ntext_pattern_ops.
ExclusionConstraint(\n name="exclude_overlapping_ops",\n expressions=[\n (OpClass("circle", name="circle_ops"), RangeOperators.OVERLAPS),\n ],\n)\ncreates an exclusion constraint on circle using circle_ops.