Специальные функции агрегирования PostgreSQL¶
Эти функции доступны из модуля django.contrib.postgres.aggregates. Более подробно они описаны в Документации PostgreSQL.
Примечание
All functions come without default aliases, so you must explicitly provide one. For example:
>>> SomeModel.objects.aggregate(arr=ArrayAgg('somefield'))
{'arr': [0, 1, 2]}
Функции агрегирования общего назначения¶
ArrayAgg¶
- class ArrayAgg(expression, distinct=False, filter=None, ordering=(), **extra)¶
Returns a list of values, including nulls, concatenated into an array.
- distinct¶
Необязательный логический аргумент, определяющий, будут ли значения массива различны. По умолчанию установлено значение «False».
- ordering¶
Необязательная строка имени поля (с необязательным префиксом
"-", который указывает порядок убывания) или выражение (или кортеж или список строк и/или выражений), которое определяет порядок элементов в списке результатов.Например:
'some_field' '-some_field' from django.db.models import F F('some_field').desc()
БитИ¶
- class BitAnd(expression, filter=None, **extra)¶
Returns an
intof the bitwiseANDof all non-null input values, orNoneif all values are null.
БитОр¶
- class BitOr(expression, filter=None, **extra)¶
Returns an
intof the bitwiseORof all non-null input values, orNoneif all values are null.
BoolAnd¶
- class BoolAnd(expression, filter=None, **extra)¶
Returns
True, if all input values are true,Noneif all values are null or if there are no values, otherwiseFalse.Пример использования:
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)¶
Returns
Trueif at least one input value is true,Noneif all values are null or if there are no values, otherwiseFalse.Пример использования:
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)¶
Returns the input values as a
JSONarray.- distinct¶
- New in Django 3.2.
Необязательный логический аргумент, определяющий, будут ли значения массива различны. По умолчанию установлено значение «False».
- ordering¶
- New in Django 3.2.
Необязательная строка имени поля (с необязательным префиксом
"-", который указывает порядок убывания) или выражение (или кортеж или список строк и/или выражений), которое определяет порядок элементов в списке результатов.Примеры такие же, как для
ArrayAgg.ordering.
StringAgg¶
- class StringAgg(expression, delimiter, distinct=False, filter=None, ordering=())¶
Returns the input values concatenated into a string, separated by the
delimiterstring.- delimiter¶
Обязательный аргумент. Должна быть строка.
- distinct¶
Необязательный логический аргумент, определяющий, будут ли объединенные значения различны. По умолчанию установлено значение «False».
- ordering¶
Необязательная строка имени поля (с необязательным префиксом
"-", который указывает порядок убывания) или выражение (или кортеж или список строк и/или выражений), которое определяет порядок элементов в результирующей строке.Примеры такие же, как для
ArrayAgg.ordering.
Агрегатные функции для статистики¶
y и x¶
Аргументы y и x для всех этих функций могут быть именем поля или выражением, возвращающим числовые данные. Оба необходимы.
Корр¶
- class Corr(y, x, filter=None)¶
Returns the correlation coefficient as a
float, orNoneif there aren’t any matching rows.
КоварПоп¶
- class CovarPop(y, x, sample=False, filter=None)¶
Returns the population covariance as a
float, orNoneif there aren’t any matching rows.Has one optional argument:
- sample¶
By default
CovarPopreturns the general population covariance. However, ifsample=True, the return value will be the sample population covariance.
RegrAvgX¶
- class RegrAvgX(y, x, filter=None)¶
Returns the average of the independent variable (
sum(x)/N) as afloat, orNoneif there aren’t any matching rows.
RegrAvgY¶
- class RegrAvgY(y, x, filter=None)¶
Returns the average of the dependent variable (
sum(y)/N) as afloat, orNoneif there aren’t any matching rows.
РегрКаунт¶
- class RegrCount(y, x, filter=None)¶
Возвращает целое число, определяющее количество входных строк, в которых оба выражения не равны нулю.
РегрИнтерцепт¶
- class RegrIntercept(y, x, filter=None)¶
Returns the y-intercept of the least-squares-fit linear equation determined by the
(x, y)pairs as afloat, orNoneif there aren’t any matching rows.
РегрР2¶
- class RegrR2(y, x, filter=None)¶
Returns the square of the correlation coefficient as a
float, orNoneif there aren’t any matching rows.
RegrSlope¶
- class RegrSlope(y, x, filter=None)¶
Returns the slope of the least-squares-fit linear equation determined by the
(x, y)pairs as afloat, orNoneif there aren’t any matching rows.
РегрSXX¶
- class RegrSXX(y, x, filter=None)¶
Returns
sum(x^2) - sum(x)^2/N(«sum of squares» of the independent variable) as afloat, orNoneif there aren’t any matching rows.
RegrSXY¶
- class RegrSXY(y, x, filter=None)¶
Returns
sum(x*y) - sum(x) * sum(y)/N(«sum of products» of independent times dependent variable) as afloat, orNoneif there aren’t any matching rows.
RegrSYY¶
- class RegrSYY(y, x, filter=None)¶
Returns
sum(y^2) - sum(y)^2/N(«sum of squares» of the dependent variable) as afloat, orNoneif there aren’t any matching rows.
Примеры использования¶
We will use this example table:
| FIELD1 | FIELD2 | FIELD3 |
|--------|--------|--------|
| foo | 1 | 13 |
| bar | 2 | (null) |
| test | 3 | 13 |
Here’s some examples of some of the general-purpose aggregation functions:
>>> 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']}
The next example shows the usage of statistical aggregate functions. The underlying math will be not described (you can read about this, for example, at 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}