Специальные агрегатные функции PostgreSQL

ArrayAgg

class ArrayAgg(expression, distinct=False, filter=None, default=None, order_by=(), **extra)

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

distinct

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

order_by

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

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

Примеры:

from django.db.models import F

ArrayAgg("a_field", order_by="-some_field")
ArrayAgg("a_field", order_by=F("some_field").desc())

Устарело начиная с версии 5.2: Именованный аргумент ordering устарел. Вместо него используйте ArrayAgg.order_by.

BitAnd

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

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

BitOr

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

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

BitXor

class BitXor(expression, filter=None, default=None, **extra)

Возвращает int побитового XOR всех входных значений, не равных NULL, или default, если все значения равны NULL. Требуется PostgreSQL 14 или более поздней версии.

BoolAnd

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

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

Возвращает True, если хотя бы одно входное значение истинно, default, если все значения равны 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, default=None, order_by=(), **extra)

Возвращает входные значения в виде массива JSON или default, если значений нет. Результат можно запрашивать с помощью key and index lookups.

distinct

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

order_by

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

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

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

Пример использования:

class Room(models.Model):
    number = models.IntegerField(unique=True)


class HotelReservation(models.Model):
    room = models.ForeignKey("Room", on_delete=models.CASCADE)
    start = models.DateTimeField()
    end = models.DateTimeField()
    requirements = models.JSONField(blank=True, null=True)

>>> from django.contrib.postgres.aggregates import JSONBAgg
>>> Room.objects.annotate(
...     requirements=JSONBAgg(
...         "hotelreservation__requirements",
...         order_by="-hotelreservation__start",
...     )
... ).filter(requirements__0__sea_view=True).values("number", "requirements")
<QuerySet [{'number': 102, 'requirements': [
    {'parking': False, 'sea_view': True, 'double_bed': False},
    {'parking': True, 'double_bed': True}
]}]>

Устарело начиная с версии 5.2: Именованный аргумент ordering устарел. Вместо него используйте JSONBAgg.order_by.

StringAgg

class StringAgg(expression, delimiter, distinct=False, filter=None, default=None, order_by=())

Устарело начиная с версии 6.0.

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

delimiter

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

distinct

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

order_by

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

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

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

Пример использования:

class Publication(models.Model):
    title = models.CharField(max_length=30)


class Article(models.Model):
    headline = models.CharField(max_length=100)
    publications = models.ManyToManyField(Publication)

>>> article = Article.objects.create(headline="NASA uses Python")
>>> article.publications.create(title="The Python Journal")
<Publication: Publication object (1)>
>>> article.publications.create(title="Science News")
<Publication: Publication object (2)>
>>> from django.contrib.postgres.aggregates import StringAgg
>>> Article.objects.annotate(
...     publication_names=StringAgg(
...         "publications__title",
...         delimiter=", ",
...         order_by="publications__title",
...     )
... ).values("headline", "publication_names")
<QuerySet [{
    'headline': 'NASA uses Python', 'publication_names': 'Science News, The Python Journal'
}]>

Устарело начиная с версии 5.2: Именованный аргумент ordering устарел. Вместо него используйте StringAgg.order_by.

y и x

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

Corr

class Corr(y, x, filter=None, default=None)

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

CovarPop

class CovarPop(y, x, sample=False, filter=None, default=None)

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

sample

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

RegrAvgX

class RegrAvgX(y, x, filter=None, default=None)

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

RegrAvgY

class RegrAvgY(y, x, filter=None, default=None)

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

RegrCount

class RegrCount(y, x, filter=None)

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

Примечание

Аргумент default не поддерживается.

RegrIntercept

class RegrIntercept(y, x, filter=None, default=None)

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

RegrR2

class RegrR2(y, x, filter=None, default=None)

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

RegrSlope

class RegrSlope(y, x, filter=None, default=None)

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

RegrSXX

class RegrSXX(y, x, filter=None, default=None)

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

RegrSXY

class RegrSXY(y, x, filter=None, default=None)

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

RegrSYY

class RegrSYY(y, x, filter=None, default=None)

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