]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
these are in alphabetical order
authorMike Bayer <mike_mp@zzzcomputing.com>
Sun, 13 Oct 2013 21:17:00 +0000 (17:17 -0400)
committerMike Bayer <mike_mp@zzzcomputing.com>
Sun, 13 Oct 2013 21:17:00 +0000 (17:17 -0400)
lib/sqlalchemy/orm/relationships.py

index dbc37a4ebae22739d1ad0cb056b7faa59a49a778..9fc67cd38ecfcec61ce00e33e734b471f8b31c35 100644 (file)
@@ -283,6 +283,27 @@ class RelationshipProperty(StrategizedProperty):
           a class which extends :class:`.RelationshipProperty.Comparator` which
           provides custom SQL clause generation for comparison operations.
 
+        :param distinct_target_key=None:
+          Indicate if a "subquery" eager load should apply the DISTINCT
+          keyword to the innermost SELECT statement.  When left as ``None``,
+          the DISTINCT keyword will be applied in those cases when the target
+          columns do not comprise the full primary key of the target table.
+          When set to ``True``, the DISTINCT keyword is applied to the innermost
+          SELECT unconditionally.
+
+          It may be desirable to set this flag to False when the DISTINCT is
+          reducing performance of the innermost subquery beyond that of what
+          duplicate innermost rows may be causing.
+
+          .. versionadded:: 0.8.3 - distinct_target_key allows the
+             subquery eager loader to apply a DISTINCT modifier to the
+             innermost SELECT.
+
+          .. versionchanged:: 0.9.0 - distinct_target_key now defaults to
+             ``None``, so that the feature enables itself automatically for
+             those cases where the innermost query targets a non-unique
+             key.
+
         :param doc:
           docstring which will be applied to the resulting descriptor.
 
@@ -373,27 +394,6 @@ class RelationshipProperty(StrategizedProperty):
           or when the reference is one-to-one or a collection that is guaranteed
           to have one or at least one entry.
 
-        :param distinct_target_key=None:
-          Indicate if a "subquery" eager load should apply the DISTINCT
-          keyword to the innermost SELECT statement.  When left as ``None``,
-          the DISTINCT keyword will be applied in those cases when the target
-          columns do not comprise the full primary key of the target table.
-          When set to ``True``, the DISTINCT keyword is applied to the innermost
-          SELECT unconditionally.
-
-          It may be desirable to set this flag to False when the DISTINCT is
-          reducing performance of the innermost subquery beyond that of what
-          duplicate innermost rows may be causing.
-
-          .. versionadded:: 0.8.3 - distinct_target_key allows the
-             subquery eager loader to apply a DISTINCT modifier to the
-             innermost SELECT.
-
-          .. versionchanged:: 0.9.0 - distinct_target_key now defaults to
-             ``None``, so that the feature enables itself automatically for
-             those cases where the innermost query targets a non-unique
-             key.
-
         :param join_depth:
           when non-``None``, an integer value indicating how many levels
           deep "eager" loaders should join on a self-referring or cyclical