# Documentation Django 5.2.8

# Relations plusieurs-à-un

Pour définir une relation plusieurs-à-un, utilisez `ForeignKey`.

Dans cet exemple, un `Reporter` peut être associé avec plusieurs objets `Article`, mais un `Article` ne peut avoir qu’un seul objet `Reporter` lié

    from django.db import models

    class Reporter(models.Model):
        first_name = models.CharField(max_length=30)
        last_name = models.CharField(max_length=30)
        email = models.EmailField()

        def __str__(self):
            return f"{self.first_name} {self.last_name}"

    class Article(models.Model):
        headline = models.CharField(max_length=100)
        pub_date = models.DateField()
        reporter = models.ForeignKey(Reporter, on_delete=models.CASCADE)

        def __str__(self):
            return self.headline

        class Meta:
            ordering = ["headline"]

Dans ce qui suit, vous trouverez des exemples d’opérations pouvant être effectuées en utilisant les possibilités de l’API Python.

Créez quelques objets Reporter :

    >>> r = Reporter(first_name="John", last_name="Smith", email="john@example.com")
    >>> r.save()

    >>> r2 = Reporter(first_name="Paul", last_name="Jones", email="paul@example.com")
    >>> r2.save()

Créez un objet Article :

    >>> from datetime import date
    >>> a = Article(id=None, headline="This is a test", pub_date=date(2005, 7, 27), reporter=r)
    >>> a.save()

    >>> a.reporter.id
    1

    >>> a.reporter
    <Reporter: John Smith>

Notez que vous devez enregistrer un objet avant de pouvoir l’attribuer à une relation de clé étrangère. Par exemple, la création d’un `Article` avec une instance `Reporter` non enregistrée produit une erreur `ValueError`:

    >>> r3 = Reporter(first_name="John", last_name="Smith", email="john@example.com")
    >>> Article.objects.create(
    ...     headline="This is a test", pub_date=date(2005, 7, 27), reporter=r3
    ... )
    Traceback (most recent call last):
    ...
    ValueError: save() prohibited to prevent data loss due to unsaved related object 'reporter'.

Les objets Article ont accès à leurs objets Reporter liés :

    >>> r = a.reporter

Créez un objet Article au travers de l’objet Reporter :

    >>> new_article = r.article_set.create(
    ...     headline="John's second story", pub_date=date(2005, 7, 29)
    ... )
    >>> new_article
    <Article: John's second story>
    >>> new_article.reporter
    <Reporter: John Smith>
    >>> new_article.reporter.id
    1

Créez un nouvel article :

    >>> new_article2 = Article.objects.create(
    ...     headline="Paul's story", pub_date=date(2006, 1, 17), reporter=r
    ... )
    >>> new_article2.reporter
    <Reporter: John Smith>
    >>> new_article2.reporter.id
    1
    >>> r.article_set.all()
    <QuerySet [<Article: John's second story>, <Article: Paul's story>, <Article: This is a test>]>

Ajoutez le même article à un autre jeu d’articles et vérifiez qu’il a bien été déplacé :

    >>> r2.article_set.add(new_article2)
    >>> new_article2.reporter.id
    2
    >>> new_article2.reporter
    <Reporter: Paul Jones>

L’ajout d’un objet du mauvais type lève une exception `TypeError`:

    >>> r.article_set.add(r2)
    Traceback (most recent call last):
    ...
    TypeError: 'Article' instance expected, got <Reporter: Paul Jones>

    >>> r.article_set.all()
    <QuerySet [<Article: John's second story>, <Article: This is a test>]>
    >>> r2.article_set.all()
    <QuerySet [<Article: Paul's story>]>

    >>> r.article_set.count()
    2

    >>> r2.article_set.count()
    1

Notez que dans l’exemple précédent, l’article a été déplacé de John à Paul.

Les gestionnaires de relations acceptent aussi les recherches par champ. L’API suit automatiquement les relations à la profondeur nécessaire. Utilisez les doubles soulignements pour séparer les relations. Cela fonctionne à autant de niveaux que nécessaire, sans limite. Par exemple :

    >>> r.article_set.filter(headline__startswith="This")
    <QuerySet [<Article: This is a test>]>

    # Find all Articles for any Reporter whose first name is "John".
    >>> Article.objects.filter(reporter__first_name="John")
    <QuerySet [<Article: John's second story>, <Article: This is a test>]>

Une correspondance exacte est sous-entendue ici :

    >>> Article.objects.filter(reporter__first_name="John")
    <QuerySet [<Article: John's second story>, <Article: This is a test>]>

Double requête sur le champ lié. Cela se traduit par une condition AND dans la clause WHERE :

    >>> Article.objects.filter(reporter__first_name="John", reporter__last_name="Smith")
    <QuerySet [<Article: John's second story>, <Article: This is a test>]>

Pour la recherche sur la liaison, il est possible d’indiquer une clé primaire ou de transmettre explicitement l’objet lié :

    >>> Article.objects.filter(reporter__pk=1)
    <QuerySet [<Article: John's second story>, <Article: This is a test>]>
    >>> Article.objects.filter(reporter=1)
    <QuerySet [<Article: John's second story>, <Article: This is a test>]>
    >>> Article.objects.filter(reporter=r)
    <QuerySet [<Article: John's second story>, <Article: This is a test>]>

    >>> Article.objects.filter(reporter__in=[1, 2]).distinct()
    <QuerySet [<Article: John's second story>, <Article: Paul's story>, <Article: This is a test>]>
    >>> Article.objects.filter(reporter__in=[r, r2]).distinct()
    <QuerySet [<Article: John's second story>, <Article: Paul's story>, <Article: This is a test>]>

Vous pouvez aussi utiliser un résultat de requête (queryset) au lieu d’une liste explicite d’instances :

    >>> Article.objects.filter(
    ...     reporter__in=Reporter.objects.filter(first_name="John")
    ... ).distinct()
    <QuerySet [<Article: John's second story>, <Article: This is a test>]>

Requêtes dans la direction inverse :

    >>> Reporter.objects.filter(article__pk=1)
    <QuerySet [<Reporter: John Smith>]>
    >>> Reporter.objects.filter(article=1)
    <QuerySet [<Reporter: John Smith>]>
    >>> Reporter.objects.filter(article=a)
    <QuerySet [<Reporter: John Smith>]>

    >>> Reporter.objects.filter(article__headline__startswith="This")
    <QuerySet [<Reporter: John Smith>, <Reporter: John Smith>, <Reporter: John Smith>]>
    >>> Reporter.objects.filter(article__headline__startswith="This").distinct()
    <QuerySet [<Reporter: John Smith>]>

Le comptage dans la direction inverse fonctionne en combinant avec `distinct()`:

    >>> Reporter.objects.filter(article__headline__startswith="This").count()
    3
    >>> Reporter.objects.filter(article__headline__startswith="This").distinct().count()
    1

Les requêtes en boucle sont possibles :

    >>> Reporter.objects.filter(article__reporter__first_name__startswith="John")
    <QuerySet [<Reporter: John Smith>, <Reporter: John Smith>, <Reporter: John Smith>, <Reporter: John Smith>]>
    >>> Reporter.objects.filter(article__reporter__first_name__startswith="John").distinct()
    <QuerySet [<Reporter: John Smith>]>
    >>> Reporter.objects.filter(article__reporter=r).distinct()
    <QuerySet [<Reporter: John Smith>]>

Si vous supprimez un reporter, ses articles seront supprimés (en supposant que la clé étrangère a été créée avec l’attribut `django.db.models.ForeignKey.on_delete` défini à `CASCADE`, ce qui est la valeur par défaut) :

    >>> Article.objects.all()
    <QuerySet [<Article: John's second story>, <Article: Paul's story>, <Article: This is a test>]>
    >>> Reporter.objects.order_by("first_name")
    <QuerySet [<Reporter: John Smith>, <Reporter: Paul Jones>]>
    >>> r2.delete()
    >>> Article.objects.all()
    <QuerySet [<Article: John's second story>, <Article: This is a test>]>
    >>> Reporter.objects.order_by("first_name")
    <QuerySet [<Reporter: John Smith>]>

Vous pouvez effectuer une suppression en utilisant une jointure (JOIN) dans la requête :

    >>> Reporter.objects.filter(article__headline__startswith="This").delete()
    >>> Reporter.objects.all()
    <QuerySet []>
    >>> Article.objects.all()
    <QuerySet []>