debian man page for mysql::diff::database

MySQL::Diff::Database(3pm)				User Contributed Perl Documentation				MySQL::Diff::Database(3pm)

NAME
       MySQL::Diff::Database - Database Definition Class

SYNOPSIS
	 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();

DESCRIPTION
       Parses a database definition into component parts.

METHODS
   Constructor
       new( %options )
	   Instantiate the objects, providing the command line options for database access and process requirements.

   Public Methods
       o   source_type()

	   Returns 'file' if the data source is a text file, and 'db' if connected directly to a database.

       o   summary()

	   Provides a summary of the database.

       o   name()

	   Returns the name of the database.

       o   tables()

	   Returns a list of tables for the current database.

       o   table_by_name( $name )

	   Returns the table definition (see MySQL::Diff::Table) for the given table.

FUNCTIONS
   Public Functions
       o   available_dbs()

	   Returns a list of the available databases.

	   Note that is used as a function call, not a method call.

COPYRIGHT AND LICENSE
       Copyright (c) 2000-2011 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.

SEE ALSO
       mysqldiff, MySQL::Diff, MySQL::Diff::Table, MySQL::Diff::Utils

AUTHOR
       Adam Spiers <mysqldiff@adamspiers.org>

perl v5.14.2							    2012-04-06						MySQL::Diff::Database(3pm)