Added ordering support to JSONBAgg.

[john-parton]

Here's a contrived example:

class Author(models.Model):
    name = models.CharField(max_length=50)
    alias = models.CharField(max_length=50, null=True, blank=True)
    age = models.PositiveSmallIntegerField(default=30)


class Article(models.Model):
    authors = models.ManyToManyField(Author, related_name='articles')
    title = models.CharField(max_length=50)
    
    
Article.objects.annotate(
    authors_json=JSONBAgg(
        Func(
            Value('name'), 'name',
            Value('alias'), 'alias',
            function='jsonb_build_object'
        ),
        ordering='age'
    )
)

The ordering kwarg is ignored, but Postgres would have no problem understanding the aggregate with an ORDER BY clause

In my code I did the following

class OrderableJSONBAgg(OrderableAggMixin, Aggregate):
    function = 'JSONB_AGG'
    template = '%(function)s(%(expressions)s %(ordering)s)'
    output_field = JSONField()

    def convert_value(self, value, expression, connection):
        if not value:
            return []
        return value
    
    
from myapp.aggregates import OrderableJSONBAgg as JSONBAgg

I believe replacing the existing JSONBAgg with this implementation would add the feature, with no backwards compat issues.

I would be happy to submit a pull request.

[Mariusz Felisiak]

Would you like to prepare a patch? (see similar patch 96199e562dcc409ab4bdc2b2146fa7cf73c7c5fe for ArrayAgg and StringAgg).

[john-parton]

Sure. I think I can handle it.

[Simon Charette]

​PR

[Mariusz Felisiak <felisiak.mariusz@…>]

In a8473b4d:

Fixed #31691 -- Added ordering support to JSONBAgg.