From: Mike Bayer <mike_mp@zzzcomputing.com>
Date: Mon, 20 Feb 2006 16:34:02 +0000 (+0000)
Subject: made 'assign_mapper' doc more explicit
X-Git-Tag: rel_0_1_1~13
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6811d3c8524e092e6f2dcf2d1eb85df5ae38cf4a;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git

made 'assign_mapper' doc more explicit
added doc for overriding properties
---

diff --git a/doc/build/content/datamapping.myt b/doc/build/content/datamapping.myt
index 51bdff878d..acaad80267 100644
--- a/doc/build/content/datamapping.myt
+++ b/doc/build/content/datamapping.myt
@@ -58,6 +58,7 @@ UPDATE users SET user_name=:user_name
         
         
     </&>
+    <&|doclib.myt:item, name="attaching", description="Attaching Mappers to their Class"&>
     <p>For convenience's sake, the Mapper can be attached as an attribute on the class itself as well:</p>
         <&|formatting.myt:code&>
             User.mapper = mapper(User, users)
@@ -70,6 +71,25 @@ UPDATE users SET user_name=:user_name
         userlist = User.select_by(user_id=12)
     </&>
     <p>Other methods of associating mappers and finder methods with their corresponding classes, such as via common base classes or mixins, can be devised as well.  SQLAlchemy does not aim to dictate application architecture and will always allow the broadest variety of architectural patterns, but may include more helper objects and suggested architectures in the future.</p>
+    </&>
+    <&|doclib.myt:item, name="overriding", description="Overriding Properties"&>
+    <p>A common request is the ability to create custom class properties that override the behavior of setting/getting an attribute.  Currently, the easiest way to do this in SQLAlchemy is just how its done normally; define your attribute with a different name, such as "_attribute", and use a property to get/set its value.  The mapper just needs to be told of the special name:</p>
+    <&|formatting.myt:code&>
+        class MyClass(object):
+            def _set_email(self, email):
+                self._email = email
+            def _get_email(self, email):
+                return self._email
+            email = property(_get_email, _set_email)
+            
+        m = mapper(MyClass, mytable, properties = {
+                # map the '_email' attribute to the "email" column
+                # on the table
+                '_email': mytable.c.email
+        })
+    </&>
+    <p>In a later release, SQLAlchemy will also allow _get_email and _set_email to be attached directly to the "email" property created by the mapper, and will also allow this association to occur via decorators.</p>
+    </&>
 </&>
 <&|doclib.myt:item, name="selecting", description="Selecting from a Mapper" &>
     <p>There are a variety of ways to select from a mapper.  These range from minimalist to explicit.  Below is a synopsis of the these methods:</p>