Related name for reverse access in Django

Introduction

Related name lets you easily find all items linked to another item in a database. It helps you go backward from one object to many connected objects.

You want to get all comments related to a blog post.

You want to find all orders made by a customer.

You want to list all books written by an author.

You want to access all tasks assigned to a project.

You want to retrieve all messages sent by a user.

Syntax

Django

class ModelA(models.Model):
    # fields

class ModelB(models.Model):
    model_a = models.ForeignKey(ModelA, related_name='related_name_here', on_delete=models.CASCADE)
    # other fields

The related_name is a string you choose to name the reverse link.

Use related_name inside the ForeignKey or OneToOneField to set the reverse accessor.

Examples

You can access all books of an author by author.books.all().

Django

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

class Book(models.Model):
    author = models.ForeignKey(Author, related_name='books', on_delete=models.CASCADE)
    title = models.CharField(max_length=200)

Use customer.orders.all() to get all orders for a customer.

Django

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

class Order(models.Model):
    customer = models.ForeignKey(Customer, related_name='orders', on_delete=models.CASCADE)
    order_date = models.DateField()

Access all tasks of a project with project.tasks.all().

Django

class Project(models.Model):
    title = models.CharField(max_length=100)

class Task(models.Model):
    project = models.ForeignKey(Project, related_name='tasks', on_delete=models.CASCADE)
    description = models.TextField()

Sample Program

This example shows how to set a related name 'books' to access all books of an author easily.

Django

from django.db import models

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

class Book(models.Model):
    author = models.ForeignKey(Author, related_name='books', on_delete=models.CASCADE)
    title = models.CharField(max_length=200)

# Usage example (not part of models):
# author = Author.objects.create(name='Alice')
# Book.objects.create(author=author, title='Book One')
# Book.objects.create(author=author, title='Book Two')
# print([book.title for book in author.books.all()])

Important Notes

If you don't set related_name, Django uses modelname_set by default (e.g., author.book_set.all()).

Choose clear and meaningful related names to keep your code readable.

Summary

related_name sets the name to access related objects backward.

It helps you get all linked items from the other side easily.

Always use it to make your code clearer and avoid default names.

Practice

1. What does the related_name attribute do in a Django model's ForeignKey field?

easy

A. It sets the name used to access related objects from the other model.

B. It changes the database table name for the model.

C. It defines the primary key of the model.

D. It specifies the default ordering of query results.

Solution

1. Step 1: Understand the purpose of related_name

   The related_name attribute defines how you access related objects from the reverse side of a ForeignKey relationship.

2. Step 2: Identify what related_name affects

   It does not affect table names, primary keys, or ordering but sets the attribute name for reverse access.

3. Final Answer:

   It sets the name used to access related objects from the other model. -> Option A

4. Quick Check:

   related_name = reverse access name [OK]

Hint: related_name names reverse access from related model [OK]

Common Mistakes:

• Confusing related_name with table name
• Thinking it sets primary key
• Assuming it controls query ordering

2. Which of the following is the correct way to set a related_name in a Django ForeignKey field?

easy

A. author = models.ForeignKey(Author, reverse_name='books', on_delete=models.CASCADE)

B. author = models.ForeignKey(Author, related='books', on_delete=models.CASCADE)

C. author = models.ForeignKey(Author, related_name='books', on_delete=models.CASCADE)

D. author = models.ForeignKey(Author, relation_name='books', on_delete=models.CASCADE)

Solution

1. Step 1: Recall correct attribute name

   The correct attribute to set reverse access name is related_name.

2. Step 2: Check syntax correctness

   author = models.ForeignKey(Author, related_name='books', on_delete=models.CASCADE) uses related_name='books' correctly; others use incorrect attribute names.

3. Final Answer:

   author = models.ForeignKey(Author, related_name='books', on_delete=models.CASCADE) -> Option C

4. Quick Check:

   Use related_name= for reverse access [OK]

Hint: Use exact attribute name 'related_name' in ForeignKey [OK]

Common Mistakes:

• Using 'related' instead of 'related_name'
• Using 'reverse_name' or 'relation_name' which don't exist
• Missing on_delete argument

3. Given these models:

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

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

What will author.books.all() return?

medium

A. All Author objects related to that Book instance.

B. All Book objects related to that Author instance.

C. A syntax error because 'books' is not defined.

D. An empty queryset always.

Solution

1. Step 1: Understand related_name usage

   The related_name='books' allows accessing all Book objects from an Author instance using author.books.

2. Step 2: Interpret the method call

   author.books.all() returns a queryset of all Book objects linked to that Author.

3. Final Answer:

   All Book objects related to that Author instance. -> Option B

4. Quick Check:

   author.books.all() = related books [OK]

Hint: related_name lets you get all related objects easily [OK]

Common Mistakes:

• Thinking it returns Author objects
• Assuming syntax error due to related_name
• Expecting empty queryset without data

4. Identify the error in this model definition:

class Comment(models.Model):
    post = models.ForeignKey(Post, related_name='post', on_delete=models.CASCADE)
    text = models.TextField()

What problem will this cause?

medium

A. It will cause a syntax error because related_name cannot be 'post'.

B. It will cause a runtime error because TextField is not allowed here.

C. It will work fine without any issues.

D. It will cause a reverse accessor clash if Post already has a field named 'post'.

Solution

1. Step 1: Understand related_name uniqueness

   The related_name must be unique per model to avoid clashes.

2. Step 2: Analyze the name 'post'

   If Post model already has a field or reverse accessor named 'post', this causes a clash error.

3. Final Answer:

   It will cause a reverse accessor clash if Post already has a field named 'post'. -> Option D

4. Quick Check:

   related_name must be unique to avoid clashes [OK]

Hint: Avoid related_name same as model or field names [OK]

Common Mistakes:

• Assuming related_name can be any string without conflict
• Thinking related_name causes syntax error
• Believing TextField is invalid here

5. You have these models:

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

class Product(models.Model):
    category = models.ForeignKey(Category, on_delete=models.CASCADE)

You want to access all products of a category using category.items.all(). How should you modify the ForeignKey?

hard

A. Add related_name='items' to the ForeignKey in Product.

B. Change ForeignKey to ManyToManyField with related_name='items'.

C. Rename the ForeignKey field to 'items'.

D. Add related_query_name='items' to the ForeignKey.

Solution

1. Step 1: Understand reverse access naming

   To use category.items.all(), the ForeignKey must have related_name='items'.

2. Step 2: Check other options

   Changing to ManyToManyField or renaming the field won't create the desired reverse attribute. related_query_name affects query filters, not attribute names.

3. Final Answer:

   Add related_name='items' to the ForeignKey in Product. -> Option A

4. Quick Check:

   related_name sets reverse attribute name [OK]

Hint: Set related_name='items' to get category.items [OK]

Common Mistakes:

• Confusing related_name with related_query_name
• Changing field name instead of related_name
• Switching to ManyToManyField unnecessarily