Difference between revisions of "Freeside:1.7:Documentation:Developer:Schema changes"

From Freeside
Jump to: navigation, search
(Schema.pm)
(Skeleton class autogeneration)
Line 16: Line 16:
 
* From the root freeside directory, run <code>bin/generate-table-module <i>tablename</i></code> for each table.
 
* From the root freeside directory, run <code>bin/generate-table-module <i>tablename</i></code> for each table.
 
* Edit the resulting FS/FS/table.pm
 
* Edit the resulting FS/FS/table.pm
* FS/MANIFEST is updated and FS/t/table.t is added. Don't forget to cvs add FS/t/table.t and check them in.
+
* FS/MANIFEST is updated and FS/t/table.t is added. Don't forget to cvs add FS/FS/table.pm and FS/t/table.t and check them in.
  
 
=== Optional: Documentation looking for adopters or innovative autogeneration ===
 
=== Optional: Documentation looking for adopters or innovative autogeneration ===

Revision as of 13:59, 13 September 2006

Schema.pm

  • Required
  • Edit the big data structure in FS/FS/Schema.pm and add your tables and columns

Essential documentation

  • Required if the changes are something other than table or column additions - add a quick note to the upgrade instructions
  • README.1.7.X
  • httemplate/docs/update10.html

Skeleton class autogeneration

  • For new tables. Optional but recommended. We're trying to save you work!
  • Make sure the tables have been added to FS/FS/Schema.pm and run make install-perl-modules
  • From the root freeside directory, run bin/generate-table-module tablename for each table.
  • Edit the resulting FS/FS/table.pm
  • FS/MANIFEST is updated and FS/t/table.t is added. Don't forget to cvs add FS/FS/table.pm and FS/t/table.t and check them in.

Optional: Documentation looking for adopters or innovative autogeneration

  • sorta neglected: FS/FS.pm
  • somehwat neglected: httemplate/docs/schema.html
  • really neglected: httemplate/docs/schema.dia