Alex Vandiver > DBIx-SearchBuilder-1.66 > DBIx::SearchBuilder::SchemaGenerator

Download:
DBIx-SearchBuilder-1.66.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  3
Open  2
Stalled  2
View/Report Bugs
Source  

new HANDLE

Creates a new DBIx::SearchBuilder::SchemaGenerator object. The single required argument is a DBIx::SearchBuilder::Handle.

Adds a new model class to the SchemaGenerator. Model should either be an object of a subclass of DBIx::SearchBuilder::Record, or the name of such a subclass; in the latter case, AddModel will instantiate an object of the subclass.

The model must define the instance methods Schema and Table.

Returns true if the model was added successfully; returns a false Class::ReturnValue error otherwise.

Returns a list of SQL statements (as strings) to create tables for all of the models added to the SchemaGenerator.

Returns a string containg a sequence of SQL statements to create tables for all of the models added to the SchemaGenerator.

Takes an object of a subclass of DBIx::SearchBuilder::Record; returns a new DBIx::DBSchema::Table object corresponding to the model.

Takes in a string and returns it as a Class::ReturnValue error object.

NAME ^

DBIx::SearchBuilder::SchemaGenerator - Generate table schemas from DBIx::SearchBuilder records

SYNOPSIS ^

    use DBIx::SearchBuilder::SchemaGenerator;

DESCRIPTION ^

INTERFACE ^

DIAGNOSTICS ^

Error message here, perhaps with %s placeholders

[Description of error here]

Another error message here

[Description of error here]

[Et cetera, et cetera]

CONFIGURATION AND ENVIRONMENT ^

<MODULE NAME> requires no configuration files or environment variables.

DEPENDENCIES ^

None.

INCOMPATIBILITIES ^

None reported.

BUGS AND LIMITATIONS ^

No bugs have been reported.

Please report any bugs or feature requests to bug-<RT NAME@rt.cpan.org>, or through the web interface at http://rt.cpan.org.

AUTHOR ^

David Glasser glasser@bestpractical.com

LICENCE AND COPYRIGHT ^

Copyright (c) <YEAR>, <AUTHOR> <<EMAIL>>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

syntax highlighting: