Webware for Python

Update of /cvsroot/webware/Webware/MiddleKit/Docs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv17967/Docs

Modified Files:
	RelNotes-X.Y.html UsersGuide.html 
Log Message:
- change the default primary key serial number column name to 'serialNum'
- added a new setting, SQLSerialColumnName, that controls that


Index: RelNotes-X.Y.html
===================================================================
RCS file: /cvsroot/webware/Webware/MiddleKit/Docs/RelNotes-X.Y.html,v
retrieving revision 1.8
retrieving revision 1.9
diff -C2 -d -r1.8 -r1.9
*** RelNotes-X.Y.html	28 Feb 2004 03:25:29 -0000	1.8
--- RelNotes-X.Y.html	1 Mar 2004 01:44:34 -0000	1.9
***************
*** 30,37 ****
  
  <a name=Incompatible><h2>Incompatible Changes</h2></a>
  <ul>
! 	<li> <font color=red>There are some MiddleKit improvements that break compatibility with previous versions of MiddleKit, although all are easy to address. Read below.</font>
  </ul>
  
  <h3>Obj Ref Columns</h3>
  
--- 30,48 ----
  
  <a name=Incompatible><h2>Incompatible Changes</h2></a>
+ 
+ <p> <font color=red>There are some MiddleKit improvements that break compatibility with previous versions of MiddleKit, although all are easy to address.</font> In a nutshell, if you are upgrading MiddleKit for an existing project, take the following steps:
+ 
  <ul>
! 	<li> Add these to Settings.config inside the model:
! <pre>{
! 	'SQLSerialColumnName': '%(className)sId',
! 	'UseBigIntObjRefColumns': True,
! }</pre>
! 	<li> If your model has a SQLGenerator.config file, move its contents to Settings.config.
! 	<li> If you use Microsoft SQL Server and your model uses the float type then read the section below detailing that.
  </ul>
  
+ <p> Below are more details about the incompatible changes. Below that are more general notes on this release.
+ 
  <h3>Obj Ref Columns</h3>
  
***************
*** 45,48 ****
--- 56,63 ----
  
  
+ <h3>Serial Number Column</h3>
+ 
+ <p> MiddleKit creates a SQL table for every concrete class, and each table has a column for the serial number of a record. This column is the primary key for the table. Its new default name is <span class=name>serialNum</span> which matches the MiddleObject method of the same name and fits MiddleKit naming conventions. You can control this with a <a href=UsersGuide.html#Configuration_SQLSerialColumnName>new setting</a>.
+ 
  <h3>SQLGenerator.config</h3>
  

Index: UsersGuide.html
===================================================================
RCS file: /cvsroot/webware/Webware/MiddleKit/Docs/UsersGuide.html,v
retrieving revision 1.26
retrieving revision 1.27
diff -C2 -d -r1.26 -r1.27
*** UsersGuide.html	28 Feb 2004 01:20:31 -0000	1.26
--- UsersGuide.html	1 Mar 2004 01:44:34 -0000	1.27
***************
*** 313,316 ****
--- 313,324 ----
  
  
+ <p> <a name=Configuration_SQLSerialColumnName></a> The <span class=name>SQLSerialColumnName</span> controls the name that is used for the serial number of a given database record, which is also the primary key. The default is 'serialNum' which matches MiddleKit naming conventions. You can change this:
+ 
+ <pre>{
+     'SQLSerialColumnName': 'SerialNum',  # capitalized, or
+     'SQLSerialColumnName': '%(className)sId',  # the name used by older MiddleKits
+         # you can use className for lower, ClassName for upper, or _ClassName for as-is
+ }</pre>
+ 
  <p> <a name=Configuration_ObjRefSuffixes></a> The <span class=name>ObjRefSuffixes</span> controls the suffixes that are appended for the names of the two SQL column that are created for each obj ref attribute. The suffixes must be different from each other.