Функции агрегации, специфичные для PostgreSQL¶
Эти функции доступны из модуля django.contrib.postgres.aggregates
. Более подробно они описаны в модуле PostgreSQL docs.
Примечание
Все функции поставляются без псевдонимов по умолчанию, поэтому вы должны явно указать их. Например:
>>> 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)[исходный код]¶ Возвращает
int
побитовогоAND
всех не нулевых входных значений, илиNone
, если все значения нулевые.
BitOr
¶
-
class
BitOr
(expression, filter=None, **extra)[исходный код]¶ Возвращает
int
побитовогоOR
всех не нулевых входных значений, илиNone
, если все значения нулевые.
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 BooleanField, 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), output_field=BooleanField())) {'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 BooleanField, 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), output_field=BooleanField())) {'boolor': False}
JSONBAgg
¶
-
class
JSONBAgg
(expressions, filter=None, **extra)[исходный код]¶ Возвращает входные значения в виде массива
JSON
.
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)[исходный код]¶ Возвращает 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']}
Следующий пример демонстрирует использование статистических агрегатных функций. Математика, лежащая в основе, описываться не будет (об этом можно прочитать, например, в 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}