diff options
| author | jonathan vanasco <jonathan@2xlp.com> | 2020-09-04 19:48:38 -0400 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2020-10-26 10:49:27 -0400 |
| commit | 10851b002844fa4f9de7af92dbb15cb1133497eb (patch) | |
| tree | 87cfe7922d3dd83e804ff32ddd6761b7030c84f7 /lib/sqlalchemy/orm/session.py | |
| parent | 8d588b06d984cb053be53e779cfa11b1d5166f03 (diff) | |
| download | sqlalchemy-10851b002844fa4f9de7af92dbb15cb1133497eb.tar.gz | |
added docstring about expire_on_commit for #5243
Fixes: #5243
Closes: #5328
Pull-request: https://github.com/sqlalchemy/sqlalchemy/pull/5328
Pull-request-sha: e760ed4ef1749aadfb8d63d776c764d98b93b1e5
Change-Id: I8e7bc3429dc279d447cc66400c76b4d2a04626aa
Diffstat (limited to 'lib/sqlalchemy/orm/session.py')
| -rw-r--r-- | lib/sqlalchemy/orm/session.py | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/lib/sqlalchemy/orm/session.py b/lib/sqlalchemy/orm/session.py index af0ac63e0..37ca1523a 100644 --- a/lib/sqlalchemy/orm/session.py +++ b/lib/sqlalchemy/orm/session.py @@ -953,6 +953,11 @@ class Session(_SessionClassMethods): so that all attribute/object access subsequent to a completed transaction will load from the most recent database state. + .. seealso:: + + :ref:`session_committing` + + :param future: if True, use 2.0 style behavior for the :meth:`_orm.Session.execute` method. Future mode includes the following behaviors: @@ -3838,8 +3843,10 @@ class sessionmaker(_SessionClassMethods): :class:`.Session` objects. :param autocommit: The autocommit setting to use with newly created :class:`.Session` objects. - :param expire_on_commit=True: the expire_on_commit setting to use + :param expire_on_commit=True: the + :paramref:`_orm.Session.expire_on_commit` setting to use with newly created :class:`.Session` objects. + :param info: optional dictionary of information that will be available via :attr:`.Session.info`. Note this dictionary is *updated*, not replaced, when the ``info`` parameter is specified to the specific |