How to implement a many-to-many relationship in…

In Django, a many-to-many relationship is implemented by defining a ManyToManyField in one of the models involved in the relationship. Django automatically creates an intermediate table to store the relationships between instances of these models.

Example:

// models.py

from django.db import models

class Author(models.Model):
    name = models.CharField(max_length=100)
    books = models.ManyToManyField('Book', related_name='authors') // Defining a many-to-many field

    def __str__(self):
        return self.name

class Book(models.Model):
    title = models.CharField(max_length=200)
    publication_date = models.DateField()

    def __str__(self):
        return self.title

In this example:

Author and Book are two models with a relationship.
ManyToManyField('Book', related_name='authors') in the Author model creates a "many-to-many" relationship. related_name='authors' allows accessing the authors of a book from a Book instance via the authors attribute.
Django automatically creates an intermediate table (by default, named appname_author_books) containing foreign keys to records from the Author and Book tables.

Operations with related objects:

Adding:

// Example of adding a book to an author
author = Author.objects.create(name='Leo Tolstoy')
book1 = Book.objects.create(title='War and Peace', publication_date='1869-01-01')
book2 = Book.objects.create(title='Anna Karenina', publication_date='1877-01-01')

author.books.add(book1, book2) // Adding multiple books

Retrieving:

// Getting all books of an author
author = Author.objects.get(name='Leo Tolstoy')
books_by_tolstoy = author.books.all()

// Getting all authors of a book
book = Book.objects.get(title='War and Peace')
authors_of_war_and_peace = book.authors.all()

Removing:

// Removing a book from an author's list
author.books.remove(book1)

// Removing all books from an author
author.books.clear()

Checking existence:

// Checking if a book is related to an author
is_related = author.books.filter(title='War and Peace').exists()

If additional fields are needed for the relationship (e.g., date when the author joined the project), you can use the through argument in ManyToManyField and specify a custom model for the intermediate table.

Example of through:

// models.py

from django.db import models

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

class Group(models.Model):
    name = models.CharField(max_length=50)
    members = models.ManyToManyField(Person, through='Membership') // Using 'through'

class Membership(models.Model):
    person = models.ForeignKey(Person, on_delete=models.CASCADE)
    group = models.ForeignKey(Group, on_delete=models.CASCADE)
    date_joined = models.DateField() // Additional field

    class Meta:
        unique_together = [['person', 'group']] // Ensuring unique relationships

In this case, the Membership model explicitly defines the intermediate table with its own fields. When working with such a relationship, add(), remove(), and set() operations on the ManyToManyField may be unavailable or require passing instances of the intermediate model.

How to implement a many-to-many relationship in Django?