Dave Rolsky > Alzabo > Alzabo::Create::Table

Download:
Alzabo-0.92.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  4
Open  1
View/Report Bugs
Module Version: 2   Source  

NAME ^

Alzabo::Create::Table - Table objects for schema creation

SYNOPSIS ^

  use Alzabo::Create::Table;

DESCRIPTION ^

This class represents tables in the schema. It contains column, index, and foreign key objects.

INHERITS FROM ^

Alzabo::Table

METHODS ^

new

The constructor takes the following parameters:

It returns a new Alzabo::Create::Table object.

Throws: Alzabo::Exception::Params

set_name ($name)

Changes the name of the table.

Throws: Alzabo::Exception::Params, Alzabo::Exception::RDBMSRules

make_column

Creates a new Alzabo::Create::Column object and adds it to the table. This object is the function's return value.

In addition, if a "before" or "after" parameter is given, the move_column() method is called to move the new column.

This method takes all of the same parameters as the Alzabo::Create::Column->new() method except the "table" parameter, which is automatically supplied.

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.

Throws: Alzabo::Exception::Params, Alzabo::Exception::RDBMSRules

add_column

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:

Throws: Alzabo::Exception::Params, Alzabo::Exception::RDBMSRules

delete_column (Alzabo::Create::Column object)

Deletes a column from the table.

Throws: Alzabo::Exception::Params

move_column

This method takes the following parameters:

Throws: Alzabo::Exception::Params

add_primary_key (Alzabo::Create::Column object)

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.

Throws: Alzabo::Exception::Params

delete_primary_key (Alzabo::Create::Column object)

Delete the given column from the primary key.

Throws: Alzabo::Exception::Params

make_foreign_key (see below)

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.

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.

Throws: Alzabo::Exception::Params

add_foreign_key (Alzabo::Create::ForeignKey object)

Adds the given foreign key to the table.

Throws: Alzabo::Exception::Params

delete_foreign_key (Alzabo::Create::ForeignKey object)

Deletes the given foreign key from the table

Throws: Alzabo::Exception::Params

make_index

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.

Returns the new Alzabo::Create::Index object.

Throws: Alzabo::Exception::Params

add_index (Alzabo::Create::Index object)

Adds the given index to the table.

Throws: Alzabo::Exception::Params

delete_index (Alzabo::Create::Index object)

Deletes the specified index from the table.

Throws: Alzabo::Exception::Params

set_attributes (@attributes)

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_attribute ($attribute)

Add an attribute to the column's list of attributes.

delete_attribute ($attribute)

Delete the given attribute from the column's list of attributes.

Alzabo::Exception::Params

former_name

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_comment ($comment)

Set the comment for the table object.

AUTHOR ^

Dave Rolsky, <autarch@urth.org>

syntax highlighting: