Difference between Django OneToOneField and ForeignKey with example?

Both OneToOneField and ForeignKey are used to define relationships between models in Django. However, they represent different types of relationships with distinct characteristics. Here’s a comparison along with code examples to illustrate the differences:

ForeignKey:

  • Represents a one-to-many relationship.
  • Each instance of the referring model can be related to multiple instances of the referenced model.
  • The ForeignKey is added to the model that “owns” the relationship.

Example:

from django.db import models

class Author(models.Model):
name = models.CharField(max_length=100)

class Book(models.Model):
title = models.CharField(max_length=100)
author = models.ForeignKey(Author, on_delete=models.CASCADE)

In this example, each Book instance has a ForeignKey to an Author, indicating that multiple books can be associated with the same author.

OneToOneField:

  • Represents a one-to-one relationship.
  • Each instance of the referring model is related to exactly one instance of the referenced model, and vice versa.
  • Often used to model things like profiles, user extensions, or specific one-to-one relationships.

Example:

from django.db import models

class Person(models.Model):
name = models.CharField(max_length=100)

class Profile(models.Model):
person = models.OneToOneField(Person, on_delete=models.CASCADE)
bio = models.TextField()

In this example, each Profile instance has a OneToOneField to a Person, indicating that each person has one and only one profile.

To summarize:

  • Use ForeignKey when you have a one-to-many relationship, where each instance of the referring model can be related to multiple instances of the referenced model.
  • Use OneToOneField when you have a one-to-one relationship, where each instance of the referring model is related to exactly one instance of the referenced model.

Remember to consider the nature of the relationship you’re modeling to determine whether to use ForeignKey or OneToOneField in your Django models.