summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMads Jensen <mje@inducks.org>2016-11-12 21:42:20 +0100
committerTim Graham <timograham@gmail.com>2016-11-28 06:57:01 -0500
commitaa2cb4c622dfd5709ba89ac3cace959202318987 (patch)
treea51596027d4e4443369e66dffd757ccdb286477e
parent6252fd6314f66d2d303cc47c791ffefd27169b42 (diff)
Refs #26327 -- Renamed JsonAgg to JSONBAgg.
Thanks to Christian von Roques for the report.
-rw-r--r--django/contrib/postgres/aggregates/general.py4
-rw-r--r--django/db/backends/postgresql/features.py4
-rw-r--r--docs/ref/contrib/postgres/aggregates.txt8
-rw-r--r--docs/releases/1.11.txt2
-rw-r--r--tests/postgres_tests/test_aggregates.py10
5 files changed, 16 insertions, 12 deletions
diff --git a/django/contrib/postgres/aggregates/general.py b/django/contrib/postgres/aggregates/general.py
index 5d420505eb..5b3d22bf98 100644
--- a/django/contrib/postgres/aggregates/general.py
+++ b/django/contrib/postgres/aggregates/general.py
@@ -2,7 +2,7 @@ from django.contrib.postgres.fields import JSONField
from django.db.models.aggregates import Aggregate
__all__ = [
- 'ArrayAgg', 'BitAnd', 'BitOr', 'BoolAnd', 'BoolOr', 'JsonAgg', 'StringAgg',
+ 'ArrayAgg', 'BitAnd', 'BitOr', 'BoolAnd', 'BoolOr', 'JSONBAgg', 'StringAgg',
]
@@ -31,7 +31,7 @@ class BoolOr(Aggregate):
function = 'BOOL_OR'
-class JsonAgg(Aggregate):
+class JSONBAgg(Aggregate):
function = 'JSONB_AGG'
_output_field = JSONField()
diff --git a/django/db/backends/postgresql/features.py b/django/db/backends/postgresql/features.py
index 6fd6af9088..e3ef482d99 100644
--- a/django/db/backends/postgresql/features.py
+++ b/django/db/backends/postgresql/features.py
@@ -40,3 +40,7 @@ class DatabaseFeatures(BaseDatabaseFeatures):
@cached_property
def has_jsonb_datatype(self):
return self.connection.pg_version >= 90400
+
+ @cached_property
+ def has_jsonb_agg(self):
+ return self.connection.pg_version >= 90500
diff --git a/docs/ref/contrib/postgres/aggregates.txt b/docs/ref/contrib/postgres/aggregates.txt
index 6b5e827ab2..3939023e26 100644
--- a/docs/ref/contrib/postgres/aggregates.txt
+++ b/docs/ref/contrib/postgres/aggregates.txt
@@ -58,14 +58,14 @@ General-purpose aggregation functions
Returns ``True`` if at least one input value is true, ``None`` if all
values are null or if there are no values, otherwise ``False``.
-``JsonAgg``
------------
+``JSONBAgg``
+------------
-.. class:: JsonAgg(expressions, **extra)
+.. class:: JSONBAgg(expressions, **extra)
.. versionadded:: 1.11
- Returns the input values as a ``JSON`` array.
+ Returns the input values as a ``JSON`` array. Requires PostgreSQL ≥ 9.5.
``StringAgg``
-------------
diff --git a/docs/releases/1.11.txt b/docs/releases/1.11.txt
index 1b301078f1..486362fe43 100644
--- a/docs/releases/1.11.txt
+++ b/docs/releases/1.11.txt
@@ -183,7 +183,7 @@ Minor features
operation allow using PostgreSQL's ``citext`` extension for case-insensitive
lookups.
-* The new :class:`~django.contrib.postgres.aggregates.JsonAgg` allows
+* The new :class:`~django.contrib.postgres.aggregates.JSONBAgg` allows
aggregating values as a JSON array.
:mod:`django.contrib.redirects`
diff --git a/tests/postgres_tests/test_aggregates.py b/tests/postgres_tests/test_aggregates.py
index aaab3b1bc6..9aa0e06595 100644
--- a/tests/postgres_tests/test_aggregates.py
+++ b/tests/postgres_tests/test_aggregates.py
@@ -9,7 +9,7 @@ from .models import AggregateTestModel, StatTestModel
try:
from django.contrib.postgres.aggregates import (
- ArrayAgg, BitAnd, BitOr, BoolAnd, BoolOr, Corr, CovarPop, JsonAgg,
+ ArrayAgg, BitAnd, BitOr, BoolAnd, BoolOr, Corr, CovarPop, JSONBAgg,
RegrAvgX, RegrAvgY, RegrCount, RegrIntercept, RegrR2, RegrSlope,
RegrSXX, RegrSXY, RegrSYY, StatAggregate, StringAgg,
)
@@ -117,14 +117,14 @@ class TestGeneralAggregate(PostgreSQLTestCase):
values = AggregateTestModel.objects.aggregate(stringagg=StringAgg('char_field', delimiter=';'))
self.assertEqual(values, {'stringagg': ''})
- @skipUnlessDBFeature('has_jsonb_datatype')
+ @skipUnlessDBFeature('has_jsonb_agg')
def test_json_agg(self):
- values = AggregateTestModel.objects.aggregate(jsonagg=JsonAgg('char_field'))
+ values = AggregateTestModel.objects.aggregate(jsonagg=JSONBAgg('char_field'))
self.assertEqual(values, {'jsonagg': ['Foo1', 'Foo2', 'Foo3', 'Foo4']})
- @skipUnlessDBFeature('has_jsonb_datatype')
+ @skipUnlessDBFeature('has_jsonb_agg')
def test_json_agg_empty(self):
- values = AggregateTestModel.objects.none().aggregate(jsonagg=JsonAgg('integer_field'))
+ values = AggregateTestModel.objects.none().aggregate(jsonagg=JSONBAgg('integer_field'))
self.assertEqual(values, json.loads('{"jsonagg": []}'))