1 package SQL::Translator::Producer::TTSchema;
7 SQL::Translator::Producer::TTSchema -
8 Produces output using the Template Toolkit from a SQL schema
13 my $translator = SQL::Translator->new(
15 filename => 'foo_schema.sql',
18 ttfile => 'foo_template.tt', # Template file to use
20 # Extra template variables
25 # Template config options
27 INCLUDE_PATH => '/foo/templates',
31 print $translator->translate;
35 Produces schema output using a given Template Tookit template.
37 It needs one additional producer arg of C<ttfile> which is the file
38 name of the template to use. This template will be passed a variable
39 called C<schema>, which is the C<SQL::Translator::Producer::Schema> object
40 created by the parser. You can then use it to walk the schema via the
41 methods documented in that module.
43 Here's a brief example of what the template could look like:
45 database: [% schema.database %]
47 [% FOREACH table = schema.get_tables %]
50 [% FOREACH field = table.get_fields %]
51 [% field.name %] [% field.data_type %]([% field.size %])
55 See F<t/data/template/basic.tt> for a more complete example.
57 The template will also get the set of extra variables given as a
58 hashref via the C<tt_vars> producer arg. (Note that the old style of
59 passing this config in the C<ttargs> producer arg has been
62 You can set any of the options used to initialize the Template object by
63 adding a C<tt_conf> producer arg. See Template Toolkit docs for details of
65 (Note that the old style of passing this config directly in the C<ttargs> producer args
69 $translator = SQL::Translator->new(
72 ttfile => 'foo_template.tt',
75 INCLUDE_PATH => '/foo/templates/tt',
81 You can use this producer to create any type of text output you like,
82 even using it to create your own versions of what the other producers
83 make. For example, you could create a template that translates the
84 schema into MySQL's syntax, your own HTML documentation, your own
85 Class::DBI classes (or some other code) -- the opportunities are
94 The template file to generate the output with.
98 A hash ref of extra variables you want to add to the template.
102 A hash ref of configuration options to pass to the L<Template> object's
112 our ( $DEBUG, @EXPORT_OK );
113 our $VERSION = '1.60';
114 $DEBUG = 0 unless defined $DEBUG;
119 use base qw(Exporter);
120 @EXPORT_OK = qw(produce);
122 use SQL::Translator::Utils 'debug';
125 my $translator = shift;
126 local $DEBUG = $translator->debug;
127 my $scma = $translator->schema;
128 my $args = $translator->producer_args;
129 my $file = delete $args->{'ttfile'} or die "No template file!";
131 my $tt_vars = delete $args->{'tt_vars'} || {};
132 if ( exists $args->{ttargs} ) {
133 warn "Use of 'ttargs' producer arg is deprecated."
134 ." Please use 'tt_vars' instead.\n";
135 %$tt_vars = { %{$args->{ttargs}}, %$tt_vars };
138 my %tt_conf = exists $args->{tt_conf} ? %{$args->{tt_conf}} : ();
139 # sqlt passes the producer args for _all_ producers in, so we use this
140 # grep hack to test for the old usage.
141 debug(Dumper(\%tt_conf)) if $DEBUG;
142 if ( grep /^[A-Z_]+$/, keys %$args ) {
143 warn "Template config directly in the producer args is deprecated."
144 ." Please use 'tt_conf' instead.\n";
145 %tt_conf = ( %tt_conf, %$args );
148 debug "Processing template $file\n";
150 my $tt = Template->new(
152 ABSOLUTE => 1, # Set so we can use from the command line sensibly
153 RELATIVE => 1, # Maybe the cmd line code should set it! Security!
156 debug("Template ERROR: " . Template->error. "\n") if(!$tt);
157 $tt || die "Failed to initialize Template object: ".Template->error;
159 my $ttproc = $tt->process(
161 { schema => $scma , %$tt_vars },
164 debug("ERROR: ". $tt->error. "\n") if(!$ttproc);
165 $ttproc or die "Error processing template '$file': ".$tt->error;
176 Mark Addison E<lt>grommit@users.sourceforge.netE<gt>.
180 B<More template vars?> e.g. [% tables %] as a shortcut for
181 [% schema.get_tables %].