PostgreSQL 特定的聚合函数 — Django 文档
PostgreSQL 特定的聚合函数
这些功能可从 django.contrib.postgres.aggregates 模块获得。 它们在 PostgreSQL 文档 中有更详细的描述。
笔记
所有函数都没有默认别名，因此您必须明确提供一个。 例如：
>>> SomeModel.objects.aggregate(arr=ArrayAgg('somefield'))
{'arr': [0, 1, 2]}通用聚合函数
ArrayAgg
- class ArrayAgg(expression, distinct=False, filter=None, ordering=(), **extra)
返回连接到数组中的值列表，包括空值。
- distinct
一个可选的布尔参数，用于确定数组值是否不同。 默认为
False。
- ordering
字段名称的可选字符串（带有指示降序的可选
"-"前缀）或指定结果列表中元素顺序的表达式（或字符串和/或表达式的元组或列表） .例子：
'some_field' '-some_field' from django.db.models import F F('some_field').desc()
BitAnd
- class BitAnd(expression, filter=None, **extra)
- 返回所有非空输入值的按位
AND的int，如果所有值都为空，则返回None。
BitOr
- class BitOr(expression, filter=None, **extra)
- 返回所有非空输入值的按位
OR的int，如果所有值都为空，则返回None。
BoolAnd
- class BoolAnd(expression, filter=None, **extra)
如果所有输入值都为真，则返回
True，如果所有值都为空或没有值，则返回None，否则返回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, **extra)
如果至少有一个输入值为真，则返回
True，如果所有值都为空或没有值，则返回None，否则返回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, ordering=(), **extra)
将输入值作为
JSON数组返回。- distinct
3.2 版中的新功能。
一个可选的布尔参数，用于确定数组值是否不同。 默认为
False。
- ordering
3.2 版中的新功能。
字段名称的可选字符串（带有指示降序的可选
"-"前缀）或指定结果列表中元素顺序的表达式（或字符串和/或表达式的元组或列表） .示例与 ArrayAgg.ordering 相同。
StringAgg
- class StringAgg(expression, delimiter, distinct=False, filter=None, ordering=())
返回连接成字符串的输入值，由
delimiter字符串分隔。- delimiter
必需的参数。 必须是字符串。
- distinct
一个可选的布尔参数，用于确定连接的值是否不同。 默认为
False。
- ordering
字段名称的可选字符串（带有指示降序的可选
"-"前缀）或指定结果字符串中元素顺序的表达式（或字符串和/或表达式的元组或列表） .示例与 ArrayAgg.ordering 相同。
统计聚合函数
y 和 x
所有这些函数的参数 y 和 x 可以是字段名称或返回数字数据的表达式。 两者都是必需的。
Corr
- class Corr(y, x, filter=None)
- 如果没有任何匹配的行，则以
float或None的形式返回相关系数。
CovarPop
- class CovarPop(y, x, sample=False, filter=None)
如果没有任何匹配的行，则以
float或None的形式返回总体协方差。有一个可选参数：
- sample
默认情况下，
CovarPop返回总体总体协方差。 但是，如果sample=True，返回值将是样本总体协方差。
RegrAvgX
- class RegrAvgX(y, x, filter=None)
- 如果没有任何匹配的行，则以
float或None的形式返回自变量 (sum(x)/N) 的平均值。
RegrAvgY
- class RegrAvgY(y, x, filter=None)
- 如果没有任何匹配的行，则以
float或None的形式返回因变量 (sum(y)/N) 的平均值。
RegrCount
- class RegrCount(y, x, filter=None)
- 返回两个表达式都不为空的输入行数的
int。
RegrIntercept
- class RegrIntercept(y, x, filter=None)
- 如果没有任何匹配的行，则返回由
(x, y)对确定的最小二乘拟合线性方程的 y 截距作为float或None。
RegrR2
- class RegrR2(y, x, filter=None)
- 如果没有任何匹配的行，则以
float或None的形式返回相关系数的平方。
RegrSlope
- class RegrSlope(y, x, filter=None)
- 如果没有任何匹配的行，则返回由
(x, y)对确定的最小二乘拟合线性方程的斜率作为float或None。
RegrSXX
- class RegrSXX(y, x, filter=None)
- 如果没有任何匹配的行，则返回
sum(x^2) - sum(x)^2/N（自变量的“平方和”）作为float或None。
RegrSXY
- class RegrSXY(y, x, filter=None)
- 如果没有任何匹配的行，则返回
sum(x*y) - sum(x) * sum(y)/N（独立时间因变量的“乘积之和”）作为float或None。
RegrSYY
- class RegrSYY(y, x, filter=None)
- 如果没有任何匹配的行，则返回
sum(y^2) - sum(y)^2/N（因变量的“平方和”）作为float或None。
使用示例
我们将使用此示例表：
| 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}
