From fd90a906333b569340e5507fec3f3a4d4c1d0f47 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Tue, 16 Oct 2012 16:12:52 -0400 Subject: [PATCH] [1.4.X] Fixed #18046 - Documented that an index is created by default for ForeignKeys; thanks jbauer for the suggestion. Backport of db598dd8a0 from master --- 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 c8b9db33f6..b186a461c7 100644 --- a/docs/ref/models/fields.txt +++ b/docs/ref/models/fields.txt @@ -972,6 +972,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 ~~~~~~~~~~~~~~~~~~~~~~~