summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/ext/asyncio/result.py
diff options
context:
space:
mode:
authorFederico Caselli <cfederico87@gmail.com>2021-07-13 21:47:28 +0200
committerMike Bayer <mike_mp@zzzcomputing.com>2021-07-20 14:04:48 -0400
commit85fa3473be1332af34ce905e9ea0affdeefbb223 (patch)
treed5b6c1c2051aa4861315a31fab3576bc5def2625 /lib/sqlalchemy/ext/asyncio/result.py
parentca52e87268fec966f6005b1e4aa30206ae895e9e (diff)
downloadsqlalchemy-85fa3473be1332af34ce905e9ea0affdeefbb223.tar.gz
Documentation improvements
Also remove deprecated usage: - load_only does not accept strings - case.whens is positional only Ref #6712 Ref #5994 Ref #6121 Ref #6785 Ref https://groups.google.com/g/sqlalchemy/c/-cnhThEu3kk Change-Id: I5db49a075b9d3d332518b9d189a24b13b502e2af
Diffstat (limited to 'lib/sqlalchemy/ext/asyncio/result.py')
-rw-r--r--lib/sqlalchemy/ext/asyncio/result.py9
1 files changed, 9 insertions, 0 deletions
diff --git a/lib/sqlalchemy/ext/asyncio/result.py b/lib/sqlalchemy/ext/asyncio/result.py
index 2fdaec741..dff87a569 100644
--- a/lib/sqlalchemy/ext/asyncio/result.py
+++ b/lib/sqlalchemy/ext/asyncio/result.py
@@ -29,6 +29,15 @@ class AsyncResult(AsyncCommon):
:meth:`_asyncio.AsyncConnection.stream` and
:meth:`_asyncio.AsyncSession.stream` methods.
+ .. note:: As is the case with :class:`_engine.Result`, this object is
+ used for ORM results returned by :meth:`_asyncio.AsyncSession.execute`,
+ which can yield instances of ORM mapped objects either individually or
+ within tuple-like rows. Note that these result objects do not
+ deduplicate instances or rows automatically as is the case with the
+ legacy :class:`_orm.Query` object. For in-Python de-duplication of
+ instances or rows, use the :meth:`_asyncio.AsyncResult.unique` modifier
+ method.
+
.. versionadded:: 1.4
"""