Fixed #18046 - Documented than an index is created by default for ForeignKeys; thanks jbauer for the suggestion.

This commit is contained in:
Tim Graham 2012-10-16 16:12:52 -04:00
parent 4fb510fde4
commit db598dd8a0
1 changed files with 6 additions and 0 deletions

View File

@ -971,6 +971,12 @@ need to use::
This sort of reference can be useful when resolving circular import
dependencies between two applications.
A database index is automatically created on the ``ForeignKey``. You can
disable this by setting :attr:`~Field.db_index` to ``False``. You may want to
avoid the overhead of an index if you are creating a foreign key for
consistency rather than joins, or if you will be creating an alternative index
like a partial or multiple column index.
Database Representation
~~~~~~~~~~~~~~~~~~~~~~~