.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "DBIx::SearchBuilder::SchemaGenerator 3pm" .TH DBIx::SearchBuilder::SchemaGenerator 3pm "2021-01-24" "perl v5.32.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SS "new \s-1HANDLE\s0" .IX Subsection "new HANDLE" Creates a new \f(CW\*(C`DBIx::SearchBuilder::SchemaGenerator\*(C'\fR object. The single required argument is a \f(CW\*(C`DBIx::SearchBuilder::Handle\*(C'\fR. .PP Adds a new model class to the SchemaGenerator. Model should either be an object of a subclass of \f(CW\*(C`DBIx::SearchBuilder::Record\*(C'\fR, or the name of such a subclass; in the latter case, \f(CW\*(C`AddModel\*(C'\fR will instantiate an object of the subclass. .PP The model must define the instance methods \f(CW\*(C`Schema\*(C'\fR and \f(CW\*(C`Table\*(C'\fR. .PP Returns true if the model was added successfully; returns a false \f(CW\*(C`Class::ReturnValue\*(C'\fR error otherwise. .PP Returns a list of \s-1SQL\s0 statements (as strings) to create tables for all of the models added to the SchemaGenerator. .PP Returns a string containing a sequence of \s-1SQL\s0 statements to create tables for all of the models added to the SchemaGenerator. .PP Takes an object of a subclass of DBIx::SearchBuilder::Record; returns a new \&\f(CW\*(C`DBIx::DBSchema::Table\*(C'\fR object corresponding to the model. .PP Takes in a string and returns it as a Class::ReturnValue error object. .SH "NAME" DBIx::SearchBuilder::SchemaGenerator \- Generate table schemas from DBIx::SearchBuilder records .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use DBIx::SearchBuilder::SchemaGenerator; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" .SH "INTERFACE" .IX Header "INTERFACE" .SH "DIAGNOSTICS" .IX Header "DIAGNOSTICS" .ie n .IP """Error message here, perhaps with %s placeholders""" 4 .el .IP "\f(CWError message here, perhaps with %s placeholders\fR" 4 .IX Item "Error message here, perhaps with %s placeholders" [Description of error here] .ie n .IP """Another error message here""" 4 .el .IP "\f(CWAnother error message here\fR" 4 .IX Item "Another error message here" [Description of error here] .Sp [Et cetera, et cetera] .SH "CONFIGURATION AND ENVIRONMENT" .IX Header "CONFIGURATION AND ENVIRONMENT" <\s-1MODULE NAME\s0> requires no configuration files or environment variables. .SH "DEPENDENCIES" .IX Header "DEPENDENCIES" None. .SH "INCOMPATIBILITIES" .IX Header "INCOMPATIBILITIES" None reported. .SH "BUGS AND LIMITATIONS" .IX Header "BUGS AND LIMITATIONS" No bugs have been reported. .PP Please report any bugs or feature requests to \&\f(CW\*(C`bug\-, or through the web interface at . .SH "AUTHOR" .IX Header "AUTHOR" David Glasser \f(CW\*(C`glasser@bestpractical.com\*(C'\fR .SH "LICENCE AND COPYRIGHT" .IX Header "LICENCE AND COPYRIGHT" Copyright (c) <\s-1YEAR\s0>, <\s-1AUTHOR\s0> \f(CW\*(C`<>\*(C'\fR. All rights reserved. .PP This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic. .SH "DISCLAIMER OF WARRANTY" .IX Header "DISCLAIMER OF WARRANTY" \&\s-1BECAUSE 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 \*(L"AS IS\*(R" 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.\s0 .PP \&\s-1IN 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\s0 (\s-1INCLUDING 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\s0), \s-1EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.\s0