Django What is reverse relationship?

Here is the documentation on related_name

Lets say you have 2 models

class Group(models.Model):
    #some attributes

class Profile(models.Model):
    group = models.ForeignKey(Group)
    #more attributes

Now, from a profile object, you can do profile.group. But if you want the profile objects given the group object, How would you do that? Thats' where related name or the reverse relationship comes in.

Django, by defaults gives you a default related_name which is the ModelName (in lowercase) followed by _set - In this case, It would be profile_set, so group.profile_set.

However, you can override it by specifying a related_name in the ForeignKey field.

class Profile(models.Model):
    group = models.ForeignKey(Group, related_name='profiles')
    #more attributes

Now, you can access the foreign key as follows:

group.profiles.all()

For a clearer picture you can assume that when we use reverse relationship, it adds an extra field in the referenced model:

For example:

class Employee(models.Model):
           name = models.CharField()
           email = models.EmailField()
class Salary(models.Model):
           amount = models.IntegerField()
           employee = models.ForeignKey(Employee, on_delete=models.CASCADE, related_name='salary')

After using related_name in Salary model, now you can assume the Employee model will have one more field: salary.

For example, the available fields would now be:

name, email, and salary

To find an employee, we can simply query in this way:

e = Employee.objects.filter(some filter).first()

To check their salary, we can check it by writing e.salary (now we can use salary an attribute or field in employee model). This will give you the salary instance of that employee, and you can find the amount by writing e.salary.amount. This will give you the salary of that employee.

In case of many to many relationship we can use .all() and then iterate over that.

Django What is reverse relationship?

Related

Recent Posts