.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Jifty::DBI::SchemaGenerator 3pm"
.TH Jifty::DBI::SchemaGenerator 3pm "2014-05-29" "perl v5.20.2" "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
.SH "NAME"
Jifty::DBI::SchemaGenerator \- Generate a table schema from Jifty::DBI records
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module turns a Jifty::Record object into an \s-1SQL\s0 schema for your chosen
database. At the moment, your choices are MySQL, SQLite, or PostgreSQL.
Oracle might also work right, though it's untested.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.SS "The Short Answer"
.IX Subsection "The Short Answer"
See below for where we get the \f(CW$handle\fR and \f(CW$model\fR variables.
.PP
.Vb 4
\&  use Jifty::DBI::SchemaGenerator;
\&  ...
\&  my $s_gen = Jifty::DBI::SchemaGenerator\->new( $handle );
\&  $s_gen\->add_model($model);
\&
\&  my @statements = $s_gen\->create_table_sql_statements;
\&  print join("\en", @statements, \*(Aq\*(Aq);
\&  ...
.Ve
.SS "The Long Version"
.IX Subsection "The Long Version"
See Jifty::DBI for details about the first two parts.
.IP "MyModel" 4
.IX Item "MyModel"
.Vb 2
\&  package MyModel; 
\&  # lib/MyModel.pm
\&
\&  use warnings;
\&  use strict;
\&
\&  use base qw(Jifty::DBI::Record);
\&  # your custom code goes here.
\&  1;
.Ve
.IP "MyModel::Schema" 4
.IX Item "MyModel::Schema"
.Vb 2
\&  package MyModel::Schema;
\&  # lib/MyModel/Schema.pm
\&
\&  use warnings;
\&  use strict;
\&
\&  use Jifty::DBI::Schema;
\&
\&  column foo => type is \*(Aqtext\*(Aq;
\&  column bar => type is \*(Aqtext\*(Aq;
\&
\&  1;
.Ve
.IP "myscript.pl" 4
.IX Item "myscript.pl"
.Vb 2
\&  #!/usr/bin/env perl
\&  # myscript.pl
\&
\&  use strict;
\&  use warnings;
\&
\&  use Jifty::DBI::SchemaGenerator;
\&
\&  use Jifty::DBI::Handle;
\&  use MyModel;
\&  use MyModel::Schema;
\&
\&  my $handle = Jifty::DBI::Handle\->new();
\&  $handle\->connect(
\&    driver   => \*(AqSQLite\*(Aq,
\&    database => \*(Aqtestdb\*(Aq,
\&  );
\&
\&  my $model = MyModel\->new($handle);
\&  my $s_gen = Jifty::DBI::SchemaGenerator\->new( $handle );
\&  $s_gen\->add_model($model);
\&
\&  # here\*(Aqs the basic point of this module:
\&  my @statements = $s_gen\->create_table_sql_statements;
\&  print join("\en", @statements, \*(Aq\*(Aq);
\&
\&  # this part is directly from Jifty::Script::Schema::create_all_tables()
\&  $handle\->begin_transaction;
\&  for my $statement (@statements) {
\&    my $ret = $handle\->simple_query($statement);
\&    $ret or die "error creating a table: " . $ret\->error_message;
\&  }
\&  $handle\->commit;
.Ve
.SH "CONFIGURATION AND ENVIRONMENT"
.IX Header "CONFIGURATION AND ENVIRONMENT"
Requires no configuration files or environment variables.
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
Class::Accessor::Fast
.PP
DBIx::DBSchema
.PP
Class::ReturnValue
.SH "METHODS"
.IX Header "METHODS"
.SS "new \s-1HANDLE\s0"
.IX Subsection "new HANDLE"
Creates a new \f(CW\*(C`Jifty::DBI::SchemaGenerator\*(C'\fR object.  The single
required argument is a \f(CW\*(C`Jifty::DBI::Handle\*(C'\fR.
.SS "add_model \s-1MODEL\s0"
.IX Subsection "add_model MODEL"
Adds a new model class to the SchemaGenerator.  Model should be an
object which is an instance of \f(CW\*(C`Jifty::DBI::Record\*(C'\fR or a subclass
thereof.  It may also be a string which is the name of such a
class/subclass; in the latter case, \f(CW\*(C`add_model\*(C'\fR will instantiate an
object of the class.
.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.
.SS "column_definition_sql \s-1TABLENAME COLUMNNAME\s0"
.IX Subsection "column_definition_sql TABLENAME COLUMNNAME"
Given a table name and a column name, returns the \s-1SQL\s0 fragment 
describing that column for the current database.
.SS "create_table_sql_statements"
.IX Subsection "create_table_sql_statements"
Returns a list of \s-1SQL\s0 statements (as strings) to create tables for all of
the models added to the SchemaGenerator.
.SS "create_table_sql_text"
.IX Subsection "create_table_sql_text"
Returns a string containing a sequence of \s-1SQL\s0 statements to create tables for all of
the models added to the SchemaGenerator.
.PP
This is just a trivial wrapper around \*(L"create_table_sql_statements\*(R".
.SS "\s-1PRIVATE\s0 _db_schema_table_from_model \s-1MODEL\s0"
.IX Subsection "PRIVATE _db_schema_table_from_model MODEL"
Takes an object of a subclass of Jifty::DBI::Record; returns a new
\&\f(CW\*(C`DBIx::DBSchema::Table\*(C'\fR object corresponding to the model.
.SS "\s-1PRIVATE\s0 _error \s-1STRING\s0"
.IX Subsection "PRIVATE _error STRING"
Takes in a string and returns it as a Class::ReturnValue error object.
.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\-<RT NAME>@rt.cpan.org\*(C'\fR, or through the web interface at
<http://rt.cpan.org>.
.SH "AUTHOR"
.IX Header "AUTHOR"
David Glasser  \f(CW\*(C`glasser@bestpractical.com\*(C'\fR
.PP
Some pod by Eric Wilhelm <ewilhelm at cpan dot org>
.SH "LICENCE AND COPYRIGHT"
.IX Header "LICENCE AND COPYRIGHT"
Copyright (c) 2005, Best Practical Solutions, \s-1LLC. \s0 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