PostgreSQL 特定的聚合函数

这些函数可从 django.contrib.postgres.aggregates 模块获得。在 PostgreSQL 文档 中对它们进行了更详细的描述。

注意

所有函数都没有默认别名，因此您必须显式提供一个。例如

>>> SomeModel.objects.aggregate(arr=ArrayAgg("somefield"))
{'arr': [0, 1, 2]}

常见的聚合选项

所有聚合都有 filter 关键字参数，大多数也有 default 关键字参数。

通用聚合函数

ArrayAgg

class ArrayAgg(expression, distinct=False, filter=None, default=None, ordering=(), **extra)

返回一个值的列表，包括空值，连接到一个数组中，或者如果没有任何值，则返回 default。

distinct

一个可选的布尔参数，决定数组值是否唯一。默认为 False。

ordering

一个可选的字段名字符串（带有一个可选的 "-" 前缀，表示降序）或表达式（或字符串和/或表达式的元组或列表），用于指定结果列表中元素的排序。

示例

"some_field"
"-some_field"
from django.db.models import F

F("some_field").desc()
Django 5.0 中的更改

在旧版本中，如果没有行并且没有提供 default，ArrayAgg 返回一个空列表而不是 None。如果您需要它，请显式将 default 设置为 Value([])。

BitAnd

class BitAnd(expression, filter=None, default=None, **extra)

返回所有非空输入值的按位 AND 的 int，或者如果所有值都为空，则返回 default。

BitOr

class BitOr(expression, filter=None, default=None, **extra)

返回所有非空输入值的按位 OR 的 int，或者如果所有值都为空，则返回 default。

BitXor

class BitXor(expression, filter=None, default=None, **extra)

返回所有非空输入值的按位 XOR 的 int，或者如果所有值都为空，则返回 default。它需要 PostgreSQL 14+。

BoolAnd

class BoolAnd(expression, filter=None, default=None, **extra)

如果所有输入值都为真，则返回 True，如果所有值都为空或没有值，则返回 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)

如果至少一个输入值为真，则返回 True，如果所有值都为空或没有值，则返回 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。您可以使用 key 和 index 查找 查询结果。

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}
]}]>
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'
}]>
Django 5.0 中的更改

在旧版本中，如果没有行且未提供 default，则 StringAgg 返回空字符串而不是 None。如果您需要它，请显式地将 default 设置为 Value("")。

统计的聚合函数

y 和 x

所有这些函数的参数 y 和 x 可以是字段名称或返回数值数据的表达式。两者都是必需的。

Corr

class Corr(y, x, filter=None, default=None)

返回作为 float 的相关系数，如果没有匹配的行则返回 default。

CovarPop

class CovarPop(y, x, sample=False, filter=None, default=None)

返回作为 float 的总体协方差，如果没有匹配的行则返回 default。

sample

可选。默认情况下，CovarPop 返回总体协方差。但是，如果 sample=True，则返回值将是样本总体协方差。

RegrAvgX

class RegrAvgX(y, x, filter=None, default=None)

返回作为 float 的自变量的平均值（sum(x)/N），如果没有匹配的行则返回 default。

RegrAvgY

class RegrAvgY(y, x, filter=None, default=None)

返回作为 float 的因变量的平均值（sum(y)/N），如果没有匹配的行则返回 default。

RegrCount

class RegrCount(y, x, filter=None)

返回一个 int，表示两个表达式都不为 null 的输入行的数量。

注意

不支持 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']}

下一个示例展示了统计聚合函数的使用。 这里不会描述底层的数学原理（例如，您可以在维基百科上阅读相关内容）

>>> 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}
django.contrib.postgres
PostgreSQL 特定的数据库约束
返回顶部