1SearchBuilder::SchemaGeUnseerratCoorn(t3r)ibuted Perl DoSceuamrecnhtBautiilodner::SchemaGenerator(3)
2
3
4
5       new HANDLE
6
7       Creates a new "DBIx::SearchBuilder::SchemaGenerator" object.  The sin‐
8       gle required argument is a "DBIx::SearchBuilder::Handle".
9
10       Adds a new model class to the SchemaGenerator.  Model should either be
11       an object of a subclass of "DBIx::SearchBuilder::Record", or the name
12       of such a subclass; in the latter case, "AddModel" will instantiate an
13       object of the subclass.
14
15       The model must define the instance methods "Schema" and "Table".
16
17       Returns true if the model was added successfully; returns a false
18       "Class::ReturnValue" error otherwise.
19
20       Returns a list of SQL statements (as strings) to create tables for all
21       of the models added to the SchemaGenerator.
22
23       Returns a string containg a sequence of SQL statements to create tables
24       for all of the models added to the SchemaGenerator.
25
26       Takes an object of a subclass of DBIx::SearchBuilder::Record; returns a
27       new "DBIx::DBSchema::Table" object corresponding to the model.
28
29       Takes in a string and returns it as a Class::ReturnValue error object.
30

NAME

32       DBIx::SearchBuilder::SchemaGenerator - Generate table schemas from
33       DBIx::SearchBuilder records
34

SYNOPSIS

36           use DBIx::SearchBuilder::SchemaGenerator;
37

DESCRIPTION

INTERFACE
DIAGNOSTICS
41       "Error message here, perhaps with %s placeholders"
42           [Description of error here]
43
44       "Another error message here"
45           [Description of error here]
46
47           [Et cetera, et cetera]
48

CONFIGURATION AND ENVIRONMENT
50       <MODULE NAME> requires no configuration files or environment variables.
51

DEPENDENCIES
53       None.
54

INCOMPATIBILITIES
56       None reported.
57

BUGS AND LIMITATIONS
59       No bugs have been reported.
60
61       Please report any bugs or feature requests to "bug-<RT
62       NAME"@rt.cpan.org>, or through the web interface at
63       <http://rt.cpan.org>.
64

AUTHOR
66       David Glasser  "glasser@bestpractical.com"
67

69       Copyright (c) <YEAR>, <AUTHOR> "<<EMAIL>>". All rights reserved.
70
71       This module is free software; you can redistribute it and/or modify it
72       under the same terms as Perl itself. See perlartistic.
73

DISCLAIMER OF WARRANTY
75       BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
76       FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
77       WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER
78       PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND,
79       EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
80       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
81       ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
82       YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
83       NECESSARY SERVICING, REPAIR, OR CORRECTION.
84
85       IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
86       WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
87       REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
88       TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CON‐
89       SEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFT‐
90       WARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED
91       INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF
92       THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER
93       OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
94
95
96
97perl v5.8.8                       2007-02-17 SearchBuilder::SchemaGenerator(3)



        

    


            
        

        

            Impressum