1 package SQL::Translator::Parser::MySQL;
3 # -------------------------------------------------------------------
4 # $Id: MySQL.pm,v 1.58 2007-03-19 17:15:24 duality72 Exp $
5 # -------------------------------------------------------------------
6 # Copyright (C) 2002-4 SQLFairy Authors
8 # This program is free software; you can redistribute it and/or
9 # modify it under the terms of the GNU General Public License as
10 # published by the Free Software Foundation; version 2.
12 # This program is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program; if not, write to the Free Software
19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
21 # -------------------------------------------------------------------
25 SQL::Translator::Parser::MySQL - parser for MySQL
30 use SQL::Translator::Parser::MySQL;
32 my $translator = SQL::Translator->new;
33 $translator->parser("SQL::Translator::Parser::MySQL");
37 The grammar is influenced heavily by Tim Bunce's "mysql2ora" grammar.
39 Here's the word from the MySQL site
40 (http://www.mysql.com/doc/en/CREATE_TABLE.html):
42 CREATE [TEMPORARY] TABLE [IF NOT EXISTS] tbl_name [(create_definition,...)]
43 [table_options] [select_statement]
47 CREATE [TEMPORARY] TABLE [IF NOT EXISTS] tbl_name LIKE old_table_name;
50 col_name type [NOT NULL | NULL] [DEFAULT default_value] [AUTO_INCREMENT]
51 [PRIMARY KEY] [reference_definition]
52 or PRIMARY KEY (index_col_name,...)
53 or KEY [index_name] (index_col_name,...)
54 or INDEX [index_name] (index_col_name,...)
55 or UNIQUE [INDEX] [index_name] (index_col_name,...)
56 or FULLTEXT [INDEX] [index_name] (index_col_name,...)
57 or [CONSTRAINT symbol] FOREIGN KEY [index_name] (index_col_name,...)
58 [reference_definition]
62 TINYINT[(length)] [UNSIGNED] [ZEROFILL]
63 or SMALLINT[(length)] [UNSIGNED] [ZEROFILL]
64 or MEDIUMINT[(length)] [UNSIGNED] [ZEROFILL]
65 or INT[(length)] [UNSIGNED] [ZEROFILL]
66 or INTEGER[(length)] [UNSIGNED] [ZEROFILL]
67 or BIGINT[(length)] [UNSIGNED] [ZEROFILL]
68 or REAL[(length,decimals)] [UNSIGNED] [ZEROFILL]
69 or DOUBLE[(length,decimals)] [UNSIGNED] [ZEROFILL]
70 or FLOAT[(length,decimals)] [UNSIGNED] [ZEROFILL]
71 or DECIMAL(length,decimals) [UNSIGNED] [ZEROFILL]
72 or NUMERIC(length,decimals) [UNSIGNED] [ZEROFILL]
73 or CHAR(length) [BINARY]
74 or VARCHAR(length) [BINARY]
87 or ENUM(value1,value2,value3,...)
88 or SET(value1,value2,value3,...)
94 REFERENCES tbl_name [(index_col_name,...)]
95 [MATCH FULL | MATCH PARTIAL]
96 [ON DELETE reference_option]
97 [ON UPDATE reference_option]
100 RESTRICT | CASCADE | SET NULL | NO ACTION | SET DEFAULT
103 TYPE = {BDB | HEAP | ISAM | InnoDB | MERGE | MRG_MYISAM | MYISAM }
104 or AUTO_INCREMENT = #
105 or AVG_ROW_LENGTH = #
106 or CHECKSUM = {0 | 1}
107 or COMMENT = "string"
110 or PACK_KEYS = {0 | 1 | DEFAULT}
111 or PASSWORD = "string"
112 or DELAY_KEY_WRITE = {0 | 1}
113 or ROW_FORMAT= { default | dynamic | fixed | compressed }
114 or RAID_TYPE= {1 | STRIPED | RAID0 } RAID_CHUNKS=# RAID_CHUNKSIZE=#
115 or UNION = (table_name,[table_name...])
116 or INSERT_METHOD= {NO | FIRST | LAST }
117 or DATA DIRECTORY="absolute path to directory"
118 or INDEX DIRECTORY="absolute path to directory"
120 A subset of the ALTER TABLE syntax that allows addition of foreign keys:
122 ALTER [IGNORE] TABLE tbl_name alter_specification [, alter_specification] ...
125 ADD [CONSTRAINT [symbol]]
126 FOREIGN KEY [index_name] (index_col_name,...)
127 [reference_definition]
129 A subset of INSERT that we ignore:
136 use vars qw[ $DEBUG $VERSION $GRAMMAR @EXPORT_OK ];
137 $VERSION = sprintf "%d.%02d", q$Revision: 1.58 $ =~ /(\d+)\.(\d+)/;
138 $DEBUG = 0 unless defined $DEBUG;
141 use Parse::RecDescent;
143 use Storable qw(dclone);
144 use DBI qw(:sql_types);
145 use base qw(Exporter);
147 our %type_mapping = (
150 @EXPORT_OK = qw(parse);
152 # Enable warnings within the Parse::RecDescent module.
153 $::RD_ERRORS = 1; # Make sure the parser dies when it encounters an error
154 $::RD_WARN = 1; # Enable warnings. This will warn on unused rules &c.
155 $::RD_HINT = 1; # Give out hints to help fix problems.
157 use constant DEFAULT_PARSER_VERSION => 30000;
159 $GRAMMAR = << 'END_OF_GRAMMAR';
162 my ( $database_name, %tables, $table_order, @table_comments, %views, $view_order, %procedures, $proc_order );
167 # The "eofile" rule makes the parser fail if any "statement" rule
168 # fails. Otherwise, the first successful match by a "statement"
169 # won't cause the failure needed to know that the parse, as a whole,
172 startrule : statement(s) eofile {
173 { tables => \%tables, database_name => $database_name, views => \%views, procedures =>\%procedures }
189 use : /use/i WORD "$delimiter"
191 $database_name = $item[2];
192 @table_comments = ();
195 set : /set/i /[^;]+/ "$delimiter"
196 { @table_comments = () }
198 drop : /drop/i TABLE /[^;]+/ "$delimiter"
200 drop : /drop/i WORD(s) "$delimiter"
201 { @table_comments = () }
204 # MySQL strings, unlike common SQL strings, can be double-quoted or
205 # single-quoted, and you can escape the delmiters by doubling (but only the
206 # delimiter) or by backslashing.
208 /'(\\.|''|[^\\\'])*'/ |
209 /"(\\.|""|[^\\\"])*"/
210 # For reference, std sql str: /(?:(?:\')(?:[^\']*(?:(?:\'\')[^\']*)*)(?:\'))//
212 nonstring : /[^;\'"]+/
214 statement_body : (string | nonstring)(s?)
216 insert : /insert/i statement_body "$delimiter"
218 delimiter : /delimiter/i /[\S]+/
219 { $delimiter = $item[2] }
221 empty_statement : "$delimiter"
223 alter : ALTER TABLE table_name alter_specification(s /,/) "$delimiter"
225 my $table_name = $item{'table_name'};
226 die "Cannot ALTER table '$table_name'; it does not exist"
227 unless $tables{ $table_name };
228 for my $definition ( @{ $item[4] } ) {
229 $definition->{'extra'}->{'alter'} = 1;
230 push @{ $tables{ $table_name }{'constraints'} }, $definition;
234 alter_specification : ADD foreign_key_def
235 { $return = $item[2] }
237 create : CREATE /database/i WORD "$delimiter"
238 { @table_comments = () }
240 create : CREATE TEMPORARY(?) TABLE opt_if_not_exists(?) table_name '(' create_definition(s /,/) /(,\s*)?\)/ table_option(s?) "$delimiter"
242 my $table_name = $item{'table_name'};
243 $tables{ $table_name }{'order'} = ++$table_order;
244 $tables{ $table_name }{'table_name'} = $table_name;
246 if ( @table_comments ) {
247 $tables{ $table_name }{'comments'} = [ @table_comments ];
248 @table_comments = ();
252 for my $definition ( @{ $item[7] } ) {
253 if ( $definition->{'supertype'} eq 'field' ) {
254 my $field_name = $definition->{'name'};
255 $tables{ $table_name }{'fields'}{ $field_name } =
256 { %$definition, order => $i };
259 if ( $definition->{'is_primary_key'} ) {
260 push @{ $tables{ $table_name }{'constraints'} },
262 type => 'primary_key',
263 fields => [ $field_name ],
268 elsif ( $definition->{'supertype'} eq 'constraint' ) {
269 push @{ $tables{ $table_name }{'constraints'} }, $definition;
271 elsif ( $definition->{'supertype'} eq 'index' ) {
272 push @{ $tables{ $table_name }{'indices'} }, $definition;
276 if ( my @options = @{ $item{'table_option(s?)'} } ) {
277 for my $option ( @options ) {
278 my ( $key, $value ) = each %$option;
279 if ( $key eq 'comment' ) {
280 push @{ $tables{ $table_name }{'comments'} }, $value;
283 push @{ $tables{ $table_name }{'table_options'} }, $option;
291 opt_if_not_exists : /if not exists/i
293 create : CREATE UNIQUE(?) /(index|key)/i index_name /on/i table_name '(' field_name(s /,/) ')' "$delimiter"
295 @table_comments = ();
296 push @{ $tables{ $item{'table_name'} }{'indices'} },
299 type => $item[2] ? 'unique' : 'normal',
305 create : CREATE /trigger/i NAME not_delimiter "$delimiter"
307 @table_comments = ();
310 create : CREATE PROCEDURE NAME not_delimiter "$delimiter"
312 @table_comments = ();
313 my $func_name = $item[3];
315 my $sql = "$item[1] $item[2] $item[3] $item[4]";
317 $procedures{ $func_name }{'order'} = ++$proc_order;
318 $procedures{ $func_name }{'name'} = $func_name;
319 $procedures{ $func_name }{'owner'} = $owner;
320 $procedures{ $func_name }{'sql'} = $sql;
323 PROCEDURE : /procedure/i
326 create : CREATE algorithm /view/i NAME not_delimiter "$delimiter"
328 @table_comments = ();
329 my $view_name = $item[4];
330 my $sql = "$item[1] $item[2] $item[3] $item[4] $item[5]";
332 # Hack to strip database from function calls in SQL
333 $sql =~ s#`\w+`\.(`\w+`\()##g;
335 $views{ $view_name }{'order'} = ++$view_order;
336 $views{ $view_name }{'name'} = $view_name;
337 $views{ $view_name }{'sql'} = $sql;
340 algorithm : /algorithm/i /=/ WORD
342 $return = "$item[1]=$item[3]";
345 not_delimiter : /.*?(?=$delimiter)/is
347 create_definition : constraint
353 comment : /^\s*(?:#|-{2}).*\n/
355 my $comment = $item[1];
356 $comment =~ s/^\s*(#|--)\s*//;
357 $comment =~ s/\s*$//;
361 comment : /\/\*/ /.*?\*\//s
363 my $comment = $item[2];
364 $comment = substr($comment, 0, -2);
365 $comment =~ s/^\s*|\s*$//g;
369 field_comment : /^\s*(?:#|-{2}).*\n/
371 my $comment = $item[1];
372 $comment =~ s/^\s*(#|--)\s*//;
373 $comment =~ s/\s*$//;
378 field_comment2 : /comment/i /'.*?'/
380 my $comment = $item[2];
388 field : field_comment(s?) field_name data_type field_qualifier(s?) field_comment2(?) reference_definition(?) on_update(?) field_comment(s?)
390 my %qualifiers = map { %$_ } @{ $item{'field_qualifier(s?)'} || [] };
391 if ( my @type_quals = @{ $item{'data_type'}{'qualifiers'} || [] } ) {
392 $qualifiers{ $_ } = 1 for @type_quals;
395 my $null = defined $qualifiers{'not_null'}
396 ? $qualifiers{'not_null'} : 1;
397 delete $qualifiers{'not_null'};
399 my @comments = ( @{ $item[1] }, @{ $item[5] }, @{ $item[8] } );
402 supertype => 'field',
403 name => $item{'field_name'},
404 data_type => $item{'data_type'}{'type'},
405 size => $item{'data_type'}{'size'},
406 list => $item{'data_type'}{'list'},
408 constraints => $item{'reference_definition(?)'},
409 comments => [ @comments ],
415 field_qualifier : not_null
418 null => $item{'not_null'},
422 field_qualifier : default_val
425 default => $item{'default_val'},
429 field_qualifier : auto_inc
432 is_auto_inc => $item{'auto_inc'},
436 field_qualifier : primary_key
439 is_primary_key => $item{'primary_key'},
443 field_qualifier : unsigned
446 is_unsigned => $item{'unsigned'},
450 field_qualifier : /character set/i WORD
453 'CHARACTER SET' => $item[2],
457 field_qualifier : /collate/i WORD
464 field_qualifier : /on update/i CURRENT_TIMESTAMP
467 'ON UPDATE' => $item[2],
471 field_qualifier : /unique/i KEY(?)
478 field_qualifier : KEY
485 reference_definition : /references/i table_name parens_field_list(?) match_type(?) on_delete(?) on_update(?)
488 type => 'foreign_key',
489 reference_table => $item[2],
490 reference_fields => $item[3][0],
491 match_type => $item[4][0],
492 on_delete => $item[5][0],
493 on_update => $item[6][0],
497 match_type : /match full/i { 'full' }
499 /match partial/i { 'partial' }
501 on_delete : /on delete/i reference_option
505 /on update/i 'CURRENT_TIMESTAMP'
508 /on update/i reference_option
511 reference_option: /restrict/i |
528 data_type : WORD parens_value_list(s?) type_qualifier(s?)
531 my $size; # field size, applicable only to non-set fields
532 my $list; # set list, applicable only to sets (duh)
534 if ( uc($type) =~ /^(SET|ENUM)$/ ) {
548 qualifiers => $item[3],
552 parens_field_list : '(' field_name(s /,/) ')'
555 parens_value_list : '(' VALUE(s /,/) ')'
558 type_qualifier : /(BINARY|UNSIGNED|ZEROFILL)/i
563 create_index : /create/i /index/i
565 not_null : /not/i /null/i
571 unsigned : /unsigned/i { $return = 0 }
573 #default_val : /default/i /(?:')?[\s\w\d:.-]*(?:')?/
575 # $item[2] =~ s/'//g;
576 # $return = $item[2];
580 /default/i 'CURRENT_TIMESTAMP'
585 /default/i /'(?:.*?\\')*.*?'|(?:')?[\w\d:.-]*(?:')?/
587 $item[2] =~ s/^\s*'|'\s*$//g;
591 auto_inc : /auto_increment/i { 1 }
593 primary_key : /primary/i /key/i { 1 }
595 constraint : primary_key_def
600 foreign_key_def : foreign_key_def_begin parens_field_list reference_definition
603 supertype => 'constraint',
604 type => 'foreign_key',
607 %{ $item{'reference_definition'} },
611 foreign_key_def_begin : /constraint/i /foreign key/i WORD
612 { $return = $item[3] }
614 /constraint/i NAME /foreign key/i
615 { $return = $item[2] }
617 /constraint/i /foreign key/i
621 { $return = $item[2] }
626 primary_key_def : primary_key index_name(?) '(' name_with_opt_paren(s /,/) ')'
629 supertype => 'constraint',
630 name => $item{'index_name(?)'}[0],
631 type => 'primary_key',
636 unique_key_def : UNIQUE KEY(?) index_name(?) '(' name_with_opt_paren(s /,/) ')'
639 supertype => 'constraint',
640 name => $item{'index_name(?)'}[0],
646 normal_index : KEY index_name(?) '(' name_with_opt_paren(s /,/) ')'
649 supertype => 'index',
651 name => $item{'index_name(?)'}[0],
656 fulltext_index : /fulltext/i KEY(?) index_name(?) '(' name_with_opt_paren(s /,/) ')'
659 supertype => 'index',
661 name => $item{'index_name(?)'}[0],
666 name_with_opt_paren : NAME parens_value_list(s?)
667 { $item[2][0] ? "$item[1]($item[2][0][0])" : $item[1] }
669 UNIQUE : /unique/i { 1 }
671 KEY : /key/i | /index/i
673 table_option : /comment/i /=/ /'.*?'/
675 my $comment = $item[3];
678 $return = { comment => $comment };
680 | /(default )?(charset|character set)/i /\s*=\s*/ WORD
682 $return = { 'CHARACTER SET' => $item[3] };
684 | WORD /\s*=\s*/ WORD
686 $return = { $item[1] => $item[3] };
697 TEMPORARY : /temporary/i
712 VALUE : /[-+]?\.?\d+(?:[eE]\d+)?/
716 # remove leading/trailing quotes
718 $val =~ s/^['"]|['"]$//g;
724 CURRENT_TIMESTAMP : /current_timestamp(\(\))?/i
726 { 'CURRENT_TIMESTAMP' }
730 # -------------------------------------------------------------------
732 my ( $translator, $data ) = @_;
733 my $parser = Parse::RecDescent->new($GRAMMAR);
735 local $::RD_TRACE = $translator->trace ? 1 : undef;
736 local $DEBUG = $translator->debug;
738 unless (defined $parser) {
739 return $translator->error("Error instantiating Parse::RecDescent ".
740 "instance: Bad grammer");
743 # Preprocess for MySQL-specific and not-before-version comments from mysqldump
744 my $parser_version = $translator->parser_args->{mysql_parser_version} || DEFAULT_PARSER_VERSION;
745 while ( $data =~ s#/\*!(\d{5})?(.*?)\*/#($1 && $1 > $parser_version ? '' : $2)#es ) {}
747 my $result = $parser->startrule($data);
748 return $translator->error( "Parse failed." ) unless defined $result;
749 warn "Parse result:".Dumper( $result ) if $DEBUG;
751 my $schema = $translator->schema;
752 $schema->name($result->{'database_name'}) if $result->{'database_name'};
755 $result->{'tables'}{ $a }{'order'}
757 $result->{'tables'}{ $b }{'order'}
758 } keys %{ $result->{'tables'} };
760 for my $table_name ( @tables ) {
761 my $tdata = $result->{tables}{ $table_name };
762 my $table = $schema->add_table(
763 name => $tdata->{'table_name'},
764 ) or die $schema->error;
766 $table->comments( $tdata->{'comments'} );
769 $tdata->{'fields'}->{$a}->{'order'}
771 $tdata->{'fields'}->{$b}->{'order'}
772 } keys %{ $tdata->{'fields'} };
774 for my $fname ( @fields ) {
775 my $fdata = $tdata->{'fields'}{ $fname };
776 my $field = $table->add_field(
777 name => $fdata->{'name'},
778 data_type => $fdata->{'data_type'},
779 size => $fdata->{'size'},
780 default_value => $fdata->{'default'},
781 is_auto_increment => $fdata->{'is_auto_inc'},
782 is_nullable => $fdata->{'null'},
783 comments => $fdata->{'comments'},
784 ) or die $table->error;
786 $table->primary_key( $field->name ) if $fdata->{'is_primary_key'};
788 for my $qual ( qw[ binary unsigned zerofill list collate ],
789 'character set', 'on update' ) {
790 if ( my $val = $fdata->{ $qual } || $fdata->{ uc $qual } ) {
791 next if ref $val eq 'ARRAY' && !@$val;
792 $field->extra( $qual, $val );
796 if ( $fdata->{'has_index'} ) {
800 fields => $fdata->{'name'},
801 ) or die $table->error;
804 if ( $fdata->{'is_unique'} ) {
805 $table->add_constraint(
808 fields => $fdata->{'name'},
809 ) or die $table->error;
812 for my $cdata ( @{ $fdata->{'constraints'} } ) {
813 next unless $cdata->{'type'} eq 'foreign_key';
814 $cdata->{'fields'} ||= [ $field->name ];
815 push @{ $tdata->{'constraints'} }, $cdata;
820 for my $idata ( @{ $tdata->{'indices'} || [] } ) {
821 my $index = $table->add_index(
822 name => $idata->{'name'},
823 type => uc $idata->{'type'},
824 fields => $idata->{'fields'},
825 ) or die $table->error;
828 if ( my @options = @{ $tdata->{'table_options'} || [] } ) {
829 $table->options( \@options ) or die $table->error;
832 for my $cdata ( @{ $tdata->{'constraints'} || [] } ) {
833 my $constraint = $table->add_constraint(
834 name => $cdata->{'name'},
835 type => $cdata->{'type'},
836 fields => $cdata->{'fields'},
837 reference_table => $cdata->{'reference_table'},
838 reference_fields => $cdata->{'reference_fields'},
839 match_type => $cdata->{'match_type'} || '',
840 on_delete => $cdata->{'on_delete'} || $cdata->{'on_delete_do'},
841 on_update => $cdata->{'on_update'} || $cdata->{'on_update_do'},
842 ) or die $table->error;
845 # After the constrains and PK/idxs have been created, we normalize fields
846 normalize_field($_) for $table->get_fields;
849 my @procedures = sort {
850 $result->{procedures}->{ $a }->{'order'} <=> $result->{procedures}->{ $b }->{'order'}
851 } keys %{ $result->{procedures} };
852 foreach my $proc_name (@procedures) {
853 $schema->add_procedure(
855 owner => $result->{procedures}->{$proc_name}->{owner},
856 sql => $result->{procedures}->{$proc_name}->{sql},
861 $result->{views}->{ $a }->{'order'} <=> $result->{views}->{ $b }->{'order'}
862 } keys %{ $result->{views} };
863 foreach my $view_name (keys %{ $result->{views} }) {
866 sql => $result->{views}->{$view_name}->{sql},
873 # Takes a field, and returns
874 sub normalize_field {
876 my ($size, $type, $list, $changed) = @_;
878 $size = $field->size;
879 $type = $field->data_type;
880 $list = $field->extra->{list} || [];
882 if ( !ref $size && $size eq 0 ) {
883 if ( lc $type eq 'tinyint' ) {
884 $changed = $size != 4;
887 elsif ( lc $type eq 'smallint' ) {
888 $changed = $size != 6;
891 elsif ( lc $type eq 'mediumint' ) {
892 $changed = $size != 9;
895 elsif ( $type =~ /^int(eger)?$/i ) {
896 $changed = $size != 11 || $type ne 'int';
900 elsif ( lc $type eq 'bigint' ) {
901 $changed = $size != 20;
904 elsif ( lc $type =~ /(float|double|decimal|numeric|real|fixed|dec)/ ) {
905 my $old_size = (ref $size || '') eq 'ARRAY' ? $size : [];
906 $changed = @$old_size != 2 && $old_size->[0] != 8 && $old_size->[1] != 2;
911 if ( $type =~ /^tiny(text|blob)$/i ) {
912 $changed = $size != 255;
915 elsif ( $type =~ /^(blob|text)$/i ) {
916 $changed = $size != 65_535;
919 elsif ( $type =~ /^medium(blob|text)$/i ) {
920 $changed = $size != 16_777_215;
923 elsif ( $type =~ /^long(blob|text)$/i ) {
924 $changed = $size != 4_294_967_295;
925 $size = 4_294_967_295;
927 if ( $field->data_type =~ /(set|enum)/i && !$field->size ) {
928 my %extra = $field->extra;
930 for my $len ( map { length } @{ $extra{'list'} || [] } ) {
931 $longest = $len if $len > $longest;
934 $size = $longest if $longest;
939 # We only want to clone the field, not *everything*
940 { local $field->{table} = undef;
941 $field->parsed_field(dclone($field));
942 $field->parsed_field->{table} = $field->table;
945 $field->data_type($type);
946 $field->sql_data_type( $type_mapping{lc $type} ) if exists $type_mapping{lc $type};
947 $field->extra->{list} = $list if @$list;
954 # -------------------------------------------------------------------
955 # Where man is not nature is barren.
957 # -------------------------------------------------------------------
963 Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>,
964 Chris Mungall E<lt>cjm@fruitfly.orgE<gt>.
968 Parse::RecDescent, SQL::Translator::Schema.