1 package SQL::Translator::Parser::MySQL;
3 # -------------------------------------------------------------------
4 # $Id: MySQL.pm,v 1.18 2003-05-09 19:51:04 kycl4rk Exp $
5 # -------------------------------------------------------------------
6 # Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>,
7 # darren chamberlain <darren@cpan.org>,
8 # Chris Mungall <cjm@fruitfly.org>
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.
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.
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
23 # -------------------------------------------------------------------
27 SQL::Translator::Parser::MySQL - parser for MySQL
32 use SQL::Translator::Parser::MySQL;
34 my $translator = SQL::Translator->new;
35 $translator->parser("SQL::Translator::Parser::MySQL");
39 The grammar is influenced heavily by Tim Bunce's "mysql2ora" grammar.
41 Here's the word from the MySQL site
42 (http://www.mysql.com/doc/en/CREATE_TABLE.html):
44 CREATE [TEMPORARY] TABLE [IF NOT EXISTS] tbl_name [(create_definition,...)]
45 [table_options] [select_statement]
49 CREATE [TEMPORARY] TABLE [IF NOT EXISTS] tbl_name LIKE old_table_name;
52 col_name type [NOT NULL | NULL] [DEFAULT default_value] [AUTO_INCREMENT]
53 [PRIMARY KEY] [reference_definition]
54 or PRIMARY KEY (index_col_name,...)
55 or KEY [index_name] (index_col_name,...)
56 or INDEX [index_name] (index_col_name,...)
57 or UNIQUE [INDEX] [index_name] (index_col_name,...)
58 or FULLTEXT [INDEX] [index_name] (index_col_name,...)
59 or [CONSTRAINT symbol] FOREIGN KEY [index_name] (index_col_name,...)
60 [reference_definition]
64 TINYINT[(length)] [UNSIGNED] [ZEROFILL]
65 or SMALLINT[(length)] [UNSIGNED] [ZEROFILL]
66 or MEDIUMINT[(length)] [UNSIGNED] [ZEROFILL]
67 or INT[(length)] [UNSIGNED] [ZEROFILL]
68 or INTEGER[(length)] [UNSIGNED] [ZEROFILL]
69 or BIGINT[(length)] [UNSIGNED] [ZEROFILL]
70 or REAL[(length,decimals)] [UNSIGNED] [ZEROFILL]
71 or DOUBLE[(length,decimals)] [UNSIGNED] [ZEROFILL]
72 or FLOAT[(length,decimals)] [UNSIGNED] [ZEROFILL]
73 or DECIMAL(length,decimals) [UNSIGNED] [ZEROFILL]
74 or NUMERIC(length,decimals) [UNSIGNED] [ZEROFILL]
75 or CHAR(length) [BINARY]
76 or VARCHAR(length) [BINARY]
89 or ENUM(value1,value2,value3,...)
90 or SET(value1,value2,value3,...)
96 REFERENCES tbl_name [(index_col_name,...)]
97 [MATCH FULL | MATCH PARTIAL]
98 [ON DELETE reference_option]
99 [ON UPDATE reference_option]
102 RESTRICT | CASCADE | SET NULL | NO ACTION | SET DEFAULT
105 TYPE = {BDB | HEAP | ISAM | InnoDB | MERGE | MRG_MYISAM | MYISAM }
106 or AUTO_INCREMENT = #
107 or AVG_ROW_LENGTH = #
108 or CHECKSUM = {0 | 1}
109 or COMMENT = "string"
112 or PACK_KEYS = {0 | 1 | DEFAULT}
113 or PASSWORD = "string"
114 or DELAY_KEY_WRITE = {0 | 1}
115 or ROW_FORMAT= { default | dynamic | fixed | compressed }
116 or RAID_TYPE= {1 | STRIPED | RAID0 } RAID_CHUNKS=# RAID_CHUNKSIZE=#
117 or UNION = (table_name,[table_name...])
118 or INSERT_METHOD= {NO | FIRST | LAST }
119 or DATA DIRECTORY="absolute path to directory"
120 or INDEX DIRECTORY="absolute path to directory"
125 use vars qw[ $DEBUG $VERSION $GRAMMAR @EXPORT_OK ];
126 $VERSION = sprintf "%d.%02d", q$Revision: 1.18 $ =~ /(\d+)\.(\d+)/;
127 $DEBUG = 0 unless defined $DEBUG;
130 use Parse::RecDescent;
132 use base qw(Exporter);
134 @EXPORT_OK = qw(parse);
136 # Enable warnings within the Parse::RecDescent module.
137 $::RD_ERRORS = 1; # Make sure the parser dies when it encounters an error
138 $::RD_WARN = 1; # Enable warnings. This will warn on unused rules &c.
139 $::RD_HINT = 1; # Give out hints to help fix problems.
141 my $parser; # should we do this? There's no programmic way to
142 # change the grammar, so I think this is safe.
147 our ( %tables, $table_order );
151 # The "eofile" rule makes the parser fail if any "statement" rule
152 # fails. Otherwise, the first successful match by a "statement"
153 # won't cause the failure needed to know that the parse, as a whole,
156 startrule : statement(s) eofile { \%tables }
165 drop : /drop/i WORD(s) ';'
167 create : create_table table_name '(' create_definition(s /,/) ')' table_option(s?) ';'
169 my $table_name = $item{'table_name'};
170 $tables{ $table_name }{'order'} = ++$table_order;
171 $tables{ $table_name }{'table_name'} = $table_name;
174 for my $definition ( @{ $item[4] } ) {
175 if ( $definition->{'type'} eq 'field' ) {
176 my $field_name = $definition->{'name'};
177 $tables{ $table_name }{'fields'}{ $field_name } =
178 { %$definition, order => $i };
181 if ( $definition->{'is_primary_key'} ) {
182 push @{ $tables{ $table_name }{'indices'} },
184 type => 'primary_key',
185 fields => [ $field_name ],
191 push @{ $tables{ $table_name }{'indices'} },
196 for my $opt ( @{ $item{'table_option(s?)'} } ) {
197 if ( my ( $key, $val ) = each %$opt ) {
198 $tables{ $table_name }{'table_options'}{ $key } = $val;
205 create : /CREATE/i unique(?) /(INDEX|KEY)/i index_name /on/i table_name '(' field_name(s /,/) ')' ';'
207 push @{ $tables{ $item{'table_name'} }{'indices'} },
210 type => $item[2] ? 'unique' : 'normal',
216 create_definition : index
220 comment : /^\s*(?:#|-{2}).*\n/
224 field : field_name data_type field_qualifier(s?) reference_definition(?)
226 my %qualifiers = map { %$_ } @{ $item{'field_qualifier(s?)'} || [] };
227 my $null = defined $item{'not_null'} ? $item{'not_null'} : 1;
228 delete $qualifiers{'not_null'};
229 if ( my @type_quals = @{ $item{'data_type'}{'qualifiers'} || [] } ) {
230 $qualifiers{ $_ } = 1 for @type_quals;
235 name => $item{'field_name'},
236 data_type => $item{'data_type'}{'type'},
237 size => $item{'data_type'}{'size'},
238 list => $item{'data_type'}{'list'},
240 constraints => $item{'reference_definition(?)'},
246 field_qualifier : not_null
249 null => $item{'not_null'},
253 field_qualifier : default_val
256 default => $item{'default_val'},
260 field_qualifier : auto_inc
263 is_auto_inc => $item{'auto_inc'},
267 field_qualifier : primary_key
270 is_primary_key => $item{'primary_key'},
274 field_qualifier : unsigned
277 is_unsigned => $item{'unsigned'},
281 reference_definition : /references/i table_name parens_field_list(?) match_type(?) on_delete_do(?) on_update_do(?)
284 type => 'foreign_key',
285 reference_table => $item[2],
286 reference_fields => $item[3][0],
287 match_type => $item[4][0],
288 on_delete_do => $item[5][0],
289 on_update_do => $item[6][0],
293 match_type : /match full/i { 'match_full' }
295 /match partial/i { 'match_partial' }
297 on_delete_do : /on delete/i reference_option
300 on_update_do : /on update/i reference_option
303 reference_option: /restrict/i |
310 index : primary_key_index
322 data_type : WORD parens_value_list(s?) type_qualifier(s?)
325 my $size; # field size, applicable only to non-set fields
326 my $list; # set list, applicable only to sets (duh)
328 if ( uc($type) =~ /^(SET|ENUM)$/ ) {
341 qualifiers => $item[3],
345 parens_field_list : '(' field_name(s /,/) ')'
348 parens_value_list : '(' VALUE(s /,/) ')'
351 type_qualifier : /(BINARY|UNSIGNED|ZEROFILL)/i
356 field_size : '(' num_range ')' { $item{'num_range'} }
358 num_range : DIGITS ',' DIGITS
359 { $return = $item[1].','.$item[3] }
361 { $return = $item[1] }
363 create_table : /create/i /table/i
365 create_index : /create/i /index/i
367 not_null : /not/i /null/i { $return = 0 }
369 unsigned : /unsigned/i { $return = 0 }
371 default_val : /default/i /(?:')?[\w\d:.-]*(?:')?/
377 auto_inc : /auto_increment/i { 1 }
379 primary_key : /primary/i /key/i { 1 }
381 primary_key_index : primary_key index_name(?) '(' field_name(s /,/) ')'
384 name => $item{'index_name(?)'}[0],
385 type => 'primary_key',
390 normal_index : key index_name(?) '(' name_with_opt_paren(s /,/) ')'
393 name => $item{'index_name(?)'}[0],
399 unique_index : unique key(?) index_name(?) '(' name_with_opt_paren(s /,/) ')'
402 name => $item{'index_name(?)'}[0],
408 fulltext_index : fulltext key(?) index_name(?) '(' name_with_opt_paren(s /,/) ')'
411 name => $item{'index_name(?)'}[0],
417 name_with_opt_paren : NAME parens_value_list(s?)
418 { $item[2][0] ? "$item[1]($item[2][0][0])" : $item[1] }
420 fulltext : /fulltext/i { 1 }
422 unique : /unique/i { 1 }
424 key : /key/i | /index/i
426 table_option : /[^\s;]*/
428 $return = { split /=/, $item[1] }
442 VALUE : /[-+]?\.?\d+(?:[eE]\d+)?/
444 | /'.*?'/ # XXX doesn't handle embedded quotes
451 # attribute => $item[2]
457 # -------------------------------------------------------------------
459 my ( $translator, $data ) = @_;
460 $parser ||= Parse::RecDescent->new($GRAMMAR);
462 local $::RD_TRACE = $translator->trace ? 1 : undef;
463 local $DEBUG = $translator->debug;
465 unless (defined $parser) {
466 return $translator->error("Error instantiating Parse::RecDescent ".
467 "instance: Bad grammer");
470 my $result = $parser->startrule($data);
471 die "Parse failed.\n" unless defined $result;
472 warn Dumper( $result ) if $DEBUG;
474 my $schema = $translator->schema;
475 for my $table_name ( keys %{ $result } ) {
476 my $tdata = $result->{ $table_name };
477 my $table = $schema->add_table(
478 name => $tdata->{'table_name'},
482 $tdata->{'fields'}->{$a}->{'order'}
484 $tdata->{'fields'}->{$b}->{'order'}
485 } keys %{ $tdata->{'fields'} };
487 for my $fname ( @fields ) {
488 my $fdata = $tdata->{'fields'}{ $fname };
489 my $field = $table->add_field(
490 name => $fdata->{'name'},
491 data_type => $fdata->{'data_type'},
492 size => $fdata->{'size'},
493 default_value => $fdata->{'default'},
494 is_auto_increment => $fdata->{'is_auto_inc'},
495 is_nullable => $fdata->{'null'},
505 # ----------------------------------------------------
506 # Where man is not nature is barren.
508 # ----------------------------------------------------
514 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>,
515 Chris Mungall E<lt>cjm@fruitfly.orgE<gt>.
519 perl(1), Parse::RecDescent, SQL::Translator::Schema.