File Coverage

blib/lib/SQL/Translator/Producer/TTSchema.pm
Criterion Covered Total %
statement 41 46 89.1
branch 10 18 55.5
condition 1 2 50.0
subroutine 8 8 100.0
pod 0 1 0.0
total 60 75 80.0


line stmt bran cond sub pod time code
1             package SQL::Translator::Producer::TTSchema;
2              
3             =pod
4              
5             =head1 NAME
6              
7             SQL::Translator::Producer::TTSchema -
8             Produces output using the Template Toolkit from a SQL schema
9              
10             =head1 SYNOPSIS
11              
12             use SQL::Translator;
13             my $translator = SQL::Translator->new(
14             from => 'MySQL',
15             filename => 'foo_schema.sql',
16             to => 'TTSchema',
17             producer_args => {
18             ttfile => 'foo_template.tt', # Template file to use
19              
20             # Extra template variables
21             tt_vars => {
22             author => "Mr Foo",
23             },
24              
25             # Template config options
26             tt_conf => {
27             INCLUDE_PATH => '/foo/templates',
28             },
29             },
30             );
31             print $translator->translate;
32              
33             =head1 DESCRIPTION
34              
35             Produces schema output using a given Template Tookit template.
36              
37             It needs one additional producer arg of C which is the file
38             name of the template to use. This template will be passed a variable
39             called C, which is the C object
40             created by the parser. You can then use it to walk the schema via the
41             methods documented in that module.
42              
43             Here's a brief example of what the template could look like:
44              
45             database: [% schema.database %]
46             tables:
47             [% FOREACH table = schema.get_tables %]
48             [% table.name %]
49             ================
50             [% FOREACH field = table.get_fields %]
51             [% field.name %] [% field.data_type %]([% field.size %])
52             [% END -%]
53             [% END %]
54              
55             See F for a more complete example.
56              
57             The template will also get the set of extra variables given as a
58             hashref via the C producer arg. (Note that the old style of
59             passing this config in the C producer arg has been
60             deprecated).
61              
62             You can set any of the options used to initialize the Template object by
63             adding a C producer arg. See Template Toolkit docs for details of
64             the options.
65             (Note that the old style of passing this config directly in the C producer args
66             has been deprecated).
67              
68              
69             $translator = SQL::Translator->new(
70             to => 'TT',
71             producer_args => {
72             ttfile => 'foo_template.tt',
73             tt_vars => {},
74             tt_conf => {
75             INCLUDE_PATH => '/foo/templates/tt',
76             INTERPOLATE => 1,
77             }
78             },
79             );
80              
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
86             limitless!
87              
88             =head2 Producer Args
89              
90             =over 4
91              
92             =item ttfile
93              
94             The template file to generate the output with.
95              
96             =item tt_vars
97              
98             A hash ref of extra variables you want to add to the template.
99              
100             =item tt_conf
101              
102             A hash ref of configuration options to pass to the L