Browse Source

Doc'd that Meta.indexes is preferred to Field.db_index.

Adam Johnson 5 years ago
parent
commit
f9fe062de5
1 changed files with 7 additions and 0 deletions
  1. 7 0
      docs/ref/models/fields.txt

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