NAME

Meta::Db::Table - Object to store a definition of a table in a database.

COPYRIGHT

Copyright (C) 2001, 2002 Mark Veltzer; All rights reserved.

LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.

DETAILS

        MANIFEST: Table.pm
        PROJECT: meta
        VERSION: 0.41

SYNOPSIS

        package foo;
        use Meta::Db::Table qw();
        my($table)=Meta::Db::Table->new();
        $table->parse($file);
        my($table)=$syntax->get_table_num();

DESCRIPTION

This is an object that stores the definition of a single table in a database. This includes a hash of the current fields and their types. This object inherits from the Ohash object.

FUNCTIONS

        BEGIN()
        new($)
        get_fields($)
        set_fields($$)
        get_def($)
        print($$)
        printd($$)
        printx($$)
        getsql_create($$$)
        getsql_drop($$$)
        getsql_clean($$$)
        getsql_name($$)
        getsql_select($$)
        getsql_insert($$)
        TEST($)

FUNCTION DOCUMENTATION

BEGIN()

This method will set up get/set methods for the following attributes: name - the name of the table. description - the description of the table.

new($)

This gives you a new object for a table definitions.

get_fields($)

This returns the fields of the current table.

set_fields($$)

This will set the fields of the current table.

get_def($)

This method will return the def object for the table.

print($$)

This prints the table into a file.

printd($$)

This method will print the object in DocBook XML format using a writer object received.

printx($$)

This method will print the object in XML format using a writer object received.

getsql_create($$$)

This method receives a Table object and a statement collection and add to that statement collection a list of statements needed to create this object over an SQL connection.

getsql_drop($$$)

This method receives a Table object and a statement collection and add to that statement collection a list of statements needed to drop this object over an SQL connection.

getsql_clean($$$)

This method receives a Table object and a statement collection and add to that statement collection a list of statements needed to clean this object over an SQL connection.

getsql_name($$)

This method will return a name for this table which is prefixed by the given database name.

getsql_select($$)

This method will return an SQL sniplet which can be used in SELECT type statements.

getsql_insert($$)

This method will return an SQL sniplet which can be used in INSERT type statements.

TEST($)

Test suite for this object.

SUPER CLASSES

Meta::Ds::Connected(3)

BUGS

None.

AUTHOR

        Name: Mark Veltzer
        Email: mailto:veltzer@cpan.org
        WWW: http://www.veltzer.org
        CPAN id: VELTZER

HISTORY

        0.00 MV initial code brought in
        0.01 MV bring databases on line
        0.02 MV ok. This is for real
        0.03 MV make quality checks on perl code
        0.04 MV more perl checks
        0.05 MV check that all uses have qw
        0.06 MV fix todo items look in pod documentation
        0.07 MV more on tests/more checks to perl
        0.08 MV fix all tests change
        0.09 MV change new methods to have prototypes
        0.10 MV perl code quality
        0.11 MV more perl quality
        0.12 MV more perl quality
        0.13 MV perl documentation
        0.14 MV get graph stuff going
        0.15 MV more perl quality
        0.16 MV perl qulity code
        0.17 MV more perl code quality
        0.18 MV revision change
        0.19 MV languages.pl test online
        0.20 MV history change
        0.21 MV db stuff
        0.22 MV more data sets
        0.23 MV perl packaging
        0.24 MV db inheritance
        0.25 MV PDMT
        0.26 MV some chess work
        0.27 MV md5 project
        0.28 MV database
        0.29 MV perl module versions in files
        0.30 MV movies and small fixes
        0.31 MV movie stuff
        0.32 MV graph visualization
        0.33 MV more thumbnail stuff
        0.34 MV thumbnail user interface
        0.35 MV dbman package creation
        0.36 MV more thumbnail issues
        0.37 MV website construction
        0.38 MV web site development
        0.39 MV web site automation
        0.40 MV SEE ALSO section fix
        0.41 MV md5 issues

SEE ALSO

Meta::Class::MethodMaker(3), Meta::Db::Constraints(3), Meta::Db::Fields(3), Meta::Ds::Connected(3), strict(3)

TODO

Nothing.