PostgreSQL 特有聚合函数

这些功能可以从 django.contrib.postgres.aggregates 模块中获得。在 PostgreSQL docs 中对这些功能有更详细的描述。

注解

所有的函数都没有默认的别名，所以你必须明确提供一个别名。例如：

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

通用聚合选项

所有聚合体都有 filter 关键字参数。

通用聚合函数

ArrayAgg

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

返回一个值的列表，包括空值，连接成一个数组。

  • distinct

    一个可选的布尔参数，用于确定数组值是否会被去重。默认值为 False。

  • ordering

    可选的字段名字符串（可选的 "-" 前缀表示降序）或表达式（或字符串和／或表达式的元组或列表），指定结果列表中元素的顺序。

    举例：

    1. 'some_field'
    2. '-some_field'
    3. from django.db.models import F
    4. 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。

使用实例：

  1. class Comment(models.Model):
  2.     body = models.TextField()
  3.     published = models.BooleanField()
  4.     rank = models.IntegerField()
  6. >>> from django.db.models import Q
  7. >>> from django.contrib.postgres.aggregates import BoolAnd
  8. >>> Comment.objects.aggregate(booland=BoolAnd('published'))
  9. {'booland': False}
  10. >>> Comment.objects.aggregate(booland=BoolAnd(Q(rank__lt=100)))
  11. {'booland': True}

BoolOr

class BoolOr(expression, filter=None, \*extra*)

如果所有输入值为真，返回 True，如果所有值为空或没有值，返回 None，否则返回 False。

使用实例：

  1. class Comment(models.Model):
  2.     body = models.TextField()
  3.     published = models.BooleanField()
  4.     rank = models.IntegerField()
  6. >>> from django.db.models import Q
  7. >>> from django.contrib.postgres.aggregates import BoolOr
  8. >>> Comment.objects.aggregate(boolor=BoolOr('published'))
  9. {'boolor': True}
  10. >>> Comment.objects.aggregate(boolor=BoolOr(Q(rank__gt=2)))
  11. {'boolor': False}

JSONBAgg

class JSONBAgg(expressions, distinct=False, filter=None, ordering=(), \*extra*)

将输入值以 JSON 数组形式返回。

  • distinct

    New in Django Development version.

    一个可选的布尔参数，用于确定数组值是否会被去重。默认值为 False。

  • ordering

    New in Django Development version.

    可选的字段名字符串（可选的 "-" 前缀表示降序）或表达式（或字符串和／或表达式的元组或列表），指定结果列表中元素的顺序。

    例子与 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)

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

RegrAvgY

class RegrAvgY(y, x, filter=None)

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

RegrCount

class RegrCount(y, x, filter=None)

返回两个表达式都不为空的输入行数的 int。

RegrIntercept

class RegrIntercept(y, x, filter=None)

返回由 (x, y) 对确定的最小二乘拟合线性方程的 y 截距，如果没有任何匹配的行，则返回 None。

RegrR2

class RegrR2(y, x, filter=None)

以 float `` 的形式返回相关系数的平方，如果没有任何匹配的行，则返回 ``None。

RegrSlope

class RegrSlope(y, x, filter=None)

返回由 (x, y) 对确定的最小二乘拟合线性方程的斜率，如果没有任何匹配的行，则返回 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。

使用实例：

我们将用这个例表：

  1. | FIELD1 | FIELD2 | FIELD3 |
  2. |--------|--------|--------|
  3. |    foo |      1 |     13 |
  4. |    bar |      2 | (null) |
  5. |   test |      3 |     13 |

下面是一些通用聚合函数的例子：

  1. >>> TestModel.objects.aggregate(result=StringAgg('field1', delimiter=';'))
  2. {'result': 'foo;bar;test'}
  3. >>> TestModel.objects.aggregate(result=ArrayAgg('field2'))
  4. {'result': [1, 2, 3]}
  5. >>> TestModel.objects.aggregate(result=ArrayAgg('field1'))
  6. {'result': ['foo', 'bar', 'test']}

下一个例子显示了统计聚合函数的使用。基本的数学知识将不作说明（例如，你可以在 wikipedia )：

  1. >>> TestModel.objects.aggregate(count=RegrCount(y='field3', x='field2'))
  2. {'count': 2}
  3. >>> TestModel.objects.aggregate(avgx=RegrAvgX(y='field3', x='field2'),
  4. ...                             avgy=RegrAvgY(y='field3', x='field2'))
  5. {'avgx': 2, 'avgy': 13}