On_delete options (CASCADE, PROTECT, SET_NULL) in Django

Introduction

These options tell Django what to do with related data when you delete an item. It helps keep your database clean and consistent.

When deleting a user should also delete all their posts (CASCADE).

When you want to prevent deleting a category if products still use it (PROTECT).

When deleting a parent object but want to keep child objects with a blank reference (SET_NULL).

Syntax

Django

ForeignKey(Model, on_delete=models.CASCADE|models.PROTECT|models.SET_NULL, null=True_if_SET_NULL)

Use null=True with SET_NULL to allow empty references.

These options are used inside Django model fields to control deletion behavior.

Examples

Deletes all posts if the author is deleted.

Django

author = models.ForeignKey(User, on_delete=models.CASCADE)

Prevents deleting a category if products still belong to it.

Django

category = models.ForeignKey(Category, on_delete=models.PROTECT)

Sets profile to null if the related profile is deleted.

Django

profile = models.ForeignKey(Profile, on_delete=models.SET_NULL, null=True)

Sample Program

This example shows three models using different on_delete options to control what happens when related objects are deleted.

Django

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)

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

class Product(models.Model):
    name = models.CharField(max_length=100)
    category = models.ForeignKey(Category, on_delete=models.PROTECT)

class Profile(models.Model):
    user_name = models.CharField(max_length=100)

class Comment(models.Model):
    content = models.TextField()
    profile = models.ForeignKey(Profile, on_delete=models.SET_NULL, null=True)

# Explanation:
# Deleting an Author deletes their Books (CASCADE).
# Deleting a Category is blocked if Products use it (PROTECT).
# Deleting a Profile sets Comment.profile to null (SET_NULL).

Important Notes

Always choose on_delete carefully to avoid accidental data loss.

PROTECT raises an error if deletion is blocked, so handle exceptions.

SET_NULL requires null=True on the field.

Summary

CASCADE deletes related objects automatically.

PROTECT stops deletion if related objects exist.

SET_NULL sets the relation to null instead of deleting.

Practice

1. What does the on_delete=models.CASCADE option do in Django models?

easy

A. Deletes related objects automatically when the referenced object is deleted.

B. Prevents deletion of the referenced object if related objects exist.

C. Sets the related field to null instead of deleting the object.

D. Raises an error if the related object is missing.

Solution

1. Step 1: Understand CASCADE behavior

   The CASCADE option means when the referenced object is deleted, all related objects are also deleted automatically.

2. Step 2: Compare with other options

   Unlike PROTECT or SET_NULL, CASCADE deletes dependent objects without error or nullifying fields.

3. Final Answer:

   Deletes related objects automatically when the referenced object is deleted. -> Option A

4. Quick Check:

   CASCADE = auto-delete related objects [OK]

Hint: CASCADE means delete all linked items automatically [OK]

Common Mistakes:

• Confusing CASCADE with PROTECT which blocks deletion
• Thinking CASCADE sets fields to null instead of deleting
• Assuming CASCADE raises errors on deletion

2. Which of the following is the correct syntax to use SET_NULL in a Django ForeignKey field?

easy

A. models.ForeignKey(OtherModel, on_delete=models.SET_NULL)

B. models.ForeignKey(OtherModel, on_delete=models.SET_NULL, null=True)

C. models.ForeignKey(OtherModel, on_delete=models.SET_NULL, blank=True)

D. models.ForeignKey(OtherModel, on_delete=models.SET_NULL, default=None)

Solution

1. Step 1: Recognize SET_NULL requires nullable field

   Using SET_NULL requires the field to allow null values, so null=True must be set.

2. Step 2: Check each option for null=True

   Only models.ForeignKey(OtherModel, on_delete=models.SET_NULL, null=True) includes null=True along with SET_NULL, making it valid syntax.

3. Final Answer:

   models.ForeignKey(OtherModel, on_delete=models.SET_NULL, null=True) -> Option B

4. Quick Check:

   SET_NULL needs null=True [OK]

Hint: SET_NULL needs null=True to allow null values [OK]

Common Mistakes:

• Omitting null=True with SET_NULL causes errors
• Confusing blank=True with null=True for database nulls
• Using default=None without null=True

3. Given the models:

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

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

What happens if you try to delete an Author who has related Book entries?

medium

A. The author is deleted but books remain with invalid author references.

B. The author is deleted and all related books are deleted too.

C. The author is deleted and the book's author field is set to null.

D. The deletion is blocked and raises an error.

Solution

1. Step 1: Understand PROTECT behavior

   PROTECT prevents deletion of the referenced object if related objects exist, raising an error instead.

2. Step 2: Apply to given models

   Since Book has a ForeignKey with PROTECT to Author, deleting an Author with Books will raise a ProtectedError.

3. Final Answer:

   The deletion is blocked and raises an error. -> Option D

4. Quick Check:

   PROTECT blocks deletion if related objects exist [OK]

Hint: PROTECT stops deletion if related objects exist [OK]

Common Mistakes:

• Assuming PROTECT deletes related objects like CASCADE
• Thinking PROTECT sets fields to null
• Ignoring the error raised on deletion attempt

4. Consider this model definition:

class Comment(models.Model):
    post = models.ForeignKey(Post, on_delete=models.SET_NULL)
    content = models.TextField()

What is the error in this code?

medium

A. No error, the code is correct.

B. ForeignKey cannot use SET_NULL as on_delete option.

C. Missing null=True on the ForeignKey field.

D. TextField cannot be used with ForeignKey.

Solution

1. Step 1: Check requirements for SET_NULL

   Using SET_NULL requires the ForeignKey field to allow null values by setting null=True.

2. Step 2: Identify missing null=True

   The code does not include null=True on the post field, causing an error.

3. Final Answer:

   Missing null=True on the ForeignKey field. -> Option C

4. Quick Check:

   SET_NULL needs null=True [OK]

Hint: SET_NULL requires null=True on ForeignKey [OK]

Common Mistakes:

• Assuming SET_NULL works without null=True
• Confusing TextField usage with ForeignKey
• Thinking SET_NULL is invalid on ForeignKey

5. You have two models:

class Category(models.Model):
    name = models.CharField(max_length=50)

class Product(models.Model):
    category = models.ForeignKey(Category, on_delete=models.SET_NULL, null=True)
    name = models.CharField(max_length=100)

If a Category is deleted, what happens to the related Product entries and why is this setup useful?

hard

A. Products keep their category field as null; useful to retain products without category.

B. Products are deleted automatically; useful to keep database clean.

C. Deletion is blocked; useful to prevent accidental data loss.

D. Products keep old category id; useful for historical reference.

Solution

1. Step 1: Understand SET_NULL with null=True

   When the referenced Category is deleted, the Product's category field is set to null instead of deleting the Product.

2. Step 2: Explain usefulness

   This allows products to remain in the database without a category, which is useful if products should not be deleted just because their category is removed.

3. Final Answer:

   Products keep their category field as null; useful to retain products without category. -> Option A

4. Quick Check:

   SET_NULL + null=True keeps related objects, nullifies field [OK]

Hint: SET_NULL keeps objects, sets field null to keep data [OK]

Common Mistakes:

• Assuming related products get deleted with SET_NULL
• Thinking deletion is blocked like PROTECT
• Believing old category id remains after deletion