diff options
| author | ontowhee <82607723+ontowhee@users.noreply.github.com> | 2023-05-16 19:12:53 -0700 |
|---|---|---|
| committer | Mariusz Felisiak <felisiak.mariusz@gmail.com> | 2024-02-16 08:57:16 +0100 |
| commit | 66e47ac69a7e71cf32eee312d05668d8f1ba24bb (patch) | |
| tree | 4e70a219a399f9d8142bfca7d22621ac22960f3d /tests/many_to_many | |
| parent | 0d8fbe2ade29f1b7bd9e6ba7a0281f5478603a43 (diff) | |
Fixed #29725 -- Removed unnecessary join in QuerySet.count() and exists() on a many to many relation.
Co-Authored-By: Shiwei Chen <april.chen.0615@gmail.com>
Diffstat (limited to 'tests/many_to_many')
| -rw-r--r-- | tests/many_to_many/models.py | 12 | ||||
| -rw-r--r-- | tests/many_to_many/tests.py | 96 |
2 files changed, 102 insertions, 6 deletions
diff --git a/tests/many_to_many/models.py b/tests/many_to_many/models.py index 42fc426990..df7222e08d 100644 --- a/tests/many_to_many/models.py +++ b/tests/many_to_many/models.py @@ -78,3 +78,15 @@ class InheritedArticleA(AbstractArticle): class InheritedArticleB(AbstractArticle): pass + + +class NullableTargetArticle(models.Model): + headline = models.CharField(max_length=100) + publications = models.ManyToManyField( + Publication, through="NullablePublicationThrough" + ) + + +class NullablePublicationThrough(models.Model): + article = models.ForeignKey(NullableTargetArticle, models.CASCADE) + publication = models.ForeignKey(Publication, models.CASCADE, null=True) diff --git a/tests/many_to_many/tests.py b/tests/many_to_many/tests.py index 7ed3b80abc..351e4eb8cc 100644 --- a/tests/many_to_many/tests.py +++ b/tests/many_to_many/tests.py @@ -1,10 +1,18 @@ from unittest import mock -from django.db import transaction +from django.db import connection, transaction from django.test import TestCase, skipIfDBFeature, skipUnlessDBFeature from django.utils.deprecation import RemovedInDjango60Warning -from .models import Article, InheritedArticleA, InheritedArticleB, Publication, User +from .models import ( + Article, + InheritedArticleA, + InheritedArticleB, + NullablePublicationThrough, + NullableTargetArticle, + Publication, + User, +) class ManyToManyTests(TestCase): @@ -558,10 +566,16 @@ class ManyToManyTests(TestCase): def test_custom_default_manager_exists_count(self): a5 = Article.objects.create(headline="deleted") a5.publications.add(self.p2) - self.assertEqual(self.p2.article_set.count(), self.p2.article_set.all().count()) - self.assertEqual( - self.p3.article_set.exists(), self.p3.article_set.all().exists() - ) + with self.assertNumQueries(2) as ctx: + self.assertEqual( + self.p2.article_set.count(), self.p2.article_set.all().count() + ) + self.assertIn("JOIN", ctx.captured_queries[0]["sql"]) + with self.assertNumQueries(2) as ctx: + self.assertEqual( + self.p3.article_set.exists(), self.p3.article_set.all().exists() + ) + self.assertIn("JOIN", ctx.captured_queries[0]["sql"]) def test_get_prefetch_queryset_warning(self): articles = Article.objects.all() @@ -582,3 +596,73 @@ class ManyToManyTests(TestCase): instances=articles, querysets=[Publication.objects.all(), Publication.objects.all()], ) + + +class ManyToManyQueryTests(TestCase): + """ + SQL is optimized to reference the through table without joining against the + related table when using count() and exists() functions on a queryset for + many to many relations. The optimization applies to the case where there + are no filters. + """ + + @classmethod + def setUpTestData(cls): + cls.article = Article.objects.create( + headline="Django lets you build Web apps easily" + ) + cls.nullable_target_article = NullableTargetArticle.objects.create( + headline="The python is good" + ) + NullablePublicationThrough.objects.create( + article=cls.nullable_target_article, publication=None + ) + + @skipUnlessDBFeature("supports_foreign_keys") + def test_count_join_optimization(self): + with self.assertNumQueries(1) as ctx: + self.article.publications.count() + self.assertNotIn("JOIN", ctx.captured_queries[0]["sql"]) + + with self.assertNumQueries(1) as ctx: + self.article.publications.count() + self.assertNotIn("JOIN", ctx.captured_queries[0]["sql"]) + self.assertEqual(self.nullable_target_article.publications.count(), 0) + + def test_count_join_optimization_disabled(self): + with ( + mock.patch.object(connection.features, "supports_foreign_keys", False), + self.assertNumQueries(1) as ctx, + ): + self.article.publications.count() + + self.assertIn("JOIN", ctx.captured_queries[0]["sql"]) + + @skipUnlessDBFeature("supports_foreign_keys") + def test_exists_join_optimization(self): + with self.assertNumQueries(1) as ctx: + self.article.publications.exists() + self.assertNotIn("JOIN", ctx.captured_queries[0]["sql"]) + + self.article.publications.prefetch_related() + with self.assertNumQueries(1) as ctx: + self.article.publications.exists() + self.assertNotIn("JOIN", ctx.captured_queries[0]["sql"]) + self.assertIs(self.nullable_target_article.publications.exists(), False) + + def test_exists_join_optimization_disabled(self): + with ( + mock.patch.object(connection.features, "supports_foreign_keys", False), + self.assertNumQueries(1) as ctx, + ): + self.article.publications.exists() + + self.assertIn("JOIN", ctx.captured_queries[0]["sql"]) + + def test_prefetch_related_no_queries_optimization_disabled(self): + qs = Article.objects.prefetch_related("publications") + article = qs.get() + with self.assertNumQueries(0): + article.publications.count() + with self.assertNumQueries(0): + article.publications.exists() |
