Changes between Version 4 and Version 5 of DeveloperGuidelinesS3Framework

Timestamp:

01/15/09 22:19:30 (16 years ago)

Author:

Fran Boon

Comment:

Update to current API

DeveloperGuidelinesS3Framework

@@ -29 +29 @@
   return dict(module_name=module_name,modules=modules,options=options)
 
+All tables which are user-editable need to be protected for conflict resolution & synchronization using the predefined fields {{{timestamp}}} & {{{uuidstamp}}}.[[BR]]
+These are defined in {{{models/__db.py}}}:
+{{{
+# Define 'now'
+# 'modified_on' fields used by T2 to do edit conflict-detection & by DBSync to check which is more recent
+now=datetime.datetime.today()
+
+# Reusable timestamp fields
+timestamp=SQLTable(None,'timestamp',
+            SQLField('created_on','datetime',
+                          writable=False,
+                          default=request.now),
+            SQLField('modified_on','datetime',
+                          writable=False,
+                          default=request.now,update=request.now)) 
+
+# We need UUIDs as part of database synchronization
+import uuid
+uuidstamp=SQLTable(None,'uuidstamp',
+            SQLField('uuid',length=64,
+                          writable=False,
+                          default=uuid.uuid4()))
+}}}
+
 === Optional ===
-List output can be made more functional by this .represent 'widget':
+List output are made more functional by this .represent 'widget':
 {{{
 def shn_list_item(table,resource,action,display='table.name',extra=None):
@@ -39 +63 @@
     return DIV(*items)
 }}}
-You can use it in {{{models/module.py}}} like:
+This is called in {{{models/__db.py}}} in the RESTlike Controller:
 {{{
-db.or_organisation.represent=lambda table:shn_list_item(table,resource='organisation',action='display')
 db.person.represent=lambda table:shn_list_item(table,resource='person',action='display',display='table.full_name')
-db.gis_projection.represent=lambda table:shn_list_item(table,resource='projection',action='display',extra='table.epsg')
 }}}
 
@@ -52 +74 @@
    {{{SQLField('field','text'),}}}
 
-Form field can be made to use a SELECT dropdown by setting the field as a lookup to another table...linked to the 'uuid' field to allow [wiki:DeveloperGuidelinesDatabaseSynchronization Database Synchronization], but displaying a more user-friendly field (such as 'name'):
+Form field can be made to use a SELECT dropdown by setting the field as a lookup to another table...linked to the 'id' field to allow [wiki:DeveloperGuidelinesDatabaseSynchronization Database Synchronization], but displaying a more user-friendly field (such as 'name'):
 {{{
-SQLField('field',length=64),
+SQLField('field',dn.othertable),
 
-db.table.field.requires=IS_NULL_OR(IS_IN_DB(db,'othertable.uuid','othertable.name'))
+db.table.field.requires=IS_NULL_OR(IS_IN_DB(db,'othertable.id','othertable.name'))
 }}}
 
@@ -88 +110 @@
 e.g. session.s3.debug & session.s3.self_registration are made available to the default {{{layout.html}}} this way.
 
-If you wish to clean out all settings to import afresh, then close down Web2Py & start up in shell mode:
-{{{
-python web2py.py -S sahana -M
-}}}
-Then run:
-{{{
-shn_db_clean(db)
-}}}
-(This function is configured in {{{modules/sahana.py}}})
-
+If you wish to clean out all settings to import afresh, then close down Web2Py & delete all files from {{{/databases}}})
 
 Modules can set up their own configuration settings tables in a similar way (e.g. GIS does this)
@@ -108 +121 @@
 We use T2 to handle this for us.
 
-Add this field to each table which needs protecting (in {{{models/db.py}}}):
+Add this field to each table which needs protecting (in {{{models/module.py}}}):
 {{{
-SQLField('modified_on','datetime'), # Used by T2 to do edit conflict-detection
+timestamp
 }}}