From db598dd8a053fe17c3308f89cd8f40676e2c479e Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Tue, 16 Oct 2012 16:12:52 -0400 Subject: [PATCH] Fixed #18046 - Documented than an index is created by default for ForeignKeys; thanks jbauer for the suggestion. --- docs/ref/models/fields.txt | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt index 02d8453b83..809d56eaf5 100644 --- a/docs/ref/models/fields.txt +++ b/docs/ref/models/fields.txt @@ -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 ~~~~~~~~~~~~~~~~~~~~~~~