bin/sql_translator.pl

   1 #!/usr/bin/perl -w
   2
   3 # -------------------------------------------------------------------
   4 # $Id: sql_translator.pl,v 1.12 2003-08-20 13:50:46 dlc Exp $
   5 # -------------------------------------------------------------------
   6 # Copyright (C) 2002 Ken Y. Clark <kycl4rk@users.sourceforge.net>,
   7 #                    darren chamberlain <darren@cpan.org>
   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 # -------------------------------------------------------------------
  23
  24 use strict;
  25 use Getopt::Long;
  26 use Pod::Usage;
  27 use SQL::Translator;
  28
  29 use Data::Dumper;
  30
  31 use vars qw( $VERSION );
  32 $VERSION = sprintf "%d.%02d", q$Revision: 1.12 $ =~ /(\d+)\.(\d+)/;
  33
  34 my $from;             # the original database
  35 my $to;               # the destination database
  36 my $help;             # show POD and bail
  37 my $stdin;            # whether to read STDIN for create script
  38 my $no_comments;      # whether to put comments in out file
  39 my $show_warnings;    # whether to show warnings from SQL::Translator
  40 my $add_drop_table;   # whether to show warnings from SQL::Translator
  41 my $debug;            # whether to print debug info
  42 my $trace;            # whether to print parser trace
  43 my $list;             # list all parsers and producers
  44 my $no_trim;          # don't trim whitespace on xSV fields
  45 my $no_scan;          # don't scan xSV fields for data types and sizes
  46 my $field_separator;  # for xSV files
  47 my $record_separator; # for xSV files
  48 my $validate;         # whether to validate the parsed document
  49 my $imap_file;        # filename where to place image map coords
  50 my $imap_url;         # URL to use in making image map
  51 my $pretty;           # use CGI::Pretty instead of CGI (HTML producer)
  52
  53 #
  54 # Get options, explain how to use the script if necessary.
  55 #
  56 GetOptions(
  57     'f|from|parser:s' => \$from,
  58     't|to|producer:s' => \$to,
  59     'h|help'          => \$help,
  60     'l|list'          => \$list,
  61     'd|debug'         => \$debug,
  62     'trace'           => \$trace,
  63     'no-comments'     => \$no_comments,
  64     'show-warnings'   => \$show_warnings,
  65     'add-drop-table'  => \$add_drop_table,
  66     'v|validate'      => \$validate,
  67     'no-trim'         => \$no_trim,
  68     'no-scan'         => \$no_scan,
  69     'fs:s'            => \$field_separator,
  70     'rs:s'            => \$record_separator,
  71     'imap-file:s'     => \$imap_file,
  72     'imap-url:s'      => \$imap_url,
  73     'pretty!'         => \$pretty,
  74 ) or pod2usage(2);
  75
  76 my @files = @ARGV; # the create script(s) for the original db
  77
  78 pod2usage(1) if $help;
  79
  80 #
  81 # If everything is OK, translate file(s).
  82 #
  83 my $translator      =  SQL::Translator->new(
  84     debug           => $debug          ||  0,
  85     trace           => $trace          ||  0,
  86     no_comments     => $no_comments    ||  0,
  87     show_warnings   => $show_warnings  ||  0,
  88     add_drop_table  => $add_drop_table ||  0,
  89     validate        => $validate       ||  0,
  90     parser_args     => {
  91         trim_fields      => $no_trim ? 0 : 1,
  92         scan_fields      => $no_scan ? 0 : 1,
  93         field_separator  => $field_separator,
  94         record_separator => $record_separator,
  95     },
  96     producer_args   => {
  97         imap_file        => $imap_file,
  98         imap_url         => $imap_url,
  99         pretty           => $pretty,
 100     },
 101 );
 102
 103 if ( $list ) {
 104     my @parsers   = $translator->list_parsers;
 105     my @producers = $translator->list_producers;
 106
 107     for ( @parsers, @producers ) {
 108         if ( $_ =~ m/.+::(\w+)\.pm/ ) {
 109             $_ = $1;
 110         }
 111     }
 112
 113     print "\nParsers:\n",   map { "\t$_\n" } sort @parsers;
 114     print "\nProducers:\n", map { "\t$_\n" } sort @producers;
 115     print "\n";
 116     exit(0);
 117 }
 118
 119 pod2usage(2) unless $from && $to && @files;
 120
 121 $translator->parser($from);
 122 $translator->producer($to);
 123
 124 for my $file (@files) {
 125     my $output = $translator->translate(file => $file) or die
 126         "Error: " . $translator->error;
 127     print $output;
 128 }
 129
 130 # ----------------------------------------------------
 131 # It is not all books that are as dull as their readers.
 132 # Henry David Thoreau
 133 # ----------------------------------------------------
 134
 135 =head1 NAME
 136
 137 sql_translator.pl - convert an SQL database schema
 138
 139 =head1 SYNOPSIS
 140
 141 For help:
 142
 143   ./sql_translator.pl -h|--help
 144
 145 For a list of all parsers and producers:
 146
 147   ./sql_translator.pl -l|--list
 148
 149 To translate a schema:
 150
 151   ./sql_translator.pl
 152         -f|--from|--parser MySQL
 153         -t|--to|--producer Oracle
 154         [options]
 155         file
 156
 157   Options:
 158
 159     -d|--debug            Print debug info
 160     -v|--validate         Validate the schema
 161     --trace               Print parser trace info
 162     --no-comments         Don't include comments in SQL output
 163     --show-warnings       Print to STDERR warnings of conflicts, etc.
 164     --add-drop-table      Add 'drop table' statements before creates
 165
 166   xSV Options:
 167
 168     --fs                  The field separator
 169     --rs                  The record separator
 170     --no-trim             Don't trim whitespace on fields
 171     --no-scan             Don't scan fields for data types and sizes
 172
 173   Diagram Options:
 174
 175     --imap-file           Filename to put image map data
 176     --imap-url            URL to use for image map
 177
 178 =head1 DESCRIPTION
 179
 180 This script is part of the SQL Fairy project
 181 (http://sqlfairy.sourceforge.net/).  It will try to convert any
 182 database syntax for which it has a grammar into some other format it
 183 knows about.
 184
 185 If using "show-warnings," be sure to redirect STDERR to a separate file.
 186 In bash, you could do this:
 187
 188     $ sql_translator.pl -f MySQL -t PostgreSQL --show-warnings file.sql \
 189        1>out 2>err
 190
 191 =head1 AUTHOR
 192
 193 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>
 194
 195 =head1 SEE ALSO
 196
 197 SQL::Translator.
 198
 199 =cut