summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/ext/asyncio/session.py
diff options
context:
space:
mode:
authorFederico Caselli <cfederico87@gmail.com>2021-09-29 21:54:09 +0200
committermike bayer <mike_mp@zzzcomputing.com>2021-10-08 17:09:59 +0000
commit38d6c6c5dc3d0c7da2268e0f9a1a71c108ab7c51 (patch)
tree0fdafb9cf740a3333b15f3a4815138736af5c995 /lib/sqlalchemy/ext/asyncio/session.py
parent64e6da307c79981119cbd6f95957ead310e3456f (diff)
downloadsqlalchemy-38d6c6c5dc3d0c7da2268e0f9a1a71c108ab7c51.tar.gz
Add documentation on how to use the events with asyncio
Co-authored-by: Mike Bayer <mike_mp@zzzcomputing.com> Fixes: #6899 Change-Id: I965af321fb36d9645fe3fc2675ad9943f24e32f2
Diffstat (limited to 'lib/sqlalchemy/ext/asyncio/session.py')
-rw-r--r--lib/sqlalchemy/ext/asyncio/session.py12
1 files changed, 12 insertions, 0 deletions
diff --git a/lib/sqlalchemy/ext/asyncio/session.py b/lib/sqlalchemy/ext/asyncio/session.py
index 6e3ac5a90..d2c969056 100644
--- a/lib/sqlalchemy/ext/asyncio/session.py
+++ b/lib/sqlalchemy/ext/asyncio/session.py
@@ -122,6 +122,18 @@ class AsyncSession(ReversibleProxy):
"""
+ sync_session: Session
+ """Reference to the underlying :class:`_orm.Session` this
+ :class:`_asyncio.AsyncSession` proxies requests towards.
+
+ This instance can be used as an event target.
+
+ .. seealso::
+
+ :ref:`asyncio_events`
+
+ """
+
async def refresh(
self, instance, attribute_names=None, with_for_update=None
):