Freeside:Documentation:Developer:Schema changes

From Freeside
Revision as of 09:02, 17 July 2013 by Ivan (talk | contribs) (→‎Skeleton class autogeneration)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Schema.pm

  • Required
  • Edit the big data structure in FS/FS/Schema.pm and add your tables and columns
  • The upgrade script will automatically handle new tables as well as new columns, removed columns and changes to columns and indices.

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. Use the -n option if you prefer not to have Mason load the table module.
  • Edit the resulting FS/FS/table.pm
  • FS/MANIFEST is updated and FS/t/table.t is added. Don't forget to git add FS/FS/table.pm and FS/t/table.t and commit them.

Required Documentation

  • For new tables: add to FS/FS.pm

Optional: Documentation looking for adopters or innovative autogeneration

  • somehwat neglected: httemplate/docs/schema.html
  • really neglected: httemplate/docs/schema.dia
Retrieved from "http://secure.freeside.biz/mediawiki/index.php?title=Freeside:Documentation:Developer:Schema_changes&oldid=7630"