1 package SQL::Translator::Producer::TTSchema;
3 # -------------------------------------------------------------------
4 # Copyright (C) 2002-2009 SQLFairy Authors
6 # This program is free software; you can redistribute it and/or
7 # modify it under the terms of the GNU General Public License as
8 # published by the Free Software Foundation; version 2.
10 # This program is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 # General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
19 # -------------------------------------------------------------------
25 SQL::Translator::Producer::TTSchema -
26 Produces output using the Template Toolkit from a SQL schema
31 my $translator = SQL::Translator->new(
33 filename => 'foo_schema.sql',
36 ttfile => 'foo_template.tt', # Template file to use
38 # Extra template variables
43 # Template config options
45 INCLUDE_PATH => '/foo/templates',
49 print $translator->translate;
53 Produces schema output using a given Template Tookit template.
55 It needs one additional producer_arg of C<ttfile> which is the file
56 name of the template to use. This template will be passed a variable
57 called C<schema>, which is the C<SQL::Translator::Producer::Schema> object
58 created by the parser. You can then use it to walk the schema via the
59 methods documented in that module.
61 Here's a brief example of what the template could look like:
63 database: [% schema.database %]
65 [% FOREACH table = schema.get_tables %]
68 [% FOREACH field = table.get_fields %]
69 [% field.name %] [% field.data_type %]([% field.size %])
73 See F<t/data/template/basic.tt> for a more complete example.
75 The template will also get the set of extra variables given as a hashref via the
76 C<tt_vars> producer arg.
78 You can set any of the options used to initiallize the Template object by
79 adding a tt_conf producer_arg. See Template Toolkit docs for details of
81 (Note that the old style of passing this config directly in the producer args
85 $translator = SQL::Translator->new(
88 ttfile => 'foo_template.tt',
91 INCLUDE_PATH => '/foo/templates/tt',
97 You can use this producer to create any type of text output you like,
98 even using it to create your own versions of what the other producers
99 make. For example, you could create a template that translates the
100 schema into MySQL's syntax, your own HTML documentation, your own
101 Class::DBI classes (or some other code) -- the opportunities are
110 The template file to generate the output with.
114 A hash ref of extra variables you want to add to the template.
118 A hash ref of configuration options to pass to the L<Template> object's
125 # -------------------------------------------------------------------
129 use vars qw[ $DEBUG $VERSION @EXPORT_OK ];
131 $DEBUG = 0 unless defined $DEBUG;
136 use base qw(Exporter);
137 @EXPORT_OK = qw(produce);
139 use SQL::Translator::Utils 'debug';
142 my $translator = shift;
143 local $DEBUG = $translator->debug;
144 my $scma = $translator->schema;
145 my $args = $translator->producer_args;
146 my $file = delete $args->{'ttfile'} or die "No template file!";
148 my $tt_vars = delete $args->{'tt_vars'} || {};
149 if ( exists $args->{ttargs} ) {
150 warn "Use of 'ttargs' producer arg is deprecated."
151 ." Please use 'tt_vars' instead.\n";
152 %$tt_vars = { %{$args->{ttargs}}, %$tt_vars };
155 my %tt_conf = exists $args->{tt_conf} ? %{$args->{tt_conf}} : ();
156 # sqlt passes the producer args for _all_ producers in, so we use this
157 # grep hack to test for the old usage.
158 debug(Dumper(\%tt_conf));
159 if ( grep /^[A-Z_]+$/, keys %$args ) {
160 warn "Template config directly in the producer args is deprecated."
161 ." Please use 'tt_conf' instead.\n";
162 %tt_conf = ( %tt_conf, %$args );
165 debug "Processing template $file\n";
167 my $tt = Template->new(
169 ABSOLUTE => 1, # Set so we can use from the command line sensibly
170 RELATIVE => 1, # Maybe the cmd line code should set it! Security!
173 debug("Template ERROR: " . Template->error. "\n") if(!$tt);
174 $tt || die "Failed to initialize Template object: ".Template->error;
176 my $ttproc = $tt->process(
178 { schema => $scma , %$tt_vars },
181 debug("ERROR: ". $tt->error. "\n") if(!$ttproc);
182 $ttproc or die "Error processing template '$file': ".$tt->error;
189 # -------------------------------------------------------------------
195 Mark Addison E<lt>grommit@users.sourceforge.netE<gt>.
199 B<More template vars?> e.g. [% tables %] as a shortcut for
200 [% schema.get_tables %].