Freeside:3:Documentation:Developer/FS/Schema

NAME

FS::Schema - Freeside database schema

SYNOPSYS

   use FS::Schema qw(dbdef dbdef_dist reload_dbdef);

   $dbdef = reload_dbdef;
   $dbdef = reload_dbdef "/non/standard/filename";
   $dbdef = dbdef;
   $dbdef_dist = dbdef_dist;

DESCRIPTION

This class represents the database schema.

METHODS

reload_dbdef([FILENAME])

Load a database definition (see DBIx::DBSchema), optionally from a non-default filename. This command is executed at startup unless $FS::Schema::setup_hack is true. Returns a DBIx::DBSchema object.

dbdef

Returns the current database definition (represents the current database, assuming it is up-to-date). See DBIx::DBSchema.

dbdef_dist [ DATASRC ]

Returns the current canoical database definition as defined in this file.

Optionally, pass a DBI data source to enable syntax specific to that database. Currently, this enables "ENGINE=InnoDB" for MySQL databases.