Take me over?
NAME
Alzabo::Column - Column objects
SYNOPSIS
use Alzabo::Column;
foreach my $c ($table->columns)
{
print $c->name;
}
DESCRIPTION
This object represents a column. It holds data specific to a column.
METHODS
table
Returns
The table object in which this column is located.
name
Returns
The column's name as a string.
nullable
Returns
A boolean value indicating whether or not NULLs are allowed in this column.
attributes
A column's attributes are strings describing the column (for example, valid attributes in MySQL are 'UNSIGNED' or 'ZEROFILL'.
Returns
A list of strings.
has_attribute
Parameters:
This method can be used to test whether or not a column has a particular attribute. By default, the check is case-insensitive.
attribute => $attribute
case_sensitive => 0 or 1 (defaults to 0)
Returns
A boolean value indicating whether or not the column has this particular attribute.
type
Returns
The column's type as a string.
sequenced
The meaning of a sequenced column varies from one RDBMS to another. In those with sequences, it means that a sequence is created and that values for this column will be drawn from it for inserts into this table. In databases without sequences, the nearest analog for a sequence is used (in MySQL the column is given the AUTO_INCREMENT attribute, in Sybase the identity attribute).
In general, this only has meaning for the primary key column of a table with a single column primary key. Setting the column as sequenced means its value never has to be provided to when calling Alzabo::Runtime::Table->insert
.
Returns
A boolean value indicating whether or not this column is sequenced.
default
Returns
The default value of the column as a string, or undef if there is no default.
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.
is_primary_key
Returns
A boolean value indicating whether or not this column is part of its table's primary key.
is_numeric
Returns
A boolean value indicating whether the column is a numeric type column.
is_character
Returns
A boolean value indicating whether the column is a character type column.
is_blob
Returns
A boolean value indicating whether the column is a blob column.
definition
The definition object is very rarely of interest. Use the type
method if you are only interested in the column's type.
Returns
The Alzabo::ColumnDefinition
object which holds this column's type information.
AUTHOR
Dave Rolsky, <autarch@urth.org>