Code

Ticket #18046: 18046.diff

File 18046.diff, 711 bytes (added by timo, 21 months ago)
Line 
1diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt
2index 02d8453..809d56e 100644
3--- a/docs/ref/models/fields.txt
4+++ b/docs/ref/models/fields.txt
5@@ -971,6 +971,12 @@ need to use::
6 This sort of reference can be useful when resolving circular import
7 dependencies between two applications.
8 
9+A database index is automatically created on the ``ForeignKey``. You can
10+disable this by setting :attr:`~Field.db_index` to ``False``.  You may want to
11+avoid the overhead of an index if you are creating a foreign key for
12+consistency rather than joins, or if you will be creating an alternative index
13+like a partial or multiple column index.
14+
15 Database Representation
16 ~~~~~~~~~~~~~~~~~~~~~~~
17