summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAdam Johnson <me@adamj.eu>2020-04-14 13:53:42 +0100
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2023-02-24 09:48:54 +0100
commit5a82acbda8c9a7b83030101024def2404318dca9 (patch)
tree60c5c0b033c636c7625bfcf25386c4b06b51b8fb /docs
parentce69dba0000be7686eabdffa9a8ff60296229109 (diff)
[4.2.x] Doc'd that Meta.indexes is preferred to Field.db_index.
Backport of f9fe062de5fc0896d6bbbf3f260b5c44473b3c77 from main
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/models/fields.txt7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt
index 81f3013892..c449a1381c 100644
--- a/docs/ref/models/fields.txt
+++ b/docs/ref/models/fields.txt
@@ -351,6 +351,13 @@ looking at your Django code. For example::
If ``True``, a database index will be created for this field.
+.. admonition:: Use the :attr:`~Options.indexes` option instead.
+
+ Where possible, use the :attr:`Meta.indexes <Options.indexes>` option
+ instead. In nearly all cases, :attr:`~Options.indexes` provides more
+ functionality than ``db_index``. ``db_index`` may be deprecated in the
+ future.
+
``db_tablespace``
-----------------