.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Alzabo::Create::Column 3pm"
.TH Alzabo::Create::Column 3pm "2015-05-24" "perl v5.20.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Alzabo::Create::Column \- Column objects for use in schema creation
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Alzabo::Create::Column;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This object represents a column.  It holds data specific to a column.
Additional data is held in a
\&\f(CW\*(C`Alzabo::Create::ColumnDefinition\*(C'\fR
object, which is used to allow two columns to share a type (which is
good when two columns in different tables are related as it means that
if the type of one is changed, the other is also.)
.SH "INHERITS FROM"
.IX Header "INHERITS FROM"
\&\f(CW\*(C`Alzabo::Column\*(C'\fR
.PP
Note: all relevant documentation from the superclass has been merged into this document.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
The constructor accepts the following parameters:
.IP "\(bu" 4
table => \f(CW\*(C`Alzabo::Create::Table\*(C'\fR object
.IP "\(bu" 4
name => \f(CW$name\fR
.IP "\(bu" 4
nullable => 0 or 1 (optional)
.Sp
Defaults to false.
.IP "\(bu" 4
sequenced => 0 or 1 (optional)
.Sp
Defaults to false.
.IP "\(bu" 4
default => \f(CW$default\fR (optional)
.IP "\(bu" 4
default_is_raw => \f(CW$boolean\fR (optional)
.Sp
If \*(L"default_is_raw\*(R" is true, then it will not be quoted when passed to
the \s-1DBMS\s0 in \s-1SQL\s0 statements. This should be used to allow a default
which is a function, like \f(CW\*(C`NOW()\*(C'\fR.
.IP "\(bu" 4
attributes => \e@attributes (optional)
.IP "\(bu" 4
length => \f(CW$length\fR (optional)
.IP "\(bu" 4
precision => \f(CW$precision\fR (optional)
.Sp
One of either ...
.IP "\(bu" 4
type => \f(CW$type\fR
.Sp
\&... or ...
.IP "\(bu" 4
definition => \f(CW\*(C`Alzabo::Create::ColumnDefinition\*(C'\fR object
.IP "\(bu" 4
comment => \f(CW$comment\fR
.Sp
An optional comment.
.PP
It returns a new \f(CW\*(C`Alzabo::Create::Column\*(C'\fR object.
.PP
Throws: \f(CW\*(C`Alzabo::Exception::Params\*(C'\fR
.SS "type"
.IX Subsection "type"
Returns the column's type as a string.
.SS "alter"
.IX Subsection "alter"
This method allows you to change a column's type, length, and
precision as a single operation.  It should be instead of calling
\&\f(CW\*(C`set_type()\*(C'\fR followed by \f(CW\*(C`set_length()\*(C'\fR.
.PP
It takes the following parameters:
.IP "\(bu" 4
type => \f(CW$type\fR
.IP "\(bu" 4
length => \f(CW$length\fR (optional)
.IP "\(bu" 4
precision => \f(CW$precision\fR (optional)
.PP
Throws: \f(CW\*(C`Alzabo::Exception::Params\*(C'\fR,
\&\f(CW\*(C`Alzabo::Exception::RDBMSRules\*(C'\fR
.SS "set_type ($type)"
.IX Subsection "set_type ($type)"
Sets the column's type.
.PP
Throws: \f(CW\*(C`Alzabo::Exception::Params\*(C'\fR,
\&\f(CW\*(C`Alzabo::Exception::RDBMSRules\*(C'\fR
.ie n .SS "set_table (""Alzabo::Create::Table"" object)"
.el .SS "set_table (\f(CWAlzabo::Create::Table\fP object)"
.IX Subsection "set_table (Alzabo::Create::Table object)"
Sets the \f(CW\*(C`Alzabo::Create::Table\*(C'\fR object in
which this column is located.
.PP
Throws: \f(CW\*(C`Alzabo::Exception::Params\*(C'\fR
.SS "name"
.IX Subsection "name"
Returns the column's name as a string.
.SS "set_name ($name)"
.IX Subsection "set_name ($name)"
Sets the column's name (a string).
.PP
Throws: \f(CW\*(C`Alzabo::Exception::Params\*(C'\fR,
\&\f(CW\*(C`Alzabo::Exception::RDBMSRules\*(C'\fR
.SS "nullable"
.IX Subsection "nullable"
Returns a boolean value indicating whether or not NULLs are allowed in
this column.
.SS "set_nullable (0 or 1)"
.IX Subsection "set_nullable (0 or 1)"
Sets the nullability of the column (this determines whether nulls are
allowed in the column or not).  Must be 0 or 1.
.PP
Throws: \f(CW\*(C`Alzabo::Exception::Params\*(C'\fR
.SS "attributes"
.IX Subsection "attributes"
A column's attributes are strings describing the column (for example,
valid attributes in MySQL are '\s-1UNSIGNED\s0' or '\s-1ZEROFILL\s0'.
.PP
This method returns a list of strings of such strings.
.SS "has_attribute"
.IX Subsection "has_attribute"
This method can be used to test whether or not a column has a
particular attribute.  By default, the check is case-insensitive.
.PP
It takes the following parameters:
.IP "\(bu" 4
attribute => \f(CW$attribute\fR
.IP "\(bu" 4
case_sensitive => 0 or 1 (defaults to 0)
.PP
It returns a boolean value indicating whether or not the column has
this particular attribute.
.SS "set_attributes (@attributes)"
.IX Subsection "set_attributes (@attributes)"
Sets the column's attributes.  These are strings describing the column
(for example, valid attributes in MySQL are \*(L"\s-1PRIMARY KEY\*(R"\s0 or
\&\*(L"\s-1AUTO_INCREMENT\*(R"\s0).
.PP
Throws: \f(CW\*(C`Alzabo::Exception::RDBMSRules\*(C'\fR
.SS "add_attribute ($attribute)"
.IX Subsection "add_attribute ($attribute)"
Add an attribute to the column's list of attributes.
.PP
Throws: \f(CW\*(C`Alzabo::Exception::RDBMSRules\*(C'\fR
.SS "delete_attribute ($attribute)"
.IX Subsection "delete_attribute ($attribute)"
Delete the given attribute from the column's list of attributes.
.PP
Throws: Throws: \f(CW\*(C`Alzabo::Exception::Params\*(C'\fR,
\&\f(CW\*(C`Alzabo::Exception::RDBMSRules\*(C'\fR
.SS "default"
.IX Subsection "default"
Returns the default value of the column as a string, or undef if there
is no default.
.SS "set_default ($default)"
.IX Subsection "set_default ($default)"
Sets the column's default value.
.SS "length"
.IX Subsection "length"
Returns the length attribute of the column, or undef if there is none.
.SS "precision"
.IX Subsection "precision"
Returns the precision attribute of the column, or undef if there is
none.
.SS "set_length"
.IX Subsection "set_length"
This method takes the following parameters:
.IP "\(bu" 4
length => \f(CW$length\fR
.IP "\(bu" 4
precision => \f(CW$precision\fR (optional)
.PP
This method sets the column's length and precision.  The precision
parameter is optional (though some column types may require it if the
length is set).
.PP
Throws: \f(CW\*(C`Alzabo::Exception::RDBMSRules\*(C'\fR
.SS "sequenced"
.IX Subsection "sequenced"
The meaning of a sequenced column varies from one \s-1RDBMS\s0 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 \s-1AUTO_INCREMENT\s0
attribute, in Sybase the identity attribute).
.PP
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
\&\f(CW\*(C`Alzabo::Runtime::Table\->insert\*(C'\fR.
.PP
Returns a boolean value indicating whether or not this column is
sequenced.
.SS "set_sequenced (0 or 1)"
.IX Subsection "set_sequenced (0 or 1)"
Sets the value of the column's sequenced attribute.
.PP
Throws: \f(CW\*(C`Alzabo::Exception::Params\*(C'\fR,
\&\f(CW\*(C`Alzabo::Exception::RDBMSRules\*(C'\fR
.SS "is_primary_key"
.IX Subsection "is_primary_key"
Returns a boolean value indicating whether or not this column is part
of its table's primary key.
.SS "is_numeric"
.IX Subsection "is_numeric"
Returns a boolean value indicating whether the column is a numeric
type column.
.SS "is_character"
.IX Subsection "is_character"
Returns a boolean value indicating whether the column is a character
type column.
.PP
This is true only for any columns which are defined to hold \fItext\fR
data, regardless of size.
.SS "is_blob"
.IX Subsection "is_blob"
Returns a boolean value indicating whether the column is a blob
column.
.PP
This is true for any columns defined to hold binary data, regardless
of size.
.SS "definition"
.IX Subsection "definition"
The definition object is very rarely of interest.  Use the
\&\f(CW\*(C`type()\*(C'\fR method if you are only interested in the column's
type.
.PP
This methods returns the
\&\f(CW\*(C`Alzabo::Create::ColumnDefinition\*(C'\fR object which
holds this column's type information.
.ie n .SS "set_definition (""Alzabo::Create::ColumnDefinition"" object)"
.el .SS "set_definition (\f(CWAlzabo::Create::ColumnDefinition\fP object)"
.IX Subsection "set_definition (Alzabo::Create::ColumnDefinition object)"
Sets the
\&\f(CW\*(C`Alzabo::Create::ColumnDefinition\*(C'\fR
object which holds this column's type information.
.SS "former_name"
.IX Subsection "former_name"
If the column's name has been changed since the last time the schema
was instantiated, this method returns the column's previous name.
.SS "comment"
.IX Subsection "comment"
Returns the comment associated with the column object, if any.
.SS "set_comment ($comment)"
.IX Subsection "set_comment ($comment)"
Set the comment for the column object.