Ces fonctions sont disponibles dans le module django.contrib.postgres.aggregates. Elles sont décrites plus en détails dans la documentation PostgreSQL.
ArrayAggLien vers cette rubrique#Renvoie une liste de valeurs, y compris nulles, concaténées dans un tableau, ou default s’il n’y a aucune valeur.
Un paramètre booléen facultatif qui détermine si les valeurs de tableau seront distinctes. False par défaut.
Une chaîne facultative d’un nom de champ (précédé d’un préfixe "-" facultatif pour indiquer un ordre décroissant) ou une expression (ou un tuple/liste de chaînes ou d’expressions) qui indique le tri des éléments de la liste résultante.
Exemples :
\nfrom django.db.models import F\n\nArrayAgg("a_field", ordering="-some_field")\nArrayAgg("a_field", ordering=F("some_field").desc())\nBitAndLien vers cette rubrique#Renvoie un entier int résultat de l’opération AND bit-à-bit de toutes les valeurs non nulles, ou default si toutes les valeurs sont nulles.
BitOrLien vers cette rubrique#Renvoie un entier int résultat de l’opération OR bit-à-bit de toutes les valeurs non nulles, ou default si toutes les valeurs sont nulles.
BitXorLien vers cette rubrique#Renvoie un entier int résultat de l’opération XOR bit-à-bit de toutes les valeurs non nulles, ou default si toutes les valeurs sont nulles. Nécessite PostgreSQL 14+.
BoolAndLien vers cette rubrique#Renvoie True si toutes les valeurs d’entrée sont vraies, default si toutes les valeurs sont nulles ou s’il n’y a pas de valeur, sinon renvoie False.
Exemple d’utilisation :
\nclass Comment(models.Model):\n body = models.TextField()\n published = models.BooleanField()\n rank = models.IntegerField()\n>>> from django.db.models import Q\n>>> from django.contrib.postgres.aggregates import BoolAnd\n>>> Comment.objects.aggregate(booland=BoolAnd("published"))\n{'booland': False}\n>>> Comment.objects.aggregate(booland=BoolAnd(Q(rank__lt=100)))\n{'booland': True}\nBoolOrLien vers cette rubrique#Renvoie True si au moins une valeur d’entrée est vraie, default si toutes les valeurs sont nulles ou s’il n’y a pas de valeur, sinon renvoie False.
Exemple d’utilisation :
\nclass Comment(models.Model):\n body = models.TextField()\n published = models.BooleanField()\n rank = models.IntegerField()\n>>> from django.db.models import Q\n>>> from django.contrib.postgres.aggregates import BoolOr\n>>> Comment.objects.aggregate(boolor=BoolOr("published"))\n{'boolor': True}\n>>> Comment.objects.aggregate(boolor=BoolOr(Q(rank__gt=2)))\n{'boolor': False}\nJSONBAggLien vers cette rubrique#Renvoie les valeurs d’entrée sous forme de tableau JSON, ou default s’il n’y a aucune valeur. Vous pouvez interroger le résultat en utilisant les expressions de clé et d'indice.
Un paramètre booléen facultatif qui détermine si les valeurs de tableau seront distinctes. False par défaut.
Une chaîne facultative d’un nom de champ (précédé d’un préfixe "-" facultatif pour indiquer un ordre décroissant) ou une expression (ou un tuple/liste de chaînes ou d’expressions) qui indique le tri des éléments de la liste résultante.
Les exemples sont les mêmes que pour ArrayAgg.ordering.
Exemple d’utilisation :
\nclass Room(models.Model):\n number = models.IntegerField(unique=True)\n\n\nclass HotelReservation(models.Model):\n room = models.ForeignKey("Room", on_delete=models.CASCADE)\n start = models.DateTimeField()\n end = models.DateTimeField()\n requirements = models.JSONField(blank=True, null=True)\n>>> from django.contrib.postgres.aggregates import JSONBAgg\n>>> Room.objects.annotate(\n... requirements=JSONBAgg(\n... "hotelreservation__requirements",\n... ordering="-hotelreservation__start",\n... )\n... ).filter(requirements__0__sea_view=True).values("number", "requirements")\n<QuerySet [{'number': 102, 'requirements': [\n {'parking': False, 'sea_view': True, 'double_bed': False},\n {'parking': True, 'double_bed': True}\n]}]>\nStringAggLien vers cette rubrique#Renvoie les valeurs d’entrée concaténées dans une chaîne, séparées par la chaîne delimiter, ou default s’il n’y a aucune valeur.
Paramètre obligatoire. Doit être une chaîne.
\nUn paramètre booléen facultatif qui détermine si les valeurs concaténées seront distinctes. False par défaut.
Une chaîne facultative d’un nom de champ (précédé d’un préfixe "-" facultatif pour indiquer un ordre décroissant) ou une expression (ou un tuple/liste de chaînes ou d’expressions) qui indique le tri des éléments de la chaîne résultante.
Les exemples sont les mêmes que pour ArrayAgg.ordering.
Exemple d’utilisation :
\nclass Publication(models.Model):\n title = models.CharField(max_length=30)\n\n\nclass Article(models.Model):\n headline = models.CharField(max_length=100)\n publications = models.ManyToManyField(Publication)\n>>> article = Article.objects.create(headline="NASA uses Python")\n>>> article.publications.create(title="The Python Journal")\n<Publication: Publication object (1)>\n>>> article.publications.create(title="Science News")\n<Publication: Publication object (2)>\n>>> from django.contrib.postgres.aggregates import StringAgg\n>>> Article.objects.annotate(\n... publication_names=StringAgg(\n... "publications__title",\n... delimiter=", ",\n... ordering="publications__title",\n... )\n... ).values("headline", "publication_names")\n<QuerySet [{\n 'headline': 'NASA uses Python', 'publication_names': 'Science News, The Python Journal'\n}]>\ny et xLien vers cette rubrique#Les paramètres y et x de toutes ces fonctions peuvent être un nom de champ ou une expression renvoyant une donnée numérique. Les deux sont obligatoires.
CorrLien vers cette rubrique#Renvoie le coefficient de corrélation sous forme de nombre float, ou default si aucune ligne ne correspond.
CovarPopLien vers cette rubrique#Renvoie la covariance de population sous forme de nombre float, ou default si aucune ligne ne correspond.
Facultatif. Par défaut, CovarPop renvoie la covariance de population générale. Cependant, si sample=True, la valeur renvoyée sera la covariance d’échantillon de population.
RegrAvgXLien vers cette rubrique#Renvoie la moyenne de la variable indépendante (sum(x)/N) sous forme de nombre float, ou default si aucune ligne ne correspond.
RegrAvgYLien vers cette rubrique#Renvoie la moyenne de la variable dépendante (sum(y)/N) sous forme de nombre float, ou default si aucune ligne ne correspond.
RegrCountLien vers cette rubrique#Renvoie un entier int correspondant au nombre de lignes d’entrée dans lesquelles les deux expressions ne sont pas nulles.
RegrInterceptLien vers cette rubrique#Renvoie l’interception de l’axe y pour l’équation linéaire de la méthode des moindres carrés déterminée par les paires (x, y) sous forme de nombre float, ou default si aucune ligne ne correspond.
RegrR2Lien vers cette rubrique#Returns the square of the correlation coefficient as a float, or\ndefault if there aren’t any matching rows.
RegrSlopeLien vers cette rubrique#Renvoie l’inclinaison pour l’équation linéaire de la méthode des moindres carrés déterminée par les paires (x, y) sous forme de nombre float, ou default si aucune ligne ne correspond.
RegrSXXLien vers cette rubrique#Renvoie sum(x^2) - sum(x)^2/N (« somme des carrés » de la variable indépendante) sous forme de nombre float, ou default si aucune ligne ne correspond.
RegrSXYLien vers cette rubrique#Renvoie sum(x*y) - sum(x) * sum(y)/N (« somme des produits » de la variable indépendante multipliée par la variable dépendante) sous forme de nombre float, ou default si aucune ligne ne correspond.
RegrSYYLien vers cette rubrique#Renvoie sum(y^2) - sum(y)^2/N (« somme des carrés » de la variable dépendante) sous forme de nombre float, ou default si aucune ligne ne correspond.
Nous allons utiliser cette table d’exemple :
\n| FIELD1 | FIELD2 | FIELD3 |\n|--------|--------|--------|\n| foo | 1 | 13 |\n| bar | 2 | (null) |\n| test | 3 | 13 |\nVoici quelques exemples de certaines des fonctions d’agrégation d’ordre général :
\n>>> TestModel.objects.aggregate(result=StringAgg("field1", delimiter=";"))\n{'result': 'foo;bar;test'}\n>>> TestModel.objects.aggregate(result=ArrayAgg("field2"))\n{'result': [1, 2, 3]}\n>>> TestModel.objects.aggregate(result=ArrayAgg("field1"))\n{'result': ['foo', 'bar', 'test']}\nL’exemple suivant montre l’utilisation des fonctions d’agrégats pour les statistiques. Les mathématiques sous-jacentes ne sont pas expliquées (vous pouvez vous renseigner à ce sujet sur Wikipédia par exemple) :
\n>>> TestModel.objects.aggregate(count=RegrCount(y="field3", x="field2"))\n{'count': 2}\n>>> TestModel.objects.aggregate(\n... avgx=RegrAvgX(y="field3", x="field2"), avgy=RegrAvgY(y="field3", x="field2")\n... )\n{'avgx': 2, 'avgy': 13}\n