SQLT(1p) User Contributed Perl Documentation SQLT(1p)NAME
sqlt - convert SQL schema using SQL::Translator
SYNOPSIS
For help:
sqlt -h|--help
For a list of all parsers and producers:
sqlt -l|--list
To translate a schema:
sqlt -f|--from|--parser MySQL
-t|--to|--producer Oracle
[options]
file [file2 ...]
General Options:
-d|--debug Print debug info
-v|--validate Validate the schema
--version Show the version of SQL::Translator
--trace Print parser trace info
--show-warnings Print warnings to STDERR
General Parser Options:
--skip Comma-separated list of tables to skip (only implemented in some parsers)
--ignore_opts Comma-separated list of table options to ignore
DBI Parser Options:
--dsn DSN for connecting to database
(see also --use-same-auth below)
--db-user Database user
--db-password Database password
xSV Parser Options:
--fs The field separator
--rs The record separator
--no-trim Don't trim whitespace on fields
--no-scan Don't scan fields for data types and sizes
MySQL Parser Options:
--mysql-parser-version Target MySQL parser version for dealing with
/*! comments; default = 30000
MySQL Producer Options:
--mysql-version MySQL server version
General Producer Options
--producer-db-user Database user for producer
--producer-db-pass Database password for producer
--producer-dsn DSN for producer
--use-same-auth Use these DSN, user, password for producer output
DB Producer Options:
--add-drop-table Add 'DROP TABLE' statements before creates
--quote-table-names Quote all table names in statements
--quote-field-names Qjuote all field names in statements
--no-comments Don't include comments in SQL output
PostgreSQL Producer Options:
--postgres-version PostgreSQL server version
Diagram Producer Options:
--imap-file Filename to put image map data
--imap-url URL to use for image map
Dumper Producer Options:
--skip Comma-separated list of tables to skip
--skiplike Regex for tables to skip
--add-truncate Add "TRUNCATE TABLE" statements for each table
HTML/POD Producer Options:
--pretty Use CGI::Pretty for the output
--title Title of schema
TTSchema Producer Options:
--template The path to the template
--tt-var var=value Pass extra variables to the template
--tt-conf option=value Pass extra config options to Template
XML-SQLFairy Producer Options:
--add-prefix Use an explicit namespace prefix of 'sqlf:'
--prefix=<p> Use the namespace prefix given as argument.
--no-newlines Write the XML as a single line.
--indent=<n> Use <n> characters of whitespace to indent the XML.
ClassDBI Producer Options:
--package Base package name for Class::DBI modules.
DESCRIPTION
This script is part of the SQL Fairy project. It will try to convert any source file for which it has a grammar into any format for which
it has a producer.
If using "show-warnings," be sure to redirect STDERR to a separate file. In bash, you could do this:
$ sql_translator.pl -f MySQL -t PostgreSQL --show-warnings
file.sql 1>out 2>err
You can specify a parser or producer located in any module that Perl knows about, allowing you to easily substitute your own.
AUTHOR
Ken Youens-Clark <kclark@cpan.org>, darren chamberlain <darren@cpan.org>.
SEE ALSO
SQL::Translator, <http://sqlfairy.sourceforge.net>.
perl v5.14.2 2012-01-18 SQLT(1p)
Check Out this Related Man Page
SQL::Translator::Producer::TTSchema(3pm) User Contributed Perl Documentation SQL::Translator::Producer::TTSchema(3pm)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
ttargs => {
author => "Mr Foo",
},
# Template config options
ttargs => {
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.
You can set any of the options used to initiallize 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 producer args has been deprecated).
$translator = SQL::Translator->new(
to => 'TT',
producer_args => {
ttfile => 'foo_template.tt',
ttargs => {},
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.14.2 2012-01-18 SQL::Translator::Producer::TTSchema(3pm)