.\" 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::Table 3pm"
.TH Alzabo::Table 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::Table \- Table objects
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Alzabo::Table;
\&
\&  my $t = $schema\->table(\*(Aqfoo\*(Aq);
\&
\&  foreach $pk ($t\->primary_keys)
\&  {
\&     print $pk\->name;
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Objects in this class represent tables.  They contain foreign key,
index, and column objects.
.SH "METHODS"
.IX Header "METHODS"
.SS "schema"
.IX Subsection "schema"
Returns the \f(CW\*(C`Alzabo::Schema\*(C'\fR object to which this
table belongs.
.SS "name"
.IX Subsection "name"
Returns the name of the table.
.SS "column ($name)"
.IX Subsection "column ($name)"
Returns the \f(CW\*(C`Alzabo::Column\*(C'\fR object that matches
the name given.
.PP
An \f(CW\*(C`Alzabo::Exception::Params\*(C'\fR exception is
throws if the table does not contain the column.
.SS "columns (@optional_list_of_column_names)"
.IX Subsection "columns (@optional_list_of_column_names)"
If no arguments are given, returns a list of all
\&\f(CW\*(C`Alzabo::Column\*(C'\fR objects in the schema, or in a
scalar context the number of such tables.  If one or more arguments
are given, returns a list of table objects with those names, in the
same order given.
.PP
An \f(CW\*(C`Alzabo::Exception::Params\*(C'\fR exception is
throws if the table does not contain one or more of the specified
columns.
.SS "has_column ($name)"
.IX Subsection "has_column ($name)"
Returns a voolean value indicating whether the column exists in the
table.
.SS "primary_key"
.IX Subsection "primary_key"
In array context, return an ordered list of column objects that make
up the primary key for the table.  In scalar context, it returns the
first element of that list.
.SS "primary_key_size"
.IX Subsection "primary_key_size"
The number of columns in the table's primary key.
.ie n .SS "column_is_primary_key (""Alzabo::Column"" object)"
.el .SS "column_is_primary_key (\f(CWAlzabo::Column\fP object)"
.IX Subsection "column_is_primary_key (Alzabo::Column object)"
Returns a boolean value indicating whether the column given is part of
the table's primary key.
.PP
This method is really only needed if you're not sure that the column
belongs to the table.  Otherwise just call the
\&\f(CW\*(C`Alzabo::Column\->is_primary_key\*(C'\fR
method on the column object.
.SS "attributes"
.IX Subsection "attributes"
A table's attributes are strings describing the table (for example,
valid attributes in MySQL are thing like \*(L"\s-1TYPE\s0 = \s-1INNODB\*(R".\s0
.PP
Returns a list of strings.
.SS "has_attribute"
.IX Subsection "has_attribute"
This method can be used to test whether or not a table has a
particular attribute.  By default, the check is case-insensitive.
.IP "\(bu" 4
attribute => \f(CW$attribute\fR
.IP "\(bu" 4
case_sensitive => 0 or 1 (defaults to 0)
.PP
Returns a boolean value indicating whether the table has this
particular attribute.
.SS "foreign_keys"
.IX Subsection "foreign_keys"
Thie method takes two parameters:
.IP "\(bu" 4
column => \f(CW\*(C`Alzabo::Column\*(C'\fR object
.IP "\(bu" 4
table  => \f(CW\*(C`Alzabo::Table\*(C'\fR object
.PP
It returns a list of \f(CW\*(C`Alzabo::ForeignKey\*(C'\fR
objects \fBfrom\fR the given column \fBto\fR the given table, if they exist.
In scalar context, it returns the first item in the list.  There is no
guarantee as to what the first item will be.
.PP
An \f(CW\*(C`Alzabo::Exception::Params\*(C'\fR exception is
throws if the table does not contain the specified column.
.ie n .SS "foreign_keys_by_table (""Alzabo::Table"" object)"
.el .SS "foreign_keys_by_table (\f(CWAlzabo::Table\fP object)"
.IX Subsection "foreign_keys_by_table (Alzabo::Table object)"
Returns a list of all the \f(CW\*(C`Alzabo::ForeignKey\*(C'\fR
objects \fBto\fR the given table.  In scalar context, it returns the
first item in the list.  There is no guarantee as to what the first
item will be.
.ie n .SS "foreign_keys_by_column (""Alzabo::Column"" object)"
.el .SS "foreign_keys_by_column (\f(CWAlzabo::Column\fP object)"
.IX Subsection "foreign_keys_by_column (Alzabo::Column object)"
Returns a list of all the \f(CW\*(C`Alzabo::ForeignKey\*(C'\fR
objects that the given column is a part of, if any.  In scalar
context, it returns the first item in the list.  There is no guarantee
as to what the first item will be.
.PP
An \f(CW\*(C`Alzabo::Exception::Params\*(C'\fR exception is
throws if the table does not contain the specified column.
.SS "all_foreign_keys"
.IX Subsection "all_foreign_keys"
Returns a list of all the \f(CW\*(C`Alzabo::ForeignKey\*(C'\fR
objects for this table.  In scalar context, it returns the first item
in the list.  There is no guarantee as to what the first item will be.
.SS "index ($index_id)"
.IX Subsection "index ($index_id)"
This method expects an index id as returned by the
\&\f(CW\*(C`Alzabo::Index\->id\*(C'\fR method as its parameter.
.PP
The \f(CW\*(C`Alzabo::Index\*(C'\fR object matching this id, if it
exists in the table.
.PP
An \f(CW\*(C`Alzabo::Exception::Params\*(C'\fR exception is
throws if the table does not contain the specified index.
.SS "has_index ($index_id)"
.IX Subsection "has_index ($index_id)"
This method expects an index id as returned by the
\&\f(CW\*(C`Alzabo::Index\->id\*(C'\fR method as its parameter.
.PP
Returns a boolean indicating whether the table has an index with the
same id.
.SS "indexes"
.IX Subsection "indexes"
Returns all the \f(CW\*(C`Alzabo::Index\*(C'\fR objects for the
table.
.SS "comment"
.IX Subsection "comment"
Returns the comment associated with the table object, if any.
.SH "AUTHOR"
.IX Header "AUTHOR"
Dave Rolsky, <autarch@urth.org>