Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
SQL::Translator::ProduUser:Contributed PSQL::Translator::Producer::TTSchema(3)

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',  # Template file to use

		 # Extra template variables
		 tt_vars     =>	{
		     author => "Mr Foo",
		 },

		 # Template config options
		 tt_conf     =>	{
		     INCLUDE_PATH => '/foo/templates',
		 },
	     },
	 );
	 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 variable	called
       "schema", which is the "SQL::Translator::Producer::Schema" object
       created by the parser. You can then use it 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.

       The template will also get the set of extra variables given as a
       hashref via the "tt_vars" producer arg. (Note that the old style	of
       passing this config in the "ttargs" producer arg	has been deprecated).

       You can set any of the options used to initialize the Template object
       by adding a "tt_conf" producer arg. See Template	Toolkit	docs for
       details of the options.	(Note that the old style of passing this
       config directly in the "ttargs" producer	args has been deprecated).

	 $translator	      =	SQL::Translator->new(
	     to		      => 'TT',
	     producer_args    => {
		 ttfile	      => 'foo_template.tt',
		 tt_vars      => {},
		 tt_conf      => {
		   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!

   Producer Args
       ttfile
	   The template	file to	generate the output with.

       tt_vars
	   A hash ref of extra variables you want to add to the	template.

       tt_conf
	   A hash ref of configuration options to pass to the Template
	   object's constructor.

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.

perl v5.32.1			  2020-0SQL::Translator::Producer::TTSchema(3)

NAME | SYNOPSIS | DESCRIPTION | AUTHOR | TODO | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=SQL::Translator::Producer::TTSchema&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help