.\" Automatically generated by Pod::Man 2.27 (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 "MySQL::Diff::Table 3"
.TH MySQL::Diff::Table 3 "2016-07-22" "perl v5.16.3" "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"
MySQL::Diff::Table \- Table Definition Class
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use MySQL::Diff::Table
\&
\&  my $db = MySQL::Diff::Database\->new(%options);
\&  my $def           = $db\->def();
\&  my $name          = $db\->name();
\&  my $field         = $db\->field();
\&  my $fields        = $db\->fields();                # %$fields
\&  my $primary_key   = $db\->primary_key();
\&  my $indices       = $db\->indices();               # %$indices
\&  my $options       = $db\->options();
\&
\&  my $isfield       = $db\->isa_field($field);
\&  my $isprimary     = $db\->isa_primary($field);
\&  my $isindex       = $db\->isa_index($field);
\&  my $isunique      = $db\->is_unique($field);
\&  my $isfulltext    = $db\->is_fulltext($field);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Parses a table definition into component parts.
.SH "METHODS"
.IX Header "METHODS"
.SS "Constructor"
.IX Subsection "Constructor"
.ie n .IP "new( %options )" 4
.el .IP "new( \f(CW%options\fR )" 4
.IX Item "new( %options )"
Instantiate the objects, providing the command line options for database
access and process requirements.
.SS "Public Methods"
.IX Subsection "Public Methods"
Fuller documentation will appear here in time :)
.IP "\(bu" 4
def
.Sp
Returns the table definition as a string.
.IP "\(bu" 4
name
.Sp
Returns the name of the current table.
.IP "\(bu" 4
field
.Sp
Returns the current field definition of the given field.
.IP "\(bu" 4
fields
.Sp
Returns an array reference to a list of fields.
.IP "\(bu" 4
primary_key
.Sp
Returns a hash reference to fields used as primary key fields.
.IP "\(bu" 4
indices
.Sp
Returns a hash reference to fields used as index fields.
.IP "\(bu" 4
options
.Sp
Returns the additional options added to the table definition.
.IP "\(bu" 4
isa_field
.Sp
Returns 1 if given field is used in the current table definition, otherwise 
returns 0.
.IP "\(bu" 4
isa_primary
.Sp
Returns 1 if given field is defined as a primary key, otherwise returns 0.
.IP "\(bu" 4
isa_index
.Sp
Returns 1 if given field is used as an index field, otherwise returns 0.
.IP "\(bu" 4
is_unique
.Sp
Returns 1 if given field is used as unique index field, otherwise returns 0.
.IP "\(bu" 4
is_fulltext
.Sp
Returns 1 if given field is used as fulltext index field, otherwise returns 0.
.IP "\(bu" 4
is_auto_inc
.Sp
Returns 1 if given field is defined as an auto increment field, otherwise returns 0.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (c) 2000\-2016 Adam Spiers. All rights reserved. This
program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
mysqldiff, MySQL::Diff, MySQL::Diff::Database, MySQL::Diff::Utils
.SH "AUTHOR"
.IX Header "AUTHOR"
Adam Spiers <mysqldiff@adamspiers.org>