Commit | Line | Data |
7a8e1f51 |
1 | #!/usr/bin/perl -w |
e107f4d2 |
2 | # vim: set ft=perl: |
16dc9970 |
3 | |
49e1eb70 |
4 | # ------------------------------------------------------------------- |
d955ed82 |
5 | # $Id: sqlt,v 1.17 2004-11-26 00:34:09 grommit Exp $ |
49e1eb70 |
6 | # ------------------------------------------------------------------- |
daf4f623 |
7 | # Copyright (C) 2002-4 SQLFairy Authors |
783908a1 |
8 | # |
9 | # This program is free software; you can redistribute it and/or |
10 | # modify it under the terms of the GNU General Public License as |
11 | # published by the Free Software Foundation; version 2. |
12 | # |
13 | # This program is distributed in the hope that it will be useful, but |
14 | # WITHOUT ANY WARRANTY; without even the implied warranty of |
15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
16 | # General Public License for more details. |
17 | # |
18 | # You should have received a copy of the GNU General Public License |
19 | # along with this program; if not, write to the Free Software |
20 | # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
21 | # 02111-1307 USA |
22 | # ------------------------------------------------------------------- |
16dc9970 |
23 | |
44598b94 |
24 | =head1 NAME |
25 | |
26 | sqlt - convert SQL schema using SQL::Translator |
27 | |
28 | =head1 SYNOPSIS |
29 | |
30 | For help: |
31 | |
32 | sqlt -h|--help |
33 | |
af2301d7 |
34 | For a list of all parsers and producers: |
44598b94 |
35 | |
36 | sqlt -l|--list |
37 | |
38 | To translate a schema: |
39 | |
af2301d7 |
40 | sqlt -f|--from|--parser MySQL |
41 | -t|--to|--producer Oracle |
42 | [options] |
44598b94 |
43 | file [file2 ...] |
44 | |
45 | General Options: |
46 | |
47 | -d|--debug Print debug info |
48 | -v|--validate Validate the schema |
4ae3a779 |
49 | --version Show the version of SQL::Translator |
44598b94 |
50 | --trace Print parser trace info |
51 | --show-warnings Print warnings to STDERR |
52 | |
e107f4d2 |
53 | DBI Parser Options: |
54 | |
55 | --dsn DSN for connecting to database |
56 | --db-user Database user |
af2301d7 |
57 | --db-password Database password |
e107f4d2 |
58 | |
44598b94 |
59 | xSV Parser Options: |
60 | |
61 | --fs The field separator |
62 | --rs The record separator |
af2301d7 |
63 | --no-trim Don't trim whitespace on fields |
64 | --no-scan Don't scan fields for data types and sizes |
44598b94 |
65 | |
66 | DB Producer Options: |
67 | |
68 | --add-drop-table Add 'DROP TABLE' statements before creates |
69 | --no-comments Don't include comments in SQL output |
70 | |
71 | Diagram Producer Options: |
72 | |
73 | --imap-file Filename to put image map data |
74 | --imap-url URL to use for image map |
75 | |
e8aa1b67 |
76 | Dumper Producer Options: |
77 | |
78 | --skip Comma-separated list of tables to skip |
79 | --skiplike Regex for tables to skip |
80 | --dumper-db-user Database user for dumper script |
81 | --dumper-db-pass Database password for dumper script |
82 | --dumper-dsn DSN for dumper script |
83 | --add-truncate Add "TRUNCATE TABLE" statements for each table |
84 | |
44598b94 |
85 | HTML/POD Producer Options: |
86 | |
1ae0e8cb |
87 | --pretty Use CGI::Pretty for the output |
44598b94 |
88 | --title Title of schema |
89 | |
90 | TTSchema Producer Options: |
91 | |
d955ed82 |
92 | --template The path to the template |
93 | --tt-var var=value Pass extra variables to the template |
94 | --tt-conf option=value Pass extra config options to Template |
44598b94 |
95 | |
96 | XML-SQLFairy Producer Options: |
97 | |
af2301d7 |
98 | --add-prefix Use an explicit namespace prefix of 'sqlf:' |
99 | --prefix=<p> Use the namespace prefix given as argument. |
100 | --no-newlines Write the XML as a single line. |
101 | --indent=<n> Use <n> characters of whitespace to indent the XML. |
44598b94 |
102 | |
103 | =head1 DESCRIPTION |
104 | |
105 | This script is part of the SQL Fairy project. It will try to convert |
106 | any source file for which it has a grammar into any format for which |
107 | it has a producer. |
108 | |
af2301d7 |
109 | If using "show-warnings," be sure to redirect STDERR to a separate file. |
44598b94 |
110 | In bash, you could do this: |
111 | |
112 | $ sql_translator.pl -f MySQL -t PostgreSQL --show-warnings \ |
113 | file.sql 1>out 2>err |
114 | |
115 | You can specify a parser or producer located in any module that Perl |
116 | knows about, allowing you to easily substitute your own. |
117 | |
118 | =cut |
119 | |
120 | # ------------------------------------------------------------------- |
121 | |
16dc9970 |
122 | use strict; |
123 | use Getopt::Long; |
124 | use Pod::Usage; |
125 | use SQL::Translator; |
49e1eb70 |
126 | |
16dc9970 |
127 | use vars qw( $VERSION ); |
d955ed82 |
128 | $VERSION = sprintf "%d.%02d", q$Revision: 1.17 $ =~ /(\d+)\.(\d+)/; |
64ad4e66 |
129 | |
130 | my $from; # the original database |
af2301d7 |
131 | my $to; # the destination database |
64ad4e66 |
132 | my $help; # show POD and bail |
133 | my $stdin; # whether to read STDIN for create script |
134 | my $no_comments; # whether to put comments in out file |
135 | my $show_warnings; # whether to show warnings from SQL::Translator |
136 | my $add_drop_table; # whether to show warnings from SQL::Translator |
64ad4e66 |
137 | my $debug; # whether to print debug info |
138 | my $trace; # whether to print parser trace |
139 | my $list; # list all parsers and producers |
032bd3c7 |
140 | my $no_trim; # don't trim whitespace on xSV fields |
141 | my $no_scan; # don't scan xSV fields for data types and sizes |
64ad4e66 |
142 | my $field_separator; # for xSV files |
143 | my $record_separator; # for xSV files |
35d75351 |
144 | my $validate; # whether to validate the parsed document |
5cb879e2 |
145 | my $imap_file; # filename where to place image map coords |
146 | my $imap_url; # URL to use in making image map |
1ea530d4 |
147 | my $pretty; # use CGI::Pretty instead of CGI (HTML producer) |
8ac2c35e |
148 | my $template; # template to pass to TTSchema producer |
3658d749 |
149 | my %tt_vars; # additional template vars to pass the TTSchema producer |
d955ed82 |
150 | my %tt_conf; # additional template conf to pass the TTSchema producer |
44598b94 |
151 | my $title; # title for HTML/POD producer |
af2301d7 |
152 | my $add_prefix; # Use explicit namespace prefix (XML producer) |
153 | my $prefix; # Set explicit namespace prefix (XML producer) |
154 | my $newlines; # Add newlines around tags (XML producer) |
155 | my $indent; # Number of indent chars for XML |
156 | my $dsn; # DBI parser |
157 | my $db_user; # DBI parser |
158 | my $db_password; # DBI parser |
4ae3a779 |
159 | my $show_version; # Show version and exit script |
af2301d7 |
160 | my $skip; |
161 | my $skiplike; |
162 | my $dumper_db_user; |
e8aa1b67 |
163 | my $dumper_db_pass; |
164 | my $dumper_dsn; |
165 | my $add_truncate; |
16dc9970 |
166 | |
16dc9970 |
167 | GetOptions( |
e8aa1b67 |
168 | 'add-drop-table' => \$add_drop_table, |
e8aa1b67 |
169 | 'd|debug' => \$debug, |
e8aa1b67 |
170 | 'f|from|parser:s' => \$from, |
171 | 'fs:s' => \$field_separator, |
172 | 'h|help' => \$help, |
173 | 'imap-file:s' => \$imap_file, |
174 | 'imap-url:s' => \$imap_url, |
175 | 't|to|producer:s' => \$to, |
176 | 'l|list' => \$list, |
177 | 'pretty!' => \$pretty, |
178 | 'no-comments' => \$no_comments, |
179 | 'no-scan' => \$no_scan, |
180 | 'no-trim' => \$no_trim, |
181 | 'rs:s' => \$record_separator, |
182 | 'show-warnings' => \$show_warnings, |
183 | 'template:s' => \$template, |
3658d749 |
184 | 'tt-var=s' => \%tt_vars, |
d955ed82 |
185 | 'tt-conf=s' => \%tt_conf, |
e8aa1b67 |
186 | 'title:s' => \$title, |
187 | 'trace' => \$trace, |
188 | 'v|validate' => \$validate, |
189 | 'dsn:s' => \$dsn, |
190 | 'db-user:s' => \$db_user, |
191 | 'db-password:s' => \$db_password, |
192 | 'dumper-dsn:s' => \$dumper_dsn, |
193 | 'dumper-db-user:s' => \$dumper_db_user, |
194 | 'dumper-db-pass:s' => \$dumper_db_pass, |
195 | 'skip:s' => \$skip, |
196 | 'skiplike:s' => \$skiplike, |
197 | 'add_truncate' => \$add_truncate, |
af2301d7 |
198 | 'add-prefix' => \$add_prefix, |
199 | 'prefix:s' => \$prefix, |
200 | 'indent:s' => \$indent, |
201 | 'newlines!' => \$newlines, |
4ae3a779 |
202 | 'version' => \$show_version, |
16dc9970 |
203 | ) or pod2usage(2); |
204 | |
ec42851e |
205 | my @files = @ARGV; # source files |
b79348f4 |
206 | unless ( @files ) { |
d4becbfd |
207 | if ( defined($from) && $from eq 'DBI' ) { |
b79348f4 |
208 | @files = ('!'); |
209 | } |
210 | else { |
211 | @files = ('-'); |
212 | } |
213 | } |
16dc9970 |
214 | |
215 | pod2usage(1) if $help; |
d529894e |
216 | |
4ae3a779 |
217 | if ( $show_version ) { |
218 | print "SQL::Translator v", $SQL::Translator::VERSION, "\n"; |
219 | exit(0); |
220 | } |
221 | |
44598b94 |
222 | my $translator = SQL::Translator->new( |
223 | debug => $debug || 0, |
224 | trace => $trace || 0, |
225 | no_comments => $no_comments || 0, |
226 | show_warnings => $show_warnings || 0, |
227 | add_drop_table => $add_drop_table || 0, |
228 | validate => $validate || 0, |
229 | parser_args => { |
032bd3c7 |
230 | trim_fields => $no_trim ? 0 : 1, |
231 | scan_fields => $no_scan ? 0 : 1, |
64ad4e66 |
232 | field_separator => $field_separator, |
233 | record_separator => $record_separator, |
e107f4d2 |
234 | dsn => $dsn, |
235 | db_user => $db_user, |
236 | db_password => $db_password, |
5cb879e2 |
237 | }, |
238 | producer_args => { |
239 | imap_file => $imap_file, |
240 | imap_url => $imap_url, |
1ea530d4 |
241 | pretty => $pretty, |
8ac2c35e |
242 | ttfile => $template, |
3658d749 |
243 | tt_vars => \%tt_vars, |
d955ed82 |
244 | tt_conf => \%tt_conf, |
44598b94 |
245 | title => $title, |
e8aa1b67 |
246 | dsn => $dumper_dsn, |
247 | db_user => $dumper_db_user, |
248 | db_password => $dumper_db_pass, |
249 | skip => $skip, |
250 | skiplike => $skiplike, |
251 | add_truncate => $add_truncate, |
af2301d7 |
252 | add_prefix => $add_prefix, |
253 | prefix => $prefix, |
254 | indent => $indent, |
255 | newlines => $newlines, |
5cb879e2 |
256 | }, |
d529894e |
257 | ); |
258 | |
259 | if ( $list ) { |
260 | my @parsers = $translator->list_parsers; |
261 | my @producers = $translator->list_producers; |
262 | |
263 | for ( @parsers, @producers ) { |
264 | if ( $_ =~ m/.+::(\w+)\.pm/ ) { |
265 | $_ = $1; |
266 | } |
267 | } |
af2301d7 |
268 | |
d529894e |
269 | print "\nParsers:\n", map { "\t$_\n" } sort @parsers; |
270 | print "\nProducers:\n", map { "\t$_\n" } sort @producers; |
271 | print "\n"; |
272 | exit(0); |
273 | } |
274 | |
af2301d7 |
275 | pod2usage( msg => 'Please supply "from" and "to" arguments' ) |
515a6a58 |
276 | unless $from && $to; |
d529894e |
277 | |
783908a1 |
278 | $translator->parser($from); |
279 | $translator->producer($to); |
280 | |
281 | for my $file (@files) { |
b79348f4 |
282 | my @args = |
283 | ($file eq '-') ? (data => \*STDIN) : |
284 | ($file eq '!') ? (data => '') : |
285 | (file => $file); |
286 | |
2cd6675e |
287 | my $output = $translator->translate(@args) or die |
49e1eb70 |
288 | "Error: " . $translator->error; |
b79348f4 |
289 | |
49e1eb70 |
290 | print $output; |
783908a1 |
291 | } |
16dc9970 |
292 | |
49e1eb70 |
293 | # ---------------------------------------------------- |
16dc9970 |
294 | # It is not all books that are as dull as their readers. |
295 | # Henry David Thoreau |
49e1eb70 |
296 | # ---------------------------------------------------- |
16dc9970 |
297 | |
44598b94 |
298 | =pod |
96844cae |
299 | |
16dc9970 |
300 | =head1 AUTHOR |
301 | |
515a6a58 |
302 | Ken Y. Clark E<lt>kclark@cpan.orgE<gt>, |
303 | darren chamberlain E<lt>darren@cpan.orgE<gt>. |
16dc9970 |
304 | |
305 | =head1 SEE ALSO |
306 | |
515a6a58 |
307 | SQL::Translator, L<http://sqlfairy.sourceforge.net>. |
16dc9970 |
308 | |
309 | =cut |