Opened 10 years ago

Last modified 4 months ago

#16281 new Bug

ContentType.get_object_for_this_type using wrong database for creating object

Reported by: tfrydrychewicz@… Owned by: Dan Poirier
Component: contrib.contenttypes Version: master
Severity: Normal Keywords: contenttype, object get_object_for_this_type, database, multiple
Cc: gklein@… Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: yes Patch needs improvement: no
Easy pickings: no UI/UX: no


There is a subtle error in ContentType.get_object_for_this_type method.

def get_object_for_this_type(self, **kwargs):
    return self.model_class()._default_manager.using(self._state.db).get(**kwargs)

Database used to get model_class object is taken from self._state.db, which provides an error when contenttype model is hold in one database and model, of which object we're going to create, in another one.

Database should be provided using self.model_class().objects.db not self._state.db.

Attachments (1)

16281.diff (656 bytes) - added by tfrydrychewicz@… 10 years ago.

Download all attachments as: .zip

Change History (18)

Changed 10 years ago by tfrydrychewicz@…

Attachment: 16281.diff added


comment:1 Changed 10 years ago by anonymous

Needs tests: set

comment:2 Changed 10 years ago by Stephen Burrows

Triage Stage: UnreviewedAccepted
Version: 1.3SVN

comment:3 Changed 10 years ago by Ramiro Morales

See also #16088.

comment:4 Changed 9 years ago by Dan Poirier

Owner: changed from nobody to Dan Poirier
Status: newassigned

comment:5 Changed 9 years ago by Dan Poirier

Cc: Dan Poirier added
Resolution: invalid
Status: assignedclosed

After studying this, I'm not sure the current code is wrong. I'd want to see a use case in which Django clearly does the wrong thing to be convinced otherwise. Please re-open the ticket if there is one.

The proposed fix:

 -        return self.model_class()._base_manager.using(self._state.db).get(**kwargs)
 +        return self.model_class()._base_manager.using(self.model_class().objects.db).get(**kwargs)

seems to assume that there is exactly one database in which it is correct to look for instances of a given model, but in Django, it's not required that all instances of a model be stored in one database.

Applying the fix causes one of the multiple database tests, test_generic_key_separation(), to fail. This test puts pairs of related instances in each of the two test databases and ensures that querying for the related instances works, but after this change, is unable to find the related instance in the 2nd database correctly, probably because now get_object_for_this_type() is only looking in the default database.

The test does assume that ContentType objects exist in every database in which a model has instances, but that seems reasonable, given the requirement in Django that related objects be stored in the same database. ContentType objects don't actually have ForeignKeys, but logically they're still related to the models they represent.

The current code looks for the instance of the requested model in the same database in which the ContentType instance being used was found, which fits in with the "related instances in same database" requirement.

However, in working through all this, I found nothing in the Django documentation discussing how the content type framework and multiple databases interact, and perhaps this ticket demonstrates the need for more documentation on how to correctly use content types when multiple databases are involved.

comment:6 Changed 8 years ago by Gertjan Klein <gklein@…>

Resolution: invalid
Status: closedreopened

I don't understand the patch or it's implications enough to comment on it. However, I can confirm this is a valid bug in Django 1.4. I have an application where some tables reside in a mysql database; these are pre-existing tables, not managed by Django, for which I created models using inspectdb. Everything else (auth, contenttypes, ...) resides in a sqlite database. A database router manages which model is mapped to which database. This works fine everywhere.

Recently, I decided to add a get_absolute_url method to one of the models residing in the mysql database. I now have a "show on site" link in the admin for that model. Without the patch above, clicking this link causes a DatabaseError exception, because Django attempts to access the model's table in the sqlite database.

It seems to me that this should just work. Django knows the model's table resides in the mysql database, because it is editing an instance of it.

The proposed fix above does indeed fix this problem for me: the link now properly links to my site. (I haven't tried trunk, but the relevant code appears to be unchanged from 1.4, so I expect it to behave the same.)

comment:7 Changed 8 years ago by Gertjan Klein <gklein@…>

Cc: gklein@… added
Severity: Release blockerNormal

comment:8 Changed 8 years ago by Aymeric Augustin

Status: reopenednew

comment:9 Changed 8 years ago by anonymous

Based on poirier's earlier comment, would it not work to simply remove the .using(self._state.db) clause from the original code altogether? Then the DB router could do its usual job of deciding where to point the query.

comment:10 in reply to:  9 ; Changed 8 years ago by Gertjan Klein <gklein@…>

Replying to anonymous:

would it not work to simply remove the .using(self._state.db) clause from the original code altogether?

I can confirm that works in my situation (described above in [comment 6 comment:6]).

comment:11 Changed 8 years ago by Dan Poirier

Cc: Dan Poirier removed

comment:12 in reply to:  10 Changed 8 years ago by anonymous

Replying to Gertjan Klein <gklein@…>:

Replying to anonymous:

would it not work to simply remove the .using(self._state.db) clause from the original code altogether?

I can confirm that works in my situation (described above in [comment 6 comment:6]).

This also fixes the problem in for me. However, it also causes test_generic_key_separation (regressiontests.multiple_database.tests.QueryTestCase) to fail (just like the proposed fix by poirier above). This isn't a problem in my application, but it clearly is a regression elsewhere.

This change allows get_object_for_this_type to continue using the instance._state.db for the regression test case, but the router-provided database for cases that don't specify a database. I don't think this change is complete, as there are almost certainly more locations that need to pass using= in order to not regress.

diff --git a/django/contrib/contenttypes/ b/django/contrib/contenttypes/
index e83c83a..ee04262 100644
--- a/django/contrib/contenttypes/
+++ b/django/contrib/contenttypes/
@@ -123,7 +123,7 @@ class GenericForeignKey(object):
             if ct_id:
                 ct = self.get_content_type(id=ct_id, using=instance._state.db)
-                    rel_obj = ct.get_object_for_this_type(pk=getattr(instance, self.fk_field))
+                    rel_obj = ct.get_object_for_this_type(using=instance._state.db, pk=getattr(instance, self.fk_field))
                 except ObjectDoesNotExist:
             setattr(instance, self.cache_attr, rel_obj)
diff --git a/django/contrib/contenttypes/ b/django/contrib/contenttypes/
index b658655..4c4d92b 100644
--- a/django/contrib/contenttypes/
+++ b/django/contrib/contenttypes/
@@ -157,20 +157,23 @@ class ContentType(models.Model):
         return models.get_model(self.app_label, self.model,
-    def get_object_for_this_type(self, **kwargs):
+    def get_object_for_this_type(self, using=None, **kwargs):
         Returns an object of this type for the keyword arguments given.
         Basically, this is a proxy around this object_type's get_object() model
         method. The ObjectNotExist exception, if thrown, will not be caught,
         so code that calls this method should catch it.
-        return self.model_class()._base_manager.using(self._state.db).get(**kwargs)
+        if using:
+            return self.model_class()._base_manager.using(using).get(**kwargs)
+        else:
+            return self.model_class()._base_manager.get(**kwargs)
     def get_all_objects_for_this_type(self, **kwargs):
         Returns all objects of this type for the keyword arguments given.
-        return self.model_class()._base_manager.using(self._state.db).filter(**kwargs)
+        return self.model_class()._base_manager.filter(**kwargs)
     def natural_key(self):
         return (self.app_label, self.model)

comment:13 Changed 6 years ago by Greg Brown

I've just been bitten by this bug (django 1.7) - I have a particular app in a separate database, and now the admin's "view on site" link doesn't work because it's looking for the object in the default database. What are the chances of it being addressed?

I don't really think this is an edge case; as it stands the "view on site" link will fail for *any* object kept in a separate database, and before 1.7 the only way to remove said link is to remove the get_absolute_url method from the model.

Last edited 6 years ago by Greg Brown (previous) (diff)

comment:14 Changed 6 years ago by Tim Graham

It looks to me like writing a patch with tests is the next step to address this.

comment:15 Changed 5 years ago by Tim Graham

Might be a duplicate of #15610 as the patch proposed there also modifies these methods.

comment:16 Changed 5 years ago by Tim Graham

#25564 is a duplicate.

comment:17 Changed 4 months ago by Tim Graham

#30760 is another duplicate.

Note: See TracTickets for help on using tickets.
Back to Top