Функции агрегирования, специфичные для PostgreSQL

Более подробное описание этих функций можно найти в документации PostgreSQL.

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

Функции агрегирования общего назначения

ArrayAgg

class ArrayAgg(expression, **extra) [source]

Возвращает список значений, включая NULL, объединённые в массив.

BitAnd

class BitAnd(expression, **extra) [source]

Возвращает int битового AND всех значений входных данных, отличных от NULL, или None если все значения NULL.

BitOr

class BitOr(expression, **extra) [source]

Возвращает int битового OR всех значений входных данных, отличных от NULL, или None если все значения NULL.

BoolAnd

class BoolAnd(expression, **extra) [source]

Возвращает True, если все входные значения true, None если все значения NULL или если значений нет, иначе False.

BoolOr

class BoolOr(expression, **extra) [source]

Возвращает True если хотя бы одно входное значение true, None если все значения NULL или если значений нет, иначе False.

JSONBAgg

class JSONBAgg(expressions, **extra) [source]

Добавлено в Django 1.11.

Возвращает значения входных данных в виде массива JSON. Требуется PostgreSQL ≥ 9.5.

StringAgg

class StringAgg(expression, delimiter, distinct=False) [source]

Возвращает значения входных данных, соединённые в строку, разделённые строкой delimiter.

delimiter

Обязательный аргумент. Должен быть строкой.

distinct

Добавлено в Django 1.11.

Необязательный булевый аргумент, определяющий, будут ли соединённые значения уникальными. По умолчанию False.

Функции агрегирования для статистики

y и x

Аргументы y и x для всех этих функций могут быть именем поля или выражением, возвращающим числовые данные. Оба обязательны.

Corr

class Corr(y, x) [source]

Возвращает коэффициент корреляции в виде float, или None если нет соответствующих строк.

CovarPop

class CovarPop(y, x, sample=False) [source]

Возвращает ковариацию генеральной совокупности в виде float, или None если нет соответствующих строк.

Имеет один необязательный аргумент:

sample

По умолчанию CovarPop возвращает ковариацию генеральной совокупности. Однако, если sample=True, возвращаемое значение будет ковариацией выборочной совокупности.

RegrAvgX

class RegrAvgX(y, x) [source]

Возвращает среднее значение независимой переменной (sum(x)/N) в виде float, или None если нет соответствующих строк.

RegrAvgY

class RegrAvgY(y, x) [source]

Возвращает среднее значение зависимой переменной (sum(y)/N) в виде float, или None если нет соответствующих строк.

RegrCount

class RegrCount(y, x) [source]

Возвращает количество строк входных данных, в которых оба выражения не NULL.

RegrIntercept

class RegrIntercept(y, x) [source]

Возвращает y-перехват линейного уравнения наименьших квадратов, определяемого (x, y) парами, в виде float, или None если нет соответствующих строк.

RegrR2

class RegrR2(y, x) [source]

Возвращает квадрат коэффициента корреляции в виде float, или None если нет соответствующих строк.

RegrSlope

class RegrSlope(y, x) [source]

Возвращает наклон линейного уравнения наименьших квадратов, определяемого (x, y) парами, в виде float, или None если нет соответствующих строк.

RegrSXX

class RegrSXX(y, x) [source]

Возвращает sum(x^2) - sum(x)^2/N (“сумма квадратов” независимой переменной) в виде float, или None если нет соответствующих строк.

RegrSXY

class RegrSXY(y, x) [source]

Возвращает sum(x*y) - sum(x) * sum(y)/N (“сумма произведений” независимой и зависимой переменной) в виде float, или None если нет соответствующих строк.

RegrSYY

class RegrSYY(y, x) [source]

Возвращает 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}