Doc index

NAME

Alzabo::Create::ColumnDefinition - Column definition object for schema creation

SYNOPSIS

  use Alzabo::Create::ColumnDefinition;

DESCRIPTION

This object holds information on a column that might need to be shared with another column. The reason this class exists is that if a column is a key in two or more tables, then some of the information related to that column should change automatically in multiple places whenever it changes at all. Right now this is only type ('VARCHAR', 'NUMBER', etc) and length/precision information. This object also has an 'owner', which is the column which created it.

INHERITS FROM

Alzabo::ColumnDefinition

Note: all relevant documentation from the superclass has been merged into this document.

METHODS

new

This method takes the following parameters:

• owner => Alzabo::Create::ColumnDefinition object
• type => $type

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

alter

See the Alzabo::Column->alter() method for details.

type

Returns the object's type as a string.

set_type ($string)

Sets the object's type.

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

length

Returns the length attribute of the column, or undef if there is none.

precision

Returns the precision attribute of the column, or undef if there is none.

set_length

This method takes the following parameters:

• length => $length
• precision => $precision (optional)

Sets the column's length and precision. The precision parameter is optional (though some column types may require it if the length is set).

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

owner

Returns the Alzabo::Create::Column object that owns this definitions (the column that created it).

Table of Contents