From: Thierry Parmentelat <thierry.parmentelat@inria.fr>
Date: Sat, 9 Nov 2013 09:25:45 +0000 (+0100)
Subject: start a readme on this move
X-Git-Tag: sfa-3.1-1~42^2~8
X-Git-Url: http://git.onelab.eu/?p=sfa.git;a=commitdiff_plain;h=14ff8828c844ead5b511ec6f12653795efe36d9c

start a readme on this move
---

diff --git a/docs/dbsession.readme b/docs/dbsession.readme
new file mode 100644
index 00000000..db453422
--- /dev/null
+++ b/docs/dbsession.readme
@@ -0,0 +1,13 @@
+As of Nov. 2013, when moving from 3.0 to 3.2
+--------------------------------------------
+
+* driver-creation
+. expect an api instead of a config (and api.config is set)
+
+* managers
+. cannot access their driver from self, but from the context (api is passed to methods)
+
+* dbsession
+. use api.dbsession() whenever possible
+. it's fair to have importers and sfaadmin use the global session (there won't be instances of api in their case)
+. there is one or 2 exceptions where dbsession is retrieved from an sqlalchemy object but this is deemed poor practice, please DO NOT do this as far as possible