OneToOneField for one-to-one in Django

Introduction

A OneToOneField links two database tables so each record in one table matches exactly one record in another. It helps keep related data organized.

You want to store extra information about a user in a separate table.

You have two models where each item in one must have exactly one matching item in the other.

You want to split a big model into smaller parts but keep a strict one-to-one link.

You need to extend a built-in Django model like User with custom fields.

You want to ensure no duplicates or multiple links between two models.

Syntax

Django

class ModelName(models.Model):
    field_name = models.OneToOneField(
        OtherModel,
        on_delete=models.CASCADE,
        related_name='related_name_optional',
        primary_key=False
    )

on_delete=models.CASCADE means if the linked record is deleted, this one deletes too.

related_name lets you access the reverse link from the other model.

Examples

Each Profile links to exactly one User. If the User is deleted, the Profile is deleted too.

Django

class Profile(models.Model):
    user = models.OneToOneField(User, on_delete=models.CASCADE)

You can access the Employee from a Badge using badge.employee.

Django

class Employee(models.Model):
    badge = models.OneToOneField(Badge, on_delete=models.CASCADE, related_name='employee')

Using primary_key=True makes this field the primary key of Passport.

Django

class Passport(models.Model):
    person = models.OneToOneField(Person, on_delete=models.CASCADE, primary_key=True)

Sample Program

This example shows a Profile model linked one-to-one with Django's User model. Each Profile belongs to exactly one User.

Django

from django.db import models
from django.contrib.auth.models import User

class Profile(models.Model):
    user = models.OneToOneField(User, on_delete=models.CASCADE)
    bio = models.TextField(blank=True)

# Usage example (in Django shell):
# user = User.objects.create(username='alice')
# profile = Profile.objects.create(user=user, bio='Hello!')
# print(profile.user.username)
# Output: alice

Important Notes

Always set on_delete to control what happens when the linked record is deleted.

OneToOneField creates a unique constraint automatically, so no two records can link to the same target.

You can access the linked object from either side using the field name or related_name.

Summary

OneToOneField links two models so each record matches exactly one record in the other.

Use it to extend models or keep related data in separate tables.

Remember to set on_delete and optionally related_name for easy access.

Practice

1. What is the main purpose of Django's OneToOneField?

easy

A. To store multiple values in a single database field

B. To create a many-to-many relationship between two models

C. To allow multiple records in one model to link to a single record in another

D. To link two models so each record in one matches exactly one record in the other

Solution

1. Step 1: Understand the relationship types in Django

   Django provides different fields for relationships: ForeignKey for many-to-one, ManyToManyField for many-to-many, and OneToOneField for one-to-one.

2. Step 2: Identify the purpose of OneToOneField

   OneToOneField links exactly one record in one model to exactly one record in another, ensuring a unique pairing.

3. Final Answer:

   To link two models so each record in one matches exactly one record in the other -> Option D

4. Quick Check:

   OneToOneField = unique pair link [OK]

Hint: OneToOneField means one record matches one record only [OK]

Common Mistakes:

• Confusing OneToOneField with ForeignKey
• Thinking it allows multiple links per record
• Using it to store multiple values in one field

2. Which of the following is the correct way to define a OneToOneField in a Django model?

easy

A. user = models.ForeignKey(User, on_delete=models.CASCADE)

B. user = models.OneToOneField(User)

C. user = models.OneToOneField(User, on_delete=models.CASCADE)

D. user = models.ManyToManyField(User)

Solution

1. Step 1: Check required parameters for OneToOneField

   OneToOneField requires the related model and the on_delete argument to specify behavior on deletion.

2. Step 2: Validate the options

   user = models.OneToOneField(User, on_delete=models.CASCADE) correctly includes both the related model and on_delete=models.CASCADE. user = models.OneToOneField(User) misses on_delete, which is mandatory.

3. Final Answer:

   user = models.OneToOneField(User, on_delete=models.CASCADE) -> Option C

4. Quick Check:

   OneToOneField needs on_delete [OK]

Hint: Always include on_delete with OneToOneField [OK]

Common Mistakes:

• Omitting on_delete argument
• Using ForeignKey or ManyToManyField instead
• Incorrect field syntax

3. Given these models:

class Profile(models.Model):
    user = models.OneToOneField(User, on_delete=models.CASCADE)
    bio = models.TextField()

user = User.objects.create(username='anna')
profile = Profile.objects.create(user=user, bio='Hello!')
print(profile.user.username)

What will be printed?

medium

A. Hello!

B. anna

C. profile

D. Error: user attribute missing

Solution

1. Step 1: Understand the OneToOneField link

   The Profile model links to User via OneToOneField named 'user'. The profile instance has a user with username 'anna'.

2. Step 2: Evaluate the print statement

   Accessing profile.user.username fetches the username of the linked User, which is 'anna'.

3. Final Answer:

   anna -> Option B

4. Quick Check:

   profile.user.username = anna [OK]

Hint: Access linked user via profile.user.username [OK]

Common Mistakes:

• Printing profile.bio instead of username
• Confusing attribute names
• Assuming user attribute is missing

4. What is wrong with this model definition?

class Employee(models.Model):
    user = models.OneToOneField(User)
    department = models.CharField(max_length=100)

medium

A. Missing on_delete argument in OneToOneField

B. OneToOneField cannot link to User model

C. department field must be IntegerField

D. OneToOneField should be ForeignKey

Solution

1. Step 1: Check OneToOneField requirements

   OneToOneField requires the on_delete argument to specify what happens if the linked User is deleted.

2. Step 2: Analyze the model code

   The model misses on_delete, which will cause an error when running migrations or server start.

3. Final Answer:

   Missing on_delete argument in OneToOneField -> Option A

4. Quick Check:

   OneToOneField needs on_delete [OK]

Hint: Always add on_delete to OneToOneField [OK]

Common Mistakes:

• Forgetting on_delete causes errors
• Thinking OneToOneField can't link to User
• Confusing field types for department

5. You want to extend Django's User model to add a phone number without modifying the original User table. Which is the best way to do this using OneToOneField?

hard

A. Create a new Profile model with a OneToOneField to User and add phone number there

B. Add a phone number field directly to the User model

C. Use a ForeignKey from User to Profile with phone number

D. Create a ManyToManyField between User and phone numbers

Solution

1. Step 1: Understand extending User without changing it

   To add extra info without altering User, create a separate model linked one-to-one to User.

2. Step 2: Choose the correct relationship

   OneToOneField in a Profile model allows storing phone number linked uniquely to each User.

3. Final Answer:

   Create a new Profile model with a OneToOneField to User and add phone number there -> Option A

4. Quick Check:

   Extend User via OneToOneField in separate model [OK]

Hint: Use OneToOneField in new model to extend User [OK]

Common Mistakes:

• Modifying User model directly
• Using ForeignKey or ManyToManyField incorrectly
• Not linking phone number uniquely to User