summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/build/changelog/changelog_11.rst4
-rw-r--r--doc/build/changelog/migration_11.rst9
-rw-r--r--doc/build/dialects/postgresql.rst1
-rw-r--r--lib/sqlalchemy/dialects/postgresql/__init__.py5
-rw-r--r--lib/sqlalchemy/dialects/postgresql/array.py4
-rw-r--r--lib/sqlalchemy/dialects/postgresql/base.py5
-rw-r--r--lib/sqlalchemy/dialects/postgresql/ext.py14
-rw-r--r--lib/sqlalchemy/sql/functions.py11
-rw-r--r--test/dialect/postgresql/test_types.py11
9 files changed, 56 insertions, 8 deletions
diff --git a/doc/build/changelog/changelog_11.rst b/doc/build/changelog/changelog_11.rst
index 09d9e0958..7d076a35c 100644
--- a/doc/build/changelog/changelog_11.rst
+++ b/doc/build/changelog/changelog_11.rst
@@ -42,7 +42,9 @@
Added support for the SQL-standard function :class:`.array_agg`,
which automatically returns an :class:`.Array` of the correct type
- and supports index / slice operations. As arrays are only
+ and supports index / slice operations, as well as
+ :func:`.postgresql.array_agg`, which returns a :class:`.postgresql.ARRAY`
+ with additional comparison features. As arrays are only
supported on Postgresql at the moment, only actually works on
Postgresql. Also added a new construct
:class:`.postgresql.aggregate_order_by` in support of PG's
diff --git a/doc/build/changelog/migration_11.rst b/doc/build/changelog/migration_11.rst
index 6e37fb04f..3a0666dcc 100644
--- a/doc/build/changelog/migration_11.rst
+++ b/doc/build/changelog/migration_11.rst
@@ -275,7 +275,7 @@ which is now available using :class:`.array_agg`::
from sqlalchemy import func
stmt = select([func.array_agg(table.c.value)])
-A Postgresql element for an aggreagte ORDER BY is also added via
+A Postgresql element for an aggregate ORDER BY is also added via
:class:`.postgresql.aggregate_order_by`::
from sqlalchemy.dialects.postgresql import aggregate_order_by
@@ -286,6 +286,13 @@ Producing::
SELECT array_agg(table1.a ORDER BY table1.b DESC) AS array_agg_1 FROM table1
+The PG dialect itself also provides an :func:`.postgresql.array_agg` wrapper to
+ensure the :class:`.postgresql.ARRAY` type::
+
+ from sqlalchemy.dialects.postgresql import array_agg
+ stmt = select([array_agg(table.c.value).contains('foo')])
+
+
Additionally, functions like ``percentile_cont()``, ``percentile_disc()``,
``rank()``, ``dense_rank()`` and others that require an ordering via
``WITHIN GROUP (ORDER BY <expr>)`` are now available via the
diff --git a/doc/build/dialects/postgresql.rst b/doc/build/dialects/postgresql.rst
index facb2646e..7e2a20ef7 100644
--- a/doc/build/dialects/postgresql.rst
+++ b/doc/build/dialects/postgresql.rst
@@ -31,6 +31,7 @@ construction arguments, are as follows:
.. autoclass:: ARRAY
:members: __init__, Comparator
+.. autofunction:: array_agg
.. autofunction:: Any
diff --git a/lib/sqlalchemy/dialects/postgresql/__init__.py b/lib/sqlalchemy/dialects/postgresql/__init__.py
index 2dac6cecc..d67f2a07e 100644
--- a/lib/sqlalchemy/dialects/postgresql/__init__.py
+++ b/lib/sqlalchemy/dialects/postgresql/__init__.py
@@ -17,7 +17,7 @@ from .base import \
from .hstore import HSTORE, hstore
from .json import JSON, JSONB
from .array import array, ARRAY, Any, All
-from .ext import aggregate_order_by, ExcludeConstraint
+from .ext import aggregate_order_by, ExcludeConstraint, array_agg
from .ranges import INT4RANGE, INT8RANGE, NUMRANGE, DATERANGE, TSRANGE, \
TSTZRANGE
@@ -29,5 +29,6 @@ __all__ = (
'INTERVAL', 'ARRAY', 'ENUM', 'dialect', 'array', 'HSTORE',
'hstore', 'INT4RANGE', 'INT8RANGE', 'NUMRANGE', 'DATERANGE',
'TSRANGE', 'TSTZRANGE', 'json', 'JSON', 'JSONB', 'Any', 'All',
- 'DropEnumType', 'CreateEnumType', 'ExcludeConstraint', 'aggregate_order_by'
+ 'DropEnumType', 'CreateEnumType', 'ExcludeConstraint',
+ 'aggregate_order_by', 'array_agg'
)
diff --git a/lib/sqlalchemy/dialects/postgresql/array.py b/lib/sqlalchemy/dialects/postgresql/array.py
index 68c7b0bdb..ebdfe1695 100644
--- a/lib/sqlalchemy/dialects/postgresql/array.py
+++ b/lib/sqlalchemy/dialects/postgresql/array.py
@@ -22,7 +22,7 @@ def Any(other, arrexpr, operator=operators.eq):
.. seealso::
- :func:`.expression.any`
+ :func:`.expression.any_`
"""
@@ -36,7 +36,7 @@ def All(other, arrexpr, operator=operators.eq):
.. seealso::
- :func:`.expression.all`
+ :func:`.expression.all_`
"""
diff --git a/lib/sqlalchemy/dialects/postgresql/base.py b/lib/sqlalchemy/dialects/postgresql/base.py
index 4022db14b..ec12e1145 100644
--- a/lib/sqlalchemy/dialects/postgresql/base.py
+++ b/lib/sqlalchemy/dialects/postgresql/base.py
@@ -518,6 +518,11 @@ as well as array literals:
* :class:`.postgresql.array` - array literal
+* :func:`.postgresql.array_agg` - ARRAY_AGG SQL function
+
+* :class:`.postgresql.aggregate_order_by` - helper for PG's ORDER BY aggregate
+ function syntax.
+
JSON Types
----------
diff --git a/lib/sqlalchemy/dialects/postgresql/ext.py b/lib/sqlalchemy/dialects/postgresql/ext.py
index 8b08cc498..9b2e3fd73 100644
--- a/lib/sqlalchemy/dialects/postgresql/ext.py
+++ b/lib/sqlalchemy/dialects/postgresql/ext.py
@@ -7,7 +7,9 @@
from ...sql import expression
from ...sql import elements
+from ...sql import functions
from ...sql.schema import ColumnCollectionConstraint
+from .array import ARRAY
class aggregate_order_by(expression.ColumnElement):
@@ -152,3 +154,15 @@ static/sql-createtable.html#SQL-CREATETABLE-EXCLUDE
initially=self.initially)
c.dispatch._update(self.dispatch)
return c
+
+
+def array_agg(*arg, **kw):
+ """Postgresql-specific form of :class:`.array_agg`, ensures
+ return type is :class:`.postgresql.ARRAY` and not
+ the plain :class:`.types.Array`.
+
+ .. versionadded:: 1.1
+
+ """
+ kw['type_'] = ARRAY(functions._type_from_args(arg))
+ return functions.func.array_agg(*arg, **kw)
diff --git a/lib/sqlalchemy/sql/functions.py b/lib/sqlalchemy/sql/functions.py
index d5d0eb7f2..6cfbd12b3 100644
--- a/lib/sqlalchemy/sql/functions.py
+++ b/lib/sqlalchemy/sql/functions.py
@@ -661,17 +661,24 @@ class array_agg(GenericFunction):
The ``func.array_agg(expr)`` construct returns an expression of
type :class:`.Array`.
- e.g.
+ e.g.::
stmt = select([func.array_agg(table.c.values)[2:5]])
.. versionadded:: 1.1
+ .. seealso::
+
+ :func:`.postgresql.array_agg` - PostgreSQL-specific version that
+ returns :class:`.ARRAY`, which has PG-specific operators added.
+
"""
+ type = sqltypes.Array
+
def __init__(self, *args, **kwargs):
args = [_literal_as_binds(c) for c in args]
- kwargs.setdefault('type_', sqltypes.Array(_type_from_args(args)))
+ kwargs.setdefault('type_', self.type(_type_from_args(args)))
kwargs['_parsed_args'] = args
super(array_agg, self).__init__(*args, **kwargs)
diff --git a/test/dialect/postgresql/test_types.py b/test/dialect/postgresql/test_types.py
index a625e1cee..8eab9d4b9 100644
--- a/test/dialect/postgresql/test_types.py
+++ b/test/dialect/postgresql/test_types.py
@@ -859,6 +859,17 @@ class ArrayTest(AssertsCompiledSQL, fixtures.TestBase):
"ARRAY[%(param_4)s, %(param_5)s, %(param_6)s]))[%(param_7)s]"
)
+ def test_array_agg_generic(self):
+ expr = func.array_agg(column('q', Integer))
+ is_(expr.type.__class__, types.Array)
+ is_(expr.type.item_type.__class__, Integer)
+
+ def test_array_agg_specific(self):
+ from sqlalchemy.dialects.postgresql import array_agg
+ expr = array_agg(column('q', Integer))
+ is_(expr.type.__class__, postgresql.ARRAY)
+ is_(expr.type.item_type.__class__, Integer)
+
class ArrayRoundTripTest(fixtures.TablesTest, AssertsExecutionResults):