]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
doc update regarding with_lockmode, [ticket:2440]
authorMike Bayer <mike_mp@zzzcomputing.com>
Fri, 4 May 2012 21:50:39 +0000 (17:50 -0400)
committerMike Bayer <mike_mp@zzzcomputing.com>
Fri, 4 May 2012 21:50:39 +0000 (17:50 -0400)
lib/sqlalchemy/orm/__init__.py
lib/sqlalchemy/orm/query.py

index ca4099d68d80fe869be4791c0c9cbfda30899e6c..41923c2b1387c080ad9c006345d5a2442174278e 100644 (file)
@@ -390,12 +390,14 @@ def relationship(argument, secondary=None, **kwargs):
     :param innerjoin=False:
       when ``True``, joined eager loads will use an inner join to join
       against related tables instead of an outer join.  The purpose
-      of this option is strictly one of performance, as inner joins
-      generally perform better than outer joins.  This flag can
-      be set to ``True`` when the relationship references an object
-      via many-to-one using local foreign keys that are not nullable,
-      or when the reference is one-to-one or a collection that is 
-      guaranteed to have one or at least one entry.
+      of this option is generally one of performance, as inner joins
+      generally perform better than outer joins. Another reason can be
+      the use of ``with_lockmode``, which does not support outer joins.
+
+      This flag can be set to ``True`` when the relationship references an
+      object via many-to-one using local foreign keys that are not nullable,
+      or when the reference is one-to-one or a collection that is guaranteed
+      to have one or at least one entry.
 
     :param join_depth:
       when non-``None``, an integer value indicating how many levels
@@ -1673,4 +1675,4 @@ def undefer_group(name):
     return strategies.UndeferGroupOption(name)
 
 from sqlalchemy import util as _sa_util
-_sa_util.importlater.resolve_all()
\ No newline at end of file
+_sa_util.importlater.resolve_all()
index 2f1d9050f6f36fe703f2b9ba3c324eb4460e1297..79ef423535c853456613f7309c01934751987814 100644 (file)
@@ -1106,7 +1106,7 @@ class Query(object):
 
             ``'update_nowait'`` - passes ``for_update='nowait'``, which
             translates to ``FOR UPDATE NOWAIT`` (supported by Oracle, 
-            PostgreSQL)
+            PostgreSQL 8.1 upwards)
 
             ``'read'`` - passes ``for_update='read'``, which translates to
             ``LOCK IN SHARE MODE`` (for MySQL), and ``FOR SHARE`` (for