The following are PostgreSQL specific indexes
available from the django.contrib.postgres.indexes
module.
BloomIndex
BloomIndex
(length=None, columns=(), **options)
Creates a bloom index.
To use this index access you need to activate the bloom extension on
PostgreSQL. You can install it using the
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.
BrinIndex
BrinIndex
(autosummarize=None, pages_per_range=None, **options)Creates a BRIN index.
Set the autosummarize
parameter to True
to enable [https://www.postgresql.org/docs/current/brin-intro.html#BRIN-OPERATION automatic
summarization] to be performed by autovacuum.
The pages_per_range
argument takes a positive integer.
BTreeIndex
BTreeIndex
(fillfactor=None, **options)Creates a B-Tree index.
Provide an integer value from 10 to 100 to the fillfactor parameter to tune how packed the index pages will be. PostgreSQL's default is 90.
GinIndex
GinIndex
(fastupdate=None, gin_pending_list_limit=None, **options)Creates a gin index.
To use this index on data types not in the built-in operator classes,
you need to activate the btree_gin extension on
PostgreSQL. You can install it using the
BtreeGinExtension
migration
operation.
Set the fastupdate
parameter to False
to disable the [https://www.postgresql.org/docs/current/gin-implementation.html#GIN-FAST-UPDATE GIN Fast
Update Technique] that's enabled by default in PostgreSQL.
Provide an integer number of bytes to the gin_pending_list_limit parameter
to tune the maximum size of the GIN pending list which is used when
fastupdate
is enabled.
GistIndex
GistIndex
(buffering=None, fillfactor=None, **options)Creates a GiST index. These indexes are
automatically created on spatial fields with spatial_index=True
. They're
also useful on other types, such as
HStoreField
or the range
fields.
To use this index on data types not in the built-in gist operator classes,
you need to activate the btree_gist extension on PostgreSQL.
You can install it using the
BtreeGistExtension
migration
operation.
Set the buffering
parameter to True
or False
to manually enable
or disable buffering build of the index.
Provide an integer value from 10 to 100 to the fillfactor parameter to tune how packed the index pages will be. PostgreSQL's default is 90.
HashIndex
HashIndex
(fillfactor=None, **options)Creates a hash index.
Provide an integer value from 10 to 100 to the fillfactor parameter to tune how packed the index pages will be. PostgreSQL's default is 90.
Use this index only on PostgreSQL 10 and later
Hash indexes have been available in PostgreSQL for a long time, but they suffer from a number of data integrity issues in older versions.
SpGistIndex
SpGistIndex
(fillfactor=None, **options)Creates an SP-GiST index.
Provide an integer value from 10 to 100 to the fillfactor parameter to tune how packed the index pages will be. PostgreSQL's default is 90.