PostgreSQL 固有の集計関数¶
これらの機能は、 django.contrib.postgres.aggregates
モジュールから利用可能です。これらについての詳細は、 PostgreSQLドキュメント に記載されています。
注釈
すべての関数はデフォルトのエイリアスを持たないので、明示的にエイリアスを指定する必要があります。例えば:
>>> SomeModel.objects.aggregate(arr=ArrayAgg("somefield"))
{'arr': [0, 1, 2]}
汎用的な集計関数¶
ArrayAgg
¶
- class ArrayAgg(expression, distinct=False, filter=None, default=None, ordering=(), **extra)¶
null を含む値のリストを配列に連結して返すか、値がない場合は
default
を返す。- distinct¶
オプションの真偽値引数で、配列の値を区別するかどうかを指定する。デフォルトは
False
です。
- ordering¶
結果リスト内の要素の並び順を指定する、省略可能なフィールド名の文字列 (降順を示すオプションの
""-""
接頭辞を含む) または式 (もしくは文字列および/または式のタプルもしくはリスト)。例:
"some_field" "-some_field" from django.db.models import F F("some_field").desc()
Changed in Django 5.0:以前のバージョンでは、行がなく、
default
が指定されていない場合、ArrayAgg
はNone
ではなく空のリストを返していました。必要な場合は、明示的にdefault
をValue([])
に設定してください。
BitAnd
¶
- class BitAnd(expression, filter=None, default=None, **extra)¶
すべての非 null 入力値のビットごとの
AND
を返し、すべての値が null の場合はdefault
を返します。
BitOr
¶
- class BitOr(expression, filter=None, default=None, **extra)¶
すべての非 null 入力値のビットごとの
OR
のint
を返します。すべての値が null の場合はdefault
を返します。
BitXor
¶
- class BitXor(expression, filter=None, default=None, **extra)¶
すべての非 null 入力値のビットごとの
XOR
のint
を返します。すべての値が null の場合はdefault
が返されます。PostgreSQL 14+ が必要です。
BoolAnd
¶
- class BoolAnd(expression, filter=None, default=None, **extra)¶
すべての入力値が true の場合は
True
を、すべての値が null または値が存在しない場合はdefault
を、それ以外の場合はFalse
を返します。使用例:
class Comment(models.Model): body = models.TextField() published = models.BooleanField() rank = models.IntegerField()
>>> from django.db.models import Q >>> from django.contrib.postgres.aggregates import BoolAnd >>> Comment.objects.aggregate(booland=BoolAnd("published")) {'booland': False} >>> Comment.objects.aggregate(booland=BoolAnd(Q(rank__lt=100))) {'booland': True}
BoolOr
¶
- class BoolOr(expression, filter=None, default=None, **extra)¶
少なくとも1つの入力値が true の場合は
True
を、すべての値が null または値がない場合はdefault
を、そうでない場合はFalse
を返します。使用例:
class Comment(models.Model): body = models.TextField() published = models.BooleanField() rank = models.IntegerField()
>>> from django.db.models import Q >>> from django.contrib.postgres.aggregates import BoolOr >>> Comment.objects.aggregate(boolor=BoolOr("published")) {'boolor': True} >>> Comment.objects.aggregate(boolor=BoolOr(Q(rank__gt=2))) {'boolor': False}
JSONBAgg
¶
- class JSONBAgg(expressions, distinct=False, filter=None, default=None, ordering=(), **extra)¶
入力値を
JSON
配列として返します。値がない場合はdefault
を返します。結果はキーとインデックスのルックアップ
を使ってクエリできます。- distinct¶
オプションの真偽値引数で、配列の値を区別するかどうかを指定する。デフォルトは
False
です。
- ordering¶
結果リスト内の要素の並び順を指定する、省略可能なフィールド名の文字列 (降順を示すオプションの
""-""
接頭辞を含む) または式 (もしくは文字列および/または式のタプルもしくはリスト)。例は、
ArrayAgg.ordering
と同じです。
使用例:
class Room(models.Model): number = models.IntegerField(unique=True) class HotelReservation(models.Model): room = models.ForeignKey("Room", on_delete=models.CASCADE) start = models.DateTimeField() end = models.DateTimeField() requirements = models.JSONField(blank=True, null=True)
>>> from django.contrib.postgres.aggregates import JSONBAgg >>> Room.objects.annotate( ... requirements=JSONBAgg( ... "hotelreservation__requirements", ... ordering="-hotelreservation__start", ... ) ... ).filter(requirements__0__sea_view=True).values("number", "requirements") <QuerySet [{'number': 102, 'requirements': [ {'parking': False, 'sea_view': True, 'double_bed': False}, {'parking': True, 'double_bed': True} ]}]>
Changed in Django 5.0:以前のバージョンでは、行がなく、かつ
default
が提供されていないとき、JSONBAgg
はNone
の代わりに空のリストが返されていました。必要な場合は、明示的にdefault
をValue([])
に設定してください。
StringAgg
¶
- class StringAgg(expression, delimiter, distinct=False, filter=None, default=None, ordering=())¶
入力値を文字列に連結し、
delimiter
文字列で区切って返します。値がない場合はdefault
を返します。- delimiter¶
必須引数。文字列である必要があります。
- distinct¶
連結された値が重複するかどうかを決定するオプションの真偽値引数。デフォルトは
False
です。
- ordering¶
フィールド名 (降順を示すオプションの接頭辞
"-"
を持つ) 、または結果文字列の要素の順序を指定する式 (または文字列や式のタプルやリスト) のオプションの文字列。例は、
ArrayAgg.ordering
と同じです。
使用例:
class Publication(models.Model): title = models.CharField(max_length=30) class Article(models.Model): headline = models.CharField(max_length=100) publications = models.ManyToManyField(Publication)
>>> article = Article.objects.create(headline="NASA uses Python") >>> article.publications.create(title="The Python Journal") <Publication: Publication object (1)> >>> article.publications.create(title="Science News") <Publication: Publication object (2)> >>> from django.contrib.postgres.aggregates import StringAgg >>> Article.objects.annotate( ... publication_names=StringAgg( ... "publications__title", ... delimiter=", ", ... ordering="publications__title", ... ) ... ).values("headline", "publication_names") <QuerySet [{ 'headline': 'NASA uses Python', 'publication_names': 'Science News, The Python Journal' }]>
Changed in Django 5.0:以前のバージョンでは、行が存在せず
default
が指定されていない場合、StringAgg
はNone
の代わりに空の文字列を返していました。必要な場合は、明示的にdefault
をValue("")
に設定してください。
統計のための集計関数¶
y
および x
¶
これらの関数の引数 y
と x
には、フィールド名または数値データを返す式を指定できます。どちらも必須です。
Corr
¶
- class Corr(y, x, filter=None, default=None)¶
相関係数を
float
で返すか、マッチする行がない場合はdefault
で返す。
CovarPop
¶
RegrAvgX
¶
- class RegrAvgX(y, x, filter=None, default=None)¶
独立変数の平均値 (
sum(x)/N
) をfloat
で返すか、マッチする行がない場合はdefault
で返す。
RegrAvgY
¶
- class RegrAvgY(y, x, filter=None, default=None)¶
従属変数の平均値 (
sum(y)/N
) をfloat
で返すか、マッチする行がない場合はdefault
で返す。
RegrCount
¶
- class RegrCount(y, x, filter=None)¶
両方の式が NULL ではない入力行の数を
int
で返す。注釈
default
引数はサポートされていません。
RegrIntercept
¶
- class RegrIntercept(y, x, filter=None, default=None)¶
(x, y)
のペアによって決定される最小二乗法にフィットした一次方程式の y 切片をfloat
で返します。マッチする行がない場合はdefault
を返します。
RegrR2
¶
- class RegrR2(y, x, filter=None, default=None)¶
相関係数の二乗を
float
で返すか、マッチする行がない場合はdefault
で返します。
RegrSlope
¶
- class RegrSlope(y, x, filter=None, default=None)¶
(x, y)
のペアによって決定される最小二乗法の一次方程式の傾きをfloat
で返すか、マッチする行がない場合はdefault
で返す。
RegrSXX
¶
- class RegrSXX(y, x, filter=None, default=None)¶
sum(x^2) - sum(x)^2/N
("独立変数の二乗和") をfloat
で返すか、マッチする行がない場合はdefault
で返す。
RegrSXY
¶
- class RegrSXY(y, x, filter=None, default=None)¶
sum(x*y)-sum(x)*sum(y)/N
(独立変数と従属変数の "積和") をfloat
で返すか、マッチする行がない場合はdefault
で返す。
RegrSYY
¶
- class RegrSYY(y, x, filter=None, default=None)¶
sum(y^2) - sum(y)^2/N
(従属変数の二乗和) をfloat
で返すか、マッチする行がない場合はdefault
で返す。
使用例¶
この例では以下のテーブルを使用します:
| FIELD1 | FIELD2 | FIELD3 |
|--------|--------|--------|
| foo | 1 | 13 |
| bar | 2 | (null) |
| test | 3 | 13 |
汎用的な集計関数の例をいくつか紹介します:
>>> TestModel.objects.aggregate(result=StringAgg("field1", delimiter=";"))
{'result': 'foo;bar;test'}
>>> TestModel.objects.aggregate(result=ArrayAgg("field2"))
{'result': [1, 2, 3]}
>>> TestModel.objects.aggregate(result=ArrayAgg("field1"))
{'result': ['foo', 'bar', 'test']}
次の例では、統計的集計関数の使い方を示します。基礎となる数学については説明しません (たとえば、 wikipedia で読むことができます):
>>> TestModel.objects.aggregate(count=RegrCount(y="field3", x="field2"))
{'count': 2}
>>> TestModel.objects.aggregate(
... avgx=RegrAvgX(y="field3", x="field2"), avgy=RegrAvgY(y="field3", x="field2")
... )
{'avgx': 2, 'avgy': 13}