Relacje wiele-do-wielu

Aby utworzyć relację wiele-do-wielu użyj klasy ManyToManyField.

Za przykład weźmy „Article”, który może znaleźć się w wielu publikacjach „Publication”. Natomiast jedna publikacja(„Publication”), może zawierać wiele artykułów(„Article”).

from django.db import models

class Publication(models.Model):
    title = models.CharField(max_length=30)

    class Meta:
        ordering = ['title']

    def __str__(self):
        return self.title

class Article(models.Model):
    headline = models.CharField(max_length=100)
    publications = models.ManyToManyField(Publication)

    class Meta:
        ordering = ['headline']

    def __str__(self):
        return self.headline

Poniżej zaprezentowano przykłady operacji, jakie mogą zostać wykonane przy użyciu funkcji dostępnych w Python API:

Utwórz kilka nowych instancji klasy „Publication”:

>>> p1 = Publication(title='The Python Journal')
>>> p1.save()
>>> p2 = Publication(title='Science News')
>>> p2.save()
>>> p3 = Publication(title='Science Weekly')
>>> p3.save()

Utwórz obiekt klasy „Article”:

>>> a1 = Article(headline='Django lets you build web apps easily')

Dopóki artykuł „a1” nie zostanie zapisany, nie można przypisać do do żadnej publikacji:

>>> a1.publications.add(p1)
Traceback (most recent call last):
...
ValueError: "<Article: Django lets you build web apps easily>" needs to have a value for field "id" before this many-to-many relationship can be used.

Zapis obiektu „a1” odbywa się w poniższy sposób:

>>> a1.save()

Teraz możesz przypisać artykuł „a1” do publikacji „p1”:

>>> a1.publications.add(p1)

Utwórz kolejny obiekt klasy „Article”. Przypisz go do kilku publikacji:

>>> a2 = Article(headline='NASA uses Python')
>>> a2.save()
>>> a2.publications.add(p1, p2)
>>> a2.publications.add(p3)

Dodanie artykułu „a2” do publikacji „p3” po raz drugi, nie doprowadzi do podwojenia relacji:

>>> a2.publications.add(p3)

Próba przypisania artykułu do obiektu innego typu niż „Publication” spowoduje zwrócenie wyjątku typu :exec:»TypeError»:

>>> a2.publications.add(a1)
Traceback (most recent call last):
...
TypeError: 'Publication' instance expected

Z poziomu objektu klasy „Article” możesz w jednym poleceniu utworzyć nowy obiekt klasy „Publication”. Obiekt „a2” zostanie od razu przypisany do nowo powstałego obiektu klasy „Publication”:

>>> new_publication = a2.publications.create(title='Highlights for Children')

Z poziomu obiektu klasy „Article” istnieje dostęp do publikacji, do których artykuł został przypisany:

>>> a1.publications.all()
<QuerySet [<Publication: The Python Journal>]>
>>> a2.publications.all()
<QuerySet [<Publication: Highlights for Children>, <Publication: Science News>, <Publication: Science Weekly>, <Publication: The Python Journal>]>

Obiekt klasy „Publication” ma natomiast dostęp do obiektów typu „Article”, które zostały do niego przypisane.

>>> p2.article_set.all()
<QuerySet [<Article: NASA uses Python>]>
>>> p1.article_set.all()
<QuerySet [<Article: Django lets you build web apps easily>, <Article: NASA uses Python>]>
>>> Publication.objects.get(id=4).article_set.all()
<QuerySet [<Article: NASA uses Python>]>

Relacja wiele-do-wielu może być filtrowana przy pomocy funkcjonalności wyszukiwania w relacjach:

>>> Article.objects.filter(publications__id=1)
<QuerySet [<Article: Django lets you build web apps easily>, <Article: NASA uses Python>]>
>>> Article.objects.filter(publications__pk=1)
<QuerySet [<Article: Django lets you build web apps easily>, <Article: NASA uses Python>]>
>>> Article.objects.filter(publications=1)
<QuerySet [<Article: Django lets you build web apps easily>, <Article: NASA uses Python>]>
>>> Article.objects.filter(publications=p1)
<QuerySet [<Article: Django lets you build web apps easily>, <Article: NASA uses Python>]>

>>> Article.objects.filter(publications__title__startswith="Science")
<QuerySet [<Article: NASA uses Python>, <Article: NASA uses Python>]>

>>> Article.objects.filter(publications__title__startswith="Science").distinct()
<QuerySet [<Article: NASA uses Python>]>

Funkcja count() może być uruchomiona bezpośrednio na filtrowanej kolekcji. Można ją również wywołać po wcześniejszym uruchomieniu distinct(). Otrzymany wynik, zwróci nam ilość obiektów bez powtórzeń.

>>> Article.objects.filter(publications__title__startswith="Science").count()
2

>>> Article.objects.filter(publications__title__startswith="Science").distinct().count()
1

>>> Article.objects.filter(publications__in=[1,2]).distinct()
<QuerySet [<Article: Django lets you build web apps easily>, <Article: NASA uses Python>]>
>>> Article.objects.filter(publications__in=[p1,p2]).distinct()
<QuerySet [<Article: Django lets you build web apps easily>, <Article: NASA uses Python>]>

Wyszukiwanie w relacjach możemy uruchomić z poziomu obydwu klas składających się na relację wiele-do-wielu. Poniżej znajduje się przykład zastosowania tego mechanizmu dla filtrowania kolekcji obiektów klasy „Publication”, która nie zawiera pola ManyToManyField:

>>> Publication.objects.filter(id=1)
<QuerySet [<Publication: The Python Journal>]>
>>> Publication.objects.filter(pk=1)
<QuerySet [<Publication: The Python Journal>]>

>>> Publication.objects.filter(article__headline__startswith="NASA")
<QuerySet [<Publication: Highlights for Children>, <Publication: Science News>, <Publication: Science Weekly>, <Publication: The Python Journal>]>

>>> Publication.objects.filter(article__id=1)
<QuerySet [<Publication: The Python Journal>]>
>>> Publication.objects.filter(article__pk=1)
<QuerySet [<Publication: The Python Journal>]>
>>> Publication.objects.filter(article=1)
<QuerySet [<Publication: The Python Journal>]>
>>> Publication.objects.filter(article=a1)
<QuerySet [<Publication: The Python Journal>]>

>>> Publication.objects.filter(article__in=[1,2]).distinct()
<QuerySet [<Publication: Highlights for Children>, <Publication: Science News>, <Publication: Science Weekly>, <Publication: The Python Journal>]>
>>> Publication.objects.filter(article__in=[a1,a2]).distinct()
<QuerySet [<Publication: Highlights for Children>, <Publication: Science News>, <Publication: Science Weekly>, <Publication: The Python Journal>]>

Usunięcie powiązania pomiędzy obiektem klasy „Article” a obiektem klasy „Publication” możemy wykonać w sposób pokazany poniżej:

>>> Article.objects.exclude(publications=p2)
<QuerySet [<Article: Django lets you build web apps easily>]>

Jeżeli instancja klasy „Publication” zostanie usunięta, nie będziemy mieli już do niej dostępu z poziomu powiązanych instancji klasy „Article”.

>>> p1.delete()
>>> Publication.objects.all()
<QuerySet [<Publication: Highlights for Children>, <Publication: Science News>, <Publication: Science Weekly>]>
>>> a1 = Article.objects.get(pk=1)
>>> a1.publications.all()
<QuerySet []>

Podobnie, jeżeli usuniemy obiekt klasy „Article”, dostęp do niego nie będzie możliwy z poziomu instancji klasy „Publication” do których był wcześniej przypisany.

>>> a2.delete()
>>> Article.objects.all()
<QuerySet [<Article: Django lets you build web apps easily>]>
>>> p2.article_set.all()
<QuerySet []>

Przykład tworzenia relacji wiele-do-wielu z poziomu instancji obiektu nie definiującego tej relacji:

>>> a4 = Article(headline='NASA finds intelligent life on Earth')
>>> a4.save()
>>> p2.article_set.add(a4)
>>> p2.article_set.all()
<QuerySet [<Article: NASA finds intelligent life on Earth>]>
>>> a4.publications.all()
<QuerySet [<Publication: Science News>]>

Przykład tworzenia relacji wiele-do-wielu z poziomu instancji obiektu nie definiującego tej relacji. W tym przypadku w jednej linijce tworzymy instancję obiektu „Article” i wiążemy ją z publikacją „p2”:

>>> new_article = p2.article_set.create(headline='Oxygen-free diet works wonders')
>>> p2.article_set.all()
<QuerySet [<Article: NASA finds intelligent life on Earth>, <Article: Oxygen-free diet works wonders>]>
>>> a5 = p2.article_set.all()[1]
>>> a5.publications.all()
<QuerySet [<Publication: Science News>]>

Usuwanie obiektu „Publication” z poziomu obiektu „Article”:

>>> a4.publications.remove(p2)
>>> p2.article_set.all()
<QuerySet [<Article: Oxygen-free diet works wonders>]>
>>> a4.publications.all()
<QuerySet []>

Oraz odwrotnie. Usuwanie obiektu „Article” z poziomu „Publication”:

>>> p2.article_set.remove(a5)
>>> p2.article_set.all()
<QuerySet []>
>>> a5.publications.all()
<QuerySet []>

Zbiór powiązanych obiektów, może być ustawiony przy pomocy listy:

>>> a4.publications.all()
<QuerySet [<Publication: Science News>]>
>>> a4.publications.set([p3])
>>> a4.publications.all()
<QuerySet [<Publication: Science Weekly>]>

Zbiór powiązanych obiektów może zostać wyczyszczony:

>>> p2.article_set.clear()
>>> p2.article_set.all()
<QuerySet []>

Zbiór powiązanych obiektów może zostać wyzerowany z poziomu obiektu, który jest drugą stroną relacji wiele-do-wielu(relacja nie w nim została zdefiniowana):

>>> p2.article_set.add(a4, a5)
>>> p2.article_set.all()
<QuerySet [<Article: NASA finds intelligent life on Earth>, <Article: Oxygen-free diet works wonders>]>
>>> a4.publications.all()
<QuerySet [<Publication: Science News>, <Publication: Science Weekly>]>
>>> a4.publications.clear()
>>> a4.publications.all()
<QuerySet []>
>>> p2.article_set.all()
<QuerySet [<Article: Oxygen-free diet works wonders>]>

Utwórzmy na nowo „Article” oraz „Publication”, które uprzednio zostały usunięte.

>>> p1 = Publication(title='The Python Journal')
>>> p1.save()
>>> a2 = Article(headline='NASA uses Python')
>>> a2.save()
>>> a2.publications.add(p1, p2, p3)

Możemy usunąć masowo powiązane „Publication”, których tytuł rozpoczyna się od słowa „Science”:

>>> Publication.objects.filter(title__startswith='Science').delete()
>>> Publication.objects.all()
<QuerySet [<Publication: Highlights for Children>, <Publication: The Python Journal>]>
>>> Article.objects.all()
<QuerySet [<Article: Django lets you build web apps easily>, <Article: NASA finds intelligent life on Earth>, <Article: NASA uses Python>, <Article: Oxygen-free diet works wonders>]>
>>> a2.publications.all()
<QuerySet [<Publication: The Python Journal>]>

Masowe usuwanie obiektów klasy „Article” przy pomocy zapytania. Przed właściwym usunięciem, możemy wywołać funkcję „print”, która wypisze obiekty, które zostaną usunięte po wywołaniu operacji delete():

>>> q = Article.objects.filter(headline__startswith='Django')
>>> print(q)
<QuerySet [<Article: Django lets you build web apps easily>]>
>>> q.delete()

Po wywołaniu operacji delete(), QuerySet nie powinien już zawierać usuniętych obiektów:

>>> print(q)
<QuerySet []>
>>> p1.article_set.all()
<QuerySet [<Article: NASA uses Python>]>