lib/SQL/Translator/Parser/MySQL.pm

   1 package SQL::Translator::Parser::MySQL;
   2
   3 # -------------------------------------------------------------------
   4 # $Id: MySQL.pm,v 1.10 2003-01-29 13:28:28 dlc Exp $
   5 # -------------------------------------------------------------------
   6 # Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>,
   7 #                    darren chamberlain <darren@cpan.org>,
   8 #                    Chris Mungall <cjm@fruitfly.org>
   9 #
  10 # This program is free software; you can redistribute it and/or
  11 # modify it under the terms of the GNU General Public License as
  12 # published by the Free Software Foundation; version 2.
  13 #
  14 # This program is distributed in the hope that it will be useful, but
  15 # WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 # General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU General Public License
  20 # along with this program; if not, write to the Free Software
  21 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  22 # 02111-1307  USA
  23 # -------------------------------------------------------------------
  24
  25 =head1 NAME
  26
  27 SQL::Translator::Parser::MySQL - parser for MySQL
  28
  29 =head1 SYNOPSIS
  30
  31   use SQL::Translator;
  32   use SQL::Translator::Parser::MySQL;
  33
  34   my $translator = SQL::Translator->new;
  35   $translator->parser("SQL::Translator::Parser::MySQL");
  36
  37 =head1 DESCRIPTION
  38
  39 The grammar is influenced heavily by Tim Bunce's "mysql2ora" grammar.
  40
  41 =cut
  42
  43 use strict;
  44 use vars qw[ $DEBUG $VERSION $GRAMMAR @EXPORT_OK ];
  45 $VERSION = sprintf "%d.%02d", q$Revision: 1.10 $ =~ /(\d+)\.(\d+)/;
  46 $DEBUG   = 0 unless defined $DEBUG;
  47
  48 use Data::Dumper;
  49 use Parse::RecDescent;
  50 use Exporter;
  51 use base qw(Exporter);
  52
  53 @EXPORT_OK = qw(parse);
  54
  55 # Enable warnings within the Parse::RecDescent module.
  56 $::RD_ERRORS = 1; # Make sure the parser dies when it encounters an error
  57 $::RD_WARN   = 1; # Enable warnings. This will warn on unused rules &c.
  58 $::RD_HINT   = 1; # Give out hints to help fix problems.
  59
  60 my $parser; # should we do this?  There's no programmic way to
  61             # change the grammar, so I think this is safe.
  62
  63 $GRAMMAR = q!
  64
  65 { our ( %tables, $table_order ) }
  66
  67 startrule : statement(s) { \%tables }
  68
  69 statement : comment
  70     | drop
  71     | create
  72     | <error>
  73
  74 drop : /drop/i WORD(s) ';'
  75
  76 create : create_table table_name '(' create_definition(s /,/) ')' table_option(s?) ';'
  77     {
  78         my $table_name                       = $item{'table_name'};
  79         $tables{ $table_name }{'order'}      = ++$table_order;
  80         $tables{ $table_name }{'table_name'} = $table_name;
  81
  82         my $i = 1;
  83         for my $definition ( @{ $item[4] } ) {
  84             if ( $definition->{'type'} eq 'field' ) {
  85                 my $field_name = $definition->{'name'};
  86                 $tables{ $table_name }{'fields'}{ $field_name } =
  87                     { %$definition, order => $i };
  88                 $i++;
  89
  90                 if ( $definition->{'is_primary_key'} ) {
  91                     push @{ $tables{ $table_name }{'indices'} },
  92                         {
  93                             type   => 'primary_key',
  94                             fields => [ $field_name ],
  95                         }
  96                     ;
  97                 }
  98             }
  99             else {
 100                 push @{ $tables{ $table_name }{'indices'} },
 101                     $definition;
 102             }
 103         }
 104
 105         for my $opt ( @{ $item{'table_option'} } ) {
 106             if ( my ( $key, $val ) = each %$opt ) {
 107                 $tables{ $table_name }{'table_options'}{ $key } = $val;
 108             }
 109         }
 110     }
 111
 112 create : /CREATE/i unique(?) /(INDEX|KEY)/i index_name /on/i table_name '(' field_name(s /,/) ')' ';'
 113     {
 114         push @{ $tables{ $item{'table_name'} }{'indices'} },
 115             {
 116                 name   => $item[4],
 117                 type   => $item[2] ? 'unique' : 'normal',
 118                 fields => $item[8],
 119             }
 120         ;
 121     }
 122
 123 create_definition : index
 124     | field
 125     | <error>
 126
 127 comment : /^\s*(?:#|-{2}).*\n/
 128
 129 blank : /\s*/
 130
 131 field : field_name data_type field_qualifier(s?)
 132     {
 133         my %qualifiers = map { %$_ } @{ $item{'field_qualifier'} || [] };
 134         my $null = defined $item{'not_null'} ? $item{'not_null'} : 1;
 135         delete $qualifiers{'not_null'};
 136         if ( my @type_quals = @{ $item{'data_type'}{'qualifiers'} || [] } ) {
 137             $qualifiers{ $_ } = 1 for @type_quals;
 138         }
 139
 140         $return = {
 141             type           => 'field',
 142             name           => $item{'field_name'},
 143             data_type      => $item{'data_type'}{'type'},
 144             size           => $item{'data_type'}{'size'},
 145             list           => $item{'data_type'}{'list'},
 146             null           => $null,
 147             %qualifiers,
 148         }
 149     }
 150     | <error>
 151
 152 field_qualifier : not_null
 153     {
 154         $return = {
 155              null => $item{'not_null'},
 156         }
 157     }
 158
 159 field_qualifier : default_val
 160     {
 161         $return = {
 162              default => $item{'default_val'},
 163         }
 164     }
 165
 166 field_qualifier : auto_inc
 167     {
 168         $return = {
 169              is_auto_inc => $item{'auto_inc'},
 170         }
 171     }
 172
 173 field_qualifier : primary_key
 174     {
 175         $return = {
 176              is_primary_key => $item{'primary_key'},
 177         }
 178     }
 179
 180 field_qualifier : unsigned
 181     {
 182         $return = {
 183              is_unsigned => $item{'unsigned'},
 184         }
 185     }
 186
 187 index : primary_key_index
 188     | unique_index
 189     | normal_index
 190
 191 table_name   : WORD
 192
 193 field_name   : WORD
 194
 195 index_name   : WORD
 196
 197 data_type    : WORD parens_value_list(s?) type_qualifier(s?)
 198     {
 199         my $type = $item[1];
 200         my $size; # field size, applicable only to non-set fields
 201         my $list; # set list, applicable only to sets (duh)
 202
 203         if ( uc($type) =~ /^(SET|ENUM)$/ ) {
 204             $size = undef;
 205             $list = $item[2][0];
 206         }
 207         else {
 208             $size = $item[2][0];
 209             $list = [];
 210         }
 211
 212         $return        = {
 213             type       => $type,
 214             size       => $size,
 215             list       => $list,
 216             qualifiers => $item[3],
 217         }
 218     }
 219
 220 parens_value_list : '(' VALUE(s /,/) ')'
 221     { $item[2] }
 222
 223 type_qualifier : /(BINARY|UNSIGNED|ZEROFILL)/i
 224     { lc $item[1] }
 225
 226 field_type   : WORD
 227
 228 field_size   : '(' num_range ')' { $item{'num_range'} }
 229
 230 num_range    : DIGITS ',' DIGITS
 231     { $return = $item[1].','.$item[3] }
 232     | DIGITS
 233     { $return = $item[1] }
 234
 235 create_table : /create/i /table/i
 236
 237 create_index : /create/i /index/i
 238
 239 not_null     : /not/i /null/i { $return = 0 }
 240
 241 unsigned     : /unsigned/i { $return = 0 }
 242
 243 default_val  : /default/i /(?:')?[\w\d.-]*(?:')?/
 244     {
 245         $item[2] =~ s/'//g;
 246         $return  =  $item[2];
 247     }
 248
 249 auto_inc : /auto_increment/i { 1 }
 250
 251 primary_key : /primary/i /key/i { 1 }
 252
 253 primary_key_index : primary_key index_name(?) '(' field_name(s /,/) ')'
 254     {
 255         $return    = {
 256             name   => $item{'index_name'}[0],
 257             type   => 'primary_key',
 258             fields => $item[4],
 259         }
 260     }
 261
 262 normal_index : key index_name(?) '(' name_with_opt_paren(s /,/) ')'
 263     {
 264         $return    = {
 265             name   => $item{'index_name'}[0],
 266             type   => 'normal',
 267             fields => $item[4],
 268         }
 269     }
 270
 271 unique_index : unique key(?) index_name(?) '(' name_with_opt_paren(s /,/) ')'
 272     {
 273         $return    = {
 274             name   => $item{'index_name'}[0],
 275             type   => 'unique',
 276             fields => $item[5],
 277         }
 278     }
 279
 280 name_with_opt_paren : NAME parens_value_list(s?)
 281     { $item[2][0] ? "$item[1]($item[2][0][0])" : $item[1] }
 282
 283 unique : /unique/i { 1 }
 284
 285 key : /key/i | /index/i
 286
 287 table_option : /[^\s;]*/
 288     {
 289         $return = { split /=/, $item[1] }
 290     }
 291
 292 WORD : /\w+/
 293
 294 DIGITS : /\d+/
 295
 296 COMMA : ','
 297
 298 NAME    : "`" /\w+/ "`"
 299     { $item[2] }
 300     | /\w+/
 301     { $item[1] }
 302
 303 VALUE   : /[-+]?\.?\d+(?:[eE]\d+)?/
 304     { $item[1] }
 305     | /'.*?'/   # XXX doesn't handle embedded quotes
 306     { $item[1] }
 307     | /NULL/
 308     { 'NULL' }
 309
 310 !;
 311
 312 # -------------------------------------------------------------------
 313 sub parse {
 314     my ( $translator, $data ) = @_;
 315     $parser ||= Parse::RecDescent->new($GRAMMAR);
 316
 317     $::RD_TRACE  = $translator->trace ? 1 : undef;
 318     $DEBUG       = $translator->debug;
 319
 320     unless (defined $parser) {
 321         return $translator->error("Error instantiating Parse::RecDescent ".
 322             "instance: Bad grammer");
 323     }
 324
 325     my $result = $parser->startrule($data);
 326     die "Parse failed.\n" unless defined $result;
 327     warn Dumper($result) if $DEBUG;
 328     return $result;
 329 }
 330
 331 1;
 332
 333 #-----------------------------------------------------
 334 # Where man is not nature is barren.
 335 # William Blake
 336 #-----------------------------------------------------
 337
 338 =pod
 339
 340 =head1 AUTHOR
 341
 342 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>,
 343 Chris Mungall
 344
 345 =head1 SEE ALSO
 346
 347 perl(1), Parse::RecDescent.
 348
 349 =cut