Функции агрегирования, специфичные для 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) [source]

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

distinct

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

ordering

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

Необязательный строковый аргумент имени поля (с необязательным префиксом "-", указывающим порядок по убыванию) или выражения (или кортежа или списка строк и/или выражений), определяющего порядок элементов в результирующем списке.

Примеры:

'some_field'
'-some_field'
from django.db.models import F
F('some_field').desc()

BitAnd

class BitAnd(expression, filter=None, **extra) [source]

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

BitOr

class BitOr(expression, filter=None, **extra) [source]

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

BoolAnd

class BoolAnd(expression, filter=None, **extra) [source]

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

BoolOr

class BoolOr(expression, filter=None, **extra) [source]

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

JSONBAgg

class JSONBAgg(expressions, filter=None, **extra) [source]

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

StringAgg

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

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

delimiter

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

distinct

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

ordering

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

Необязательный строковый аргумент имени поля (с необязательным префиксом "-" , указывающим порядок по убыванию) или выражения (или кортежа или списка строк и/или выражений), определяющего порядок элементов в результирующей строке.

Примеры аналогичны примерам для ArrayAgg.ordering.

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

y и x

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

Corr

class Corr(y, x, filter=None) [source]

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

CovarPop

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

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

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

sample

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

RegrAvgX

class RegrAvgX(y, x, filter=None) [source]

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

RegrAvgY

class RegrAvgY(y, x, filter=None) [source]

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

RegrCount

class RegrCount(y, x, filter=None) [source]

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

RegrIntercept

class RegrIntercept(y, x, filter=None) [source]

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

RegrR2

class RegrR2(y, x, filter=None) [source]

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

RegrSlope

class RegrSlope(y, x, filter=None) [source]

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

RegrSXX

class RegrSXX(y, x, filter=None) [source]

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

RegrSXY

class RegrSXY(y, x, filter=None) [source]

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

RegrSYY

class RegrSYY(y, x, filter=None) [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}