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

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

distinct

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

ordering

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

Примеры:

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

BitAnd

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

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

BitOr

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

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

BoolAnd

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

Возвращает True, если все входные значения истинны, None если все значения равны null или если значений нет, иначе 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 если все значения равны null или если значений нет, иначе 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

В Django 3.2.

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

ordering

В Django 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)

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

RegrAvgY

class RegrAvgY(y, x, filter=None)

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

RegrCount

class RegrCount(y, x, filter=None)

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

RegrIntercept

class RegrIntercept(y, x, filter=None)

Возвращает значение y-пересечения линейного уравнения наименьших квадратов, определяемого (x, 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']}

Следующий пример демонстрирует использование статистических функций агрегирования. Подробный математический анализ не будет приведён (подробнее можно прочитать, например, в википедии):

>>> 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}