summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2015-08-31 13:13:04 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2015-08-31 13:13:04 -0400
commit6d0c0994e9a08cf5d149af0314970d5f6e25b159 (patch)
treed5e0c6993d56657f2eaa7d654cb85537be58c69c
parentc39ff9978dbb77cbea4f1ee08234887d8aa1b165 (diff)
downloadsqlalchemy-6d0c0994e9a08cf5d149af0314970d5f6e25b159.tar.gz
- add a note about DISTINCT in query w/ ORDER BY, references #3518
-rw-r--r--lib/sqlalchemy/orm/query.py13
1 files changed, 13 insertions, 0 deletions
diff --git a/lib/sqlalchemy/orm/query.py b/lib/sqlalchemy/orm/query.py
index 5d08cbcd5..7e77c66a8 100644
--- a/lib/sqlalchemy/orm/query.py
+++ b/lib/sqlalchemy/orm/query.py
@@ -2335,6 +2335,19 @@ class Query(object):
"""Apply a ``DISTINCT`` to the query and return the newly resulting
``Query``.
+
+ .. note::
+
+ The :meth:`.distinct` call includes logic that will automatically
+ add columns from the ORDER BY of the query to the columns
+ clause of the SELECT statement, to satisfy the common need
+ of the database backend that ORDER BY columns be part of the
+ SELECT list when DISTINCT is used. These columns *are not*
+ added to the list of columns actually fetched by the
+ :class:`.Query`, however, so would not affect results.
+ The columns are passed through when using the
+ :attr:`.Query.statement` accessor, however.
+
:param \*expr: optional column expressions. When present,
the Postgresql dialect will render a ``DISTINCT ON (<expressions>>)``
construct.