Alzabo::Create::Table - Table objects for schema creation
use Alzabo::Create::Table;
This class represents tables in the schema. It contains column, index, and foreign key objects.
Alzabo::Table
The constructor takes the following parameters:
schema => Alzabo::Create::Schema object
Alzabo::Create::Schema
The schema to which this table belongs.
name => $name
attributes => \@attributes
comment => $comment
An optional comment.
It returns a new Alzabo::Create::Table object.
Alzabo::Create::Table
Throws: Alzabo::Exception::Params
Alzabo::Exception::Params
Changes the name of the table.
Throws: Alzabo::Exception::Params, Alzabo::Exception::RDBMSRules
Alzabo::Exception::RDBMSRules
Creates a new Alzabo::Create::Column object and adds it to the table. This object is the function's return value.
Alzabo::Create::Column
In addition, if a "before" or "after" parameter is given, the move_column() method is called to move the new column.
move_column()
This method takes all of the same parameters as the Alzabo::Create::Column->new() method except the "table" parameter, which is automatically supplied.
Alzabo::Create::Column->new()
This method also accepts an additional parameter, "primary_key", indicating whether or not the column is part of the table's primary key.
Returns a new Alzabo::Create::Column object.
Adds a column to the table. If a "before" or "after" parameter is given then the move_column() method will be called to move the new column to the appropriate position.
It takes the following parameters:
column => Alzabo::Create::Column object
after => Alzabo::Create::Column object (optional)
... or ...
before => Alzabo::Create::Column object (optional)
Deletes a column from the table.
This method takes the following parameters:
The column to move.
and either ...
before => Alzabo::Create::Column object
Move the column before this column
after => Alzabo::Create::Column object
Move the column after this column.
Make the given column part of the table's primary key. The primary key is an ordered list of columns. The given column will be added to the end of this list.
Delete the given column from the primary key.
Takes the same parameters as the Alzabo::Create::ForeignKey->new method except for the table parameter, which is automatically added. The foreign key object that is created is then added to the table.
Alzabo::Create::ForeignKey->new
If the foreign key being made is 1..1 or 1..n, then a unique index will be created on the columns involved in the "1" side of the foreign key, unless they are the table's primary key.
Returns a new Alzabo::Create::ForeignKey object.
Alzabo::Create::ForeignKey
Adds the given foreign key to the table.
Deletes the given foreign key from the table
Takes the same parameters as the Alzabo::Create::Index->new() method except for the "table" parameter, which is automatically added. The index object that is created is then added to the table.
Alzabo::Create::Index->new()
Returns the new Alzabo::Create::Index object.
Alzabo::Create::Index
Adds the given index to the table.
Deletes the specified index from the table.
Sets the tables's attributes. These are strings describing the table (for example, valid attributes in MySQL are "TYPE = INNODB" or "AUTO_INCREMENT = 100").
You can also set table constraints as attributes. Alzabo will generate correct SQL for both actual attributes and constraints.
Add an attribute to the column's list of attributes.
Delete the given attribute from the column's list of attributes.
If the table's name has been changed since the last time the schema was instantiated, this method returns the table's previous name.
Set the comment for the table object.
Dave Rolsky, <autarch@urth.org>
To install Alzabo, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Alzabo
CPAN shell
perl -MCPAN -e shell install Alzabo
For more information on module installation, please visit the detailed CPAN module installation guide.