Documented Meta.indexes a better option than Field.db_index

2020-04-14 13:53:42 +01:00 · 2020-04-14 13:53:42 +01:00 · 60507a339a
parent dab48b7482
commit 60507a339a
1 changed files with 7 additions and 0 deletions
--- a/docs/ref/models/fields.txt
+++ b/docs/ref/models/fields.txt
@ -332,6 +332,13 @@ scenes.

 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``
 -----------------