.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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 >0, 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "MySQL::Diff::Database 3pm"
.TH MySQL::Diff::Database 3pm "2018-07-20" "perl v5.26.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"
MySQL::Diff::Database \- Database Definition Class
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use MySQL::Diff::Database;
\&
\&  my $db = MySQL::Diff::Database\->new(%options);
\&  my $source    = $db\->source_type();
\&  my $summary   = $db\->summary();
\&  my $name      = $db\->name();
\&  my @tables    = $db\->tables();
\&  my $table_def = $db\->table_by_name($table);
\&
\&  my @dbs = MySQL::Diff::Database::available_dbs();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Parses a database 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"
.IP "\(bu" 4
\&\fIsource_type()\fR
.Sp
Returns 'file' if the data source is a text file, and 'db' if connected
directly to a database.
.IP "\(bu" 4
\&\fIsummary()\fR
.Sp
Provides a summary of the database.
.IP "\(bu" 4
\&\fIname()\fR
.Sp
Returns the name of the database.
.IP "\(bu" 4
\&\fItables()\fR
.Sp
Returns a list of tables for the current database.
.IP "\(bu" 4
table_by_name( \f(CW$name\fR )
.Sp
Returns the table definition (see MySQL::Diff::Table) for the given table.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.SS "Public Functions"
.IX Subsection "Public Functions"
.IP "\(bu" 4
\&\fIavailable_dbs()\fR
.Sp
Returns a list of the available databases.
.Sp
Note that is used as a function call, not a method call.
.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::Table, MySQL::Diff::Utils
.SH "AUTHOR"
.IX Header "AUTHOR"
Adam Spiers <mysqldiff@adamspiers.org>