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

NAME

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

SYNOPSIS

35           use DBIx::SearchBuilder::SchemaGenerator;
36

DESCRIPTION

INTERFACE

DIAGNOSTICS

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

CONFIGURATION AND ENVIRONMENT

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

DEPENDENCIES

52       None.
53

INCOMPATIBILITIES

55       None reported.
56

BUGS AND LIMITATIONS

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

AUTHOR

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

DISCLAIMER OF WARRANTY

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