summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/orm/query.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2015-10-20 18:01:20 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2015-10-20 18:13:16 -0400
commit13278d110804e4c28c6e81412d5ede1b8f4f6947 (patch)
tree8e9a7bd1c713a85906f63f5599e4809fa9df0750 /lib/sqlalchemy/orm/query.py
parent5bc5adb6270bd5c7ef0564973cbd765aa371fbca (diff)
downloadsqlalchemy-13278d110804e4c28c6e81412d5ede1b8f4f6947.tar.gz
- try to make this language more succinct and fix links
(cherry picked from commit 3ffe8569fbaa72c2d844604b600c4661097339eb)
Diffstat (limited to 'lib/sqlalchemy/orm/query.py')
-rw-r--r--lib/sqlalchemy/orm/query.py32
1 files changed, 8 insertions, 24 deletions
diff --git a/lib/sqlalchemy/orm/query.py b/lib/sqlalchemy/orm/query.py
index dc36f2f35..3b51b80ba 100644
--- a/lib/sqlalchemy/orm/query.py
+++ b/lib/sqlalchemy/orm/query.py
@@ -2462,7 +2462,7 @@ class Query(object):
(note this may consist of multiple result rows if join-loaded
collections are present).
- Calling ``first()`` results in an execution of the underlying query.
+ Calling :meth:`.Query.first` results in an execution of the underlying query.
.. seealso::
@@ -2486,17 +2486,11 @@ class Query(object):
Returns ``None`` if the query selects
no rows. Raises ``sqlalchemy.orm.exc.MultipleResultsFound``
if multiple object identities are returned, or if multiple
- rows are returned for a query that does not return object
- identities.
+ rows are returned for a query that returns only scalar values
+ as opposed to full identity-mapped entities.
- Note that an entity query, that is, one which selects one or
- more mapped classes as opposed to individual column attributes,
- may ultimately represent many rows but only one row of
- unique entity or entities - this is a successful result for
- `one_or_none()`.
-
- Calling ``one_or_none()`` results in an execution of the underlying
- query.
+ Calling :meth:`.Query.one_or_none` results in an execution of the
+ underlying query.
.. versionadded:: 1.0.9
@@ -2526,20 +2520,10 @@ class Query(object):
Raises ``sqlalchemy.orm.exc.NoResultFound`` if the query selects
no rows. Raises ``sqlalchemy.orm.exc.MultipleResultsFound``
if multiple object identities are returned, or if multiple
- rows are returned for a query that does not return object
- identities.
-
- Note that an entity query, that is, one which selects one or
- more mapped classes as opposed to individual column attributes,
- may ultimately represent many rows but only one row of
- unique entity or entities - this is a successful result for one().
-
- Calling ``one()`` results in an execution of the underlying query.
+ rows are returned for a query that returns only scalar values
+ as opposed to full identity-mapped entities.
- .. versionchanged:: 0.6
- ``one()`` fully fetches all results instead of applying
- any kind of limit, so that the "unique"-ing of entities does not
- conceal multiple object identities.
+ Calling :meth:`.one` results in an execution of the underlying query.
.. seealso::