- active_history flag also added to composite().

The flag has no effect in 0.6, but is instead
a placeholder flag for forwards compatibility,
as it will be needed in 0.7 for composites.
[ticket:1976]

1 files changed, 9 insertions, 0 deletions

diff --git a/lib/sqlalchemy/orm/__init__.py b/lib/sqlalchemy/orm/__init__.py
index b51142909..94fbabc49 100644
--- a/lib/sqlalchemy/orm/__init__.py
+++ b/lib/sqlalchemy/orm/__init__.py
@@ -648,6 +648,15 @@ def composite(class_, *cols, **kwargs):
     :param \*cols:
       List of Column objects to be mapped.
 
+    :param active_history=False:
+      When ``True``, indicates that the "previous" value for a
+      scalar attribute should be loaded when replaced, if not
+      already loaded.  Note that attributes generated by 
+      :func:`.composite` properties load the "previous" value
+      in any case, however this is being changed in 0.7, 
+      so the flag is introduced here for forwards compatibility.
+      (new in 0.6.6)
+
     :param group:
       A group name for this property when marked as deferred.