NAME

SQL::Translator::Producer::TTSchema - Produces output using the Template Toolkit from a SQL schema

SYNOPSIS

  use SQL::Translator;
  my $translator     = SQL::Translator->new(
      from           => 'MySQL',
      filename       => 'foo_schema.sql',
      to             => 'TTSchema',
      producer_args  => {
          ttfile     => 'foo_template.tt',
      },
  );
  print $translator->translate;

DESCRIPTION

Produces schema output using a given Template Tookit template.

It needs one additional producer_arg of ttfile which is the file name of the template to use. This template will be passed a single argument called schema, which is the SQL::Translator::Producer::Schema object, which you can then use to walk the schema via the methods documented in that module.

Here's a brief example of what the template could look like:

  database: [% schema.database %]
  tables:
  [% FOREACH table = schema.get_tables %]
      [% table.name %]
      ================
      [% FOREACH field = table.get_fields %]
          [% field.name %]   [% field.data_type %]([% field.size %])
      [% END -%]
  [% END %]

See t/data/template/basic.tt for a more complete example.

You can also set any of the options used to initiallize the Template object by adding them to your producer_args. See Template Toolkit docs for details of the options.

  $translator          = SQL::Translator->new(
      to               => 'TT',
      producer_args    => {
          ttfile       => 'foo_template.tt',
          INCLUDE_PATH => '/foo/templates/tt',
          INTERPOLATE  => 1,
      },
  );

You can use this producer to create any type of text output you like, even using it to create your own versions of what the other producers make. For example, you could create a template that translates the schema into MySQL's syntax, your own HTML documentation, your own Class::DBI classes (or some other code) -- the opportunities are limitless!

AUTHOR

Mark Addison <grommit@users.sourceforge.net>.

TODO

More template vars? e.g. [% tables %] as a shortcut for [% schema.get_tables %].

SEE ALSO

SQL::Translator.