From 4751fd9ba7dd761430be4b00b88221c6d2240f90 Mon Sep 17 00:00:00 2001
From: Malcolm Tredinnick <malcolm.tredinnick@gmail.com>
Date: Thu, 13 Sep 2007 02:48:06 +0000
Subject: [PATCH] Added a note about not using 'pk' as a field name for a
 non-primary-key field.

git-svn-id: http://code.djangoproject.com/svn/django/branches/queryset-refactor@6114 bcc190cf-cafb-0310-a4f2-bffc1f526a37
---
 docs/db-api.txt | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/docs/db-api.txt b/docs/db-api.txt
index 2a90b2d171..d1646ba6ea 100644
--- a/docs/db-api.txt
+++ b/docs/db-api.txt
@@ -1348,6 +1348,11 @@ equivalent::
     Entry.objects.filter(blog__id=3) # __exact is implied
     Entry.objects.filter(blog__pk=3) # __pk implies __id__exact
 
+.. note::
+    Because of this shortcut, you cannot have a field in your model called
+    ``pk`` that is not the primary key of the model. It will always be
+    replaced by the name of the model's primary key in queries.
+
 Lookups that span relationships
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~