summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNick Pope <nick.pope@flightdataservices.com>2018-07-30 23:28:11 +0100
committerTim Graham <timograham@gmail.com>2018-08-02 11:42:57 -0400
commit6b4d1ec8ff97cff4f1683912b0147d22410b05b8 (patch)
tree07604a2c67f6378cc96084445ecd90fe8a0a23ea /docs
parentd6381d3559b469ce25f4906151b9329c1f946f14 (diff)
Fixed #29614 -- Added BTreeIndex to django.contrib.postres.
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/contrib/postgres/indexes.txt14
-rw-r--r--docs/releases/2.2.txt5
2 files changed, 17 insertions, 2 deletions
diff --git a/docs/ref/contrib/postgres/indexes.txt b/docs/ref/contrib/postgres/indexes.txt
index cb0decc9a1..ef19384fb8 100644
--- a/docs/ref/contrib/postgres/indexes.txt
+++ b/docs/ref/contrib/postgres/indexes.txt
@@ -26,6 +26,20 @@ available from the ``django.contrib.postgres.indexes`` module.
The ``autosummarize`` parameter was added.
+``BTreeIndex``
+==============
+
+.. class:: BTreeIndex(fillfactor=None, **options)
+
+ .. versionadded:: 2.2
+
+ 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.
+
+ .. _fillfactor: https://www.postgresql.org/docs/current/static/sql-createindex.html#SQL-CREATEINDEX-STORAGE-PARAMETERS
+
``GinIndex``
============
diff --git a/docs/releases/2.2.txt b/docs/releases/2.2.txt
index 161f477695..13dac6bfec 100644
--- a/docs/releases/2.2.txt
+++ b/docs/releases/2.2.txt
@@ -82,9 +82,10 @@ Minor features
:class:`~django.contrib.postgres.aggregates.StringAgg` determines the
ordering of the aggregated elements.
-* The new :class:`~django.contrib.postgres.indexes.HashIndex` and
+* The new :class:`~django.contrib.postgres.indexes.BTreeIndex`,
+ :class:`~django.contrib.postgres.indexes.HashIndex` and
:class:`~django.contrib.postgres.indexes.SpGistIndex` classes allow
- creating ``hash`` and ``SP-GiST`` indexes in the database.
+ creating ``B-Tree``, ``hash``, and ``SP-GiST`` indexes in the database.
* :class:`~django.contrib.postgres.indexes.BrinIndex` now has the
``autosummarize`` parameter.