What’s the difference between select_related and prefetch_related in Django ORM?

by

Your understanding is mostly correct. You use select_related when the object that you’re going to be selecting is a single object, so OneToOneField or a ForeignKey. You use prefetch_related when you’re going to get a “set” of things, so ManyToManyFields as you stated or reverse ForeignKeys. Just to clarify what I mean by “reverse ForeignKeys” here’s an example:

class ModelA(models.Model):
    pass

class ModelB(models.Model):
    a = ForeignKey(ModelA)

ModelB.objects.select_related('a').all() # Forward ForeignKey relationship
ModelA.objects.prefetch_related('modelb_set').all() # Reverse ForeignKey relationship

The difference is that select_related does an SQL join and therefore gets the results back as part of the table from the SQL server. prefetch_related on the other hand executes another query and therefore reduces the redundant columns in the original object (ModelA in the above example). You may use prefetch_related for anything that you can use select_related for.

The tradeoffs are that prefetch_related has to create and send a list of IDs to select back to the server, this can take a while. I’m not sure if there’s a nice way of doing this in a transaction, but my understanding is that Django always just sends a list and says SELECT … WHERE pk IN (…,…,…) basically. In this case if the prefetched data is sparse (let’s say U.S. State objects linked to people’s addresses) this can be very good, however if it’s closer to one-to-one, this can waste a lot of communications. If in doubt, try both and see which performs better.

Everything discussed above is basically about the communications with the database. On the Python side however prefetch_related has the extra benefit that a single object is used to represent each object in the database. With select_related duplicate objects will be created in Python for each “parent” object. Since objects in Python have a decent bit of memory overhead this can also be a consideration.

More Related Contents:

  1. Convert Django Model object to dict with all of the fields intact
  2. Django Aggregation: Summation of Multiplication of two fields
  3. How to create an object for a Django model with a many to many field?
  4. LEFT JOIN Django ORM
  5. Django Blob Model Field
  6. django.core.exceptions.ImproperlyConfigured: Requested setting INSTALLED_APPS, but settings are not configured. plz help me out plz
  7. What is the difference between null=True and blank=True in Django?
  8. Can “list_display” in a Django ModelAdmin display attributes of ForeignKey fields?
  9. Django – No such table: main.auth_user__old
  10. django abstract models versus regular inheritance
  11. Django Unique Together (with foreign keys)
  12. Getting TypeError: __init__() missing 1 required positional argument: ‘on_delete’ when trying to add parent table after child table with entries
  13. Django : Table doesn’t exist
  14. Django Rest Framework and JSONField
  15. How to filter objects for count annotation in Django?
  16. How do I separate my models out in django?
  17. Writing a __init__ function to be used in django model
  18. Difference between AbstractUser and AbstractBaseUser in Django?
  19. Customize/remove Django select box blank option
  20. Duplicating model instances and their related objects in Django / Algorithm for recusrively duplicating an object
  21. How to perform OR condition in django queryset?
  22. Override a form in Django admin
  23. Good ways to sort a queryset? – Django
  24. Resize fields in Django Admin
  25. Generic many-to-many relationships
  26. python_2_unicode_compatible error
  27. How to validate uniqueness constraint across foreign key (django)
  28. How to store a dictionary on a Django Model?
  29. How to properly use the “choices” field option in Django
  30. Django admin – inline inlines (or, three model editing at once)

Leave a Comment