summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2022-04-08 10:36:50 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2022-04-08 10:36:50 -0400
commited2b29dc344c9cb65745c767b755f82d913695b8 (patch)
treec8a8a74cf15b4612338cd8fedef2ba9e06ac8cf8 /lib/sqlalchemy
parent9b32d9040a7d5716ae3871acd76a598f6c402423 (diff)
downloadsqlalchemy-ed2b29dc344c9cb65745c767b755f82d913695b8.tar.gz
clarify autoflush setting does not apply to commit
Change-Id: Icad0f3bd071422b8d1af204c9a1193a9ce6124ba References: #7916
Diffstat (limited to 'lib/sqlalchemy')
-rw-r--r--lib/sqlalchemy/orm/session.py9
1 files changed, 9 insertions, 0 deletions
diff --git a/lib/sqlalchemy/orm/session.py b/lib/sqlalchemy/orm/session.py
index 58820fef6..6279c17fb 100644
--- a/lib/sqlalchemy/orm/session.py
+++ b/lib/sqlalchemy/orm/session.py
@@ -1104,6 +1104,10 @@ class Session(_SessionClassMethods):
not be called repeatedly in order for database queries to retrieve
results.
+ .. seealso::
+
+ :ref:`session_flushing` - additional background on autoflush
+
:param bind: An optional :class:`_engine.Engine` or
:class:`_engine.Connection` to
which this ``Session`` should be bound. When specified, all SQL
@@ -4022,6 +4026,11 @@ class sessionmaker(_SessionClassMethods):
objects. Defaults to :class:`.Session`.
:param autoflush: The autoflush setting to use with newly created
:class:`.Session` objects.
+
+ .. seealso::
+
+ :ref:`session_flushing` - additional background on autoflush
+
:param expire_on_commit=True: the
:paramref:`_orm.Session.expire_on_commit` setting to use
with newly created :class:`.Session` objects.