Source code for django.contrib.postgres.aggregates.general

from django.contrib.postgres.fields import ArrayField
from django.db.models import Aggregate, BooleanField, JSONField, TextField, Value

from .mixins import OrderableAggMixin

__all__ = [
    "ArrayAgg",
    "BitAnd",
    "BitOr",
    "BitXor",
    "BoolAnd",
    "BoolOr",
    "JSONBAgg",
    "StringAgg",
]



[docs]
class ArrayAgg(OrderableAggMixin, Aggregate):
    function = "ARRAY_AGG"
    template = "%(function)s(%(distinct)s%(expressions)s %(order_by)s)"
    allow_distinct = True

    @property
    def output_field(self):
        return ArrayField(self.source_expressions[0].output_field)




[docs]
class BitAnd(Aggregate):
    function = "BIT_AND"




[docs]
class BitOr(Aggregate):
    function = "BIT_OR"




[docs]
class BitXor(Aggregate):
    function = "BIT_XOR"




[docs]
class BoolAnd(Aggregate):
    function = "BOOL_AND"
    output_field = BooleanField()




[docs]
class BoolOr(Aggregate):
    function = "BOOL_OR"
    output_field = BooleanField()




[docs]
class JSONBAgg(OrderableAggMixin, Aggregate):
    function = "JSONB_AGG"
    template = "%(function)s(%(distinct)s%(expressions)s %(order_by)s)"
    allow_distinct = True
    output_field = JSONField()




[docs]
class StringAgg(OrderableAggMixin, Aggregate):
    function = "STRING_AGG"
    template = "%(function)s(%(distinct)s%(expressions)s %(order_by)s)"
    allow_distinct = True
    output_field = TextField()

    def __init__(self, expression, delimiter, **extra):
        delimiter_expr = Value(str(delimiter))
        super().__init__(expression, delimiter_expr, **extra)