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 ENGINE = {BDB | HEAP | ISAM | InnoDB | MERGE | MRG_MYISAM | MYISAM }
105 or AUTO_INCREMENT = #
106 or AVG_ROW_LENGTH = #
107 or [ DEFAULT ] CHARACTER SET charset_name
108 or CHECKSUM = {0 | 1}
109 or COLLATE collation_name
110 or COMMENT = "string"
113 or PACK_KEYS = {0 | 1 | DEFAULT}
114 or PASSWORD = "string"
115 or DELAY_KEY_WRITE = {0 | 1}
116 or ROW_FORMAT= { default | dynamic | fixed | compressed }
117 or RAID_TYPE= {1 | STRIPED | RAID0 } RAID_CHUNKS=# RAID_CHUNKSIZE=#
118 or UNION = (table_name,[table_name...])
119 or INSERT_METHOD= {NO | FIRST | LAST }
120 or DATA DIRECTORY="absolute path to directory"
121 or INDEX DIRECTORY="absolute path to directory"
124 A subset of the ALTER TABLE syntax that allows addition of foreign keys:
126 ALTER [IGNORE] TABLE tbl_name alter_specification [, alter_specification] ...
129 ADD [CONSTRAINT [symbol]]
130 FOREIGN KEY [index_name] (index_col_name,...)
131 [reference_definition]
133 A subset of INSERT that we ignore:
140 use vars qw[ $DEBUG $VERSION $GRAMMAR @EXPORT_OK ];
141 $VERSION = sprintf "%d.%02d", q$Revision: 1.58 $ =~ /(\d+)\.(\d+)/;
142 $DEBUG = 0 unless defined $DEBUG;
145 use Parse::RecDescent;
147 use Storable qw(dclone);
148 use DBI qw(:sql_types);
149 use base qw(Exporter);
151 our %type_mapping = (
154 @EXPORT_OK = qw(parse);
156 # Enable warnings within the Parse::RecDescent module.
157 $::RD_ERRORS = 1; # Make sure the parser dies when it encounters an error
158 $::RD_WARN = 1; # Enable warnings. This will warn on unused rules &c.
159 $::RD_HINT = 1; # Give out hints to help fix problems.
161 use constant DEFAULT_PARSER_VERSION => 30000;
163 $GRAMMAR = << 'END_OF_GRAMMAR';
166 my ( $database_name, %tables, $table_order, @table_comments, %views, $view_order, %procedures, $proc_order );
171 # The "eofile" rule makes the parser fail if any "statement" rule
172 # fails. Otherwise, the first successful match by a "statement"
173 # won't cause the failure needed to know that the parse, as a whole,
176 startrule : statement(s) eofile {
177 { tables => \%tables, database_name => $database_name, views => \%views, procedures =>\%procedures }
193 use : /use/i WORD "$delimiter"
195 $database_name = $item[2];
196 @table_comments = ();
199 set : /set/i /[^;]+/ "$delimiter"
200 { @table_comments = () }
202 drop : /drop/i TABLE /[^;]+/ "$delimiter"
204 drop : /drop/i WORD(s) "$delimiter"
205 { @table_comments = () }
208 # MySQL strings, unlike common SQL strings, can be double-quoted or
209 # single-quoted, and you can escape the delmiters by doubling (but only the
210 # delimiter) or by backslashing.
212 /'(\\.|''|[^\\\'])*'/ |
213 /"(\\.|""|[^\\\"])*"/
214 # For reference, std sql str: /(?:(?:\')(?:[^\']*(?:(?:\'\')[^\']*)*)(?:\'))//
216 nonstring : /[^;\'"]+/
218 statement_body : (string | nonstring)(s?)
220 insert : /insert/i statement_body "$delimiter"
222 delimiter : /delimiter/i /[\S]+/
223 { $delimiter = $item[2] }
225 empty_statement : "$delimiter"
227 alter : ALTER TABLE table_name alter_specification(s /,/) "$delimiter"
229 my $table_name = $item{'table_name'};
230 die "Cannot ALTER table '$table_name'; it does not exist"
231 unless $tables{ $table_name };
232 for my $definition ( @{ $item[4] } ) {
233 $definition->{'extra'}->{'alter'} = 1;
234 push @{ $tables{ $table_name }{'constraints'} }, $definition;
238 alter_specification : ADD foreign_key_def
239 { $return = $item[2] }
241 create : CREATE /database/i WORD "$delimiter"
242 { @table_comments = () }
244 create : CREATE TEMPORARY(?) TABLE opt_if_not_exists(?) table_name '(' create_definition(s /,/) /(,\s*)?\)/ table_option(s?) "$delimiter"
246 my $table_name = $item{'table_name'};
247 $tables{ $table_name }{'order'} = ++$table_order;
248 $tables{ $table_name }{'table_name'} = $table_name;
250 if ( @table_comments ) {
251 $tables{ $table_name }{'comments'} = [ @table_comments ];
252 @table_comments = ();
256 for my $definition ( @{ $item[7] } ) {
257 if ( $definition->{'supertype'} eq 'field' ) {
258 my $field_name = $definition->{'name'};
259 $tables{ $table_name }{'fields'}{ $field_name } =
260 { %$definition, order => $i };
263 if ( $definition->{'is_primary_key'} ) {
264 push @{ $tables{ $table_name }{'constraints'} },
266 type => 'primary_key',
267 fields => [ $field_name ],
272 elsif ( $definition->{'supertype'} eq 'constraint' ) {
273 push @{ $tables{ $table_name }{'constraints'} }, $definition;
275 elsif ( $definition->{'supertype'} eq 'index' ) {
276 push @{ $tables{ $table_name }{'indices'} }, $definition;
280 if ( my @options = @{ $item{'table_option(s?)'} } ) {
281 for my $option ( @options ) {
282 my ( $key, $value ) = each %$option;
283 if ( $key eq 'comment' ) {
284 push @{ $tables{ $table_name }{'comments'} }, $value;
287 push @{ $tables{ $table_name }{'table_options'} }, $option;
295 opt_if_not_exists : /if not exists/i
297 create : CREATE UNIQUE(?) /(index|key)/i index_name /on/i table_name '(' field_name(s /,/) ')' "$delimiter"
299 @table_comments = ();
300 push @{ $tables{ $item{'table_name'} }{'indices'} },
303 type => $item[2] ? 'unique' : 'normal',
309 create : CREATE /trigger/i NAME not_delimiter "$delimiter"
311 @table_comments = ();
314 create : CREATE PROCEDURE NAME not_delimiter "$delimiter"
316 @table_comments = ();
317 my $func_name = $item[3];
319 my $sql = "$item[1] $item[2] $item[3] $item[4]";
321 $procedures{ $func_name }{'order'} = ++$proc_order;
322 $procedures{ $func_name }{'name'} = $func_name;
323 $procedures{ $func_name }{'owner'} = $owner;
324 $procedures{ $func_name }{'sql'} = $sql;
327 PROCEDURE : /procedure/i
330 create : CREATE algorithm /view/i NAME not_delimiter "$delimiter"
332 @table_comments = ();
333 my $view_name = $item[4];
334 my $sql = "$item[1] $item[2] $item[3] $item[4] $item[5]";
336 # Hack to strip database from function calls in SQL
337 $sql =~ s#`\w+`\.(`\w+`\()##g;
339 $views{ $view_name }{'order'} = ++$view_order;
340 $views{ $view_name }{'name'} = $view_name;
341 $views{ $view_name }{'sql'} = $sql;
344 algorithm : /algorithm/i /=/ WORD
346 $return = "$item[1]=$item[3]";
349 not_delimiter : /.*?(?=$delimiter)/is
351 create_definition : constraint
357 comment : /^\s*(?:#|-{2}).*\n/
359 my $comment = $item[1];
360 $comment =~ s/^\s*(#|--)\s*//;
361 $comment =~ s/\s*$//;
365 comment : /\/\*/ /.*?\*\//s
367 my $comment = $item[2];
368 $comment = substr($comment, 0, -2);
369 $comment =~ s/^\s*|\s*$//g;
373 field_comment : /^\s*(?:#|-{2}).*\n/
375 my $comment = $item[1];
376 $comment =~ s/^\s*(#|--)\s*//;
377 $comment =~ s/\s*$//;
382 field_comment2 : /comment/i /'.*?'/
384 my $comment = $item[2];
392 field : field_comment(s?) field_name data_type field_qualifier(s?) field_comment2(?) reference_definition(?) on_update(?) field_comment(s?)
394 my %qualifiers = map { %$_ } @{ $item{'field_qualifier(s?)'} || [] };
395 if ( my @type_quals = @{ $item{'data_type'}{'qualifiers'} || [] } ) {
396 $qualifiers{ $_ } = 1 for @type_quals;
399 my $null = defined $qualifiers{'not_null'}
400 ? $qualifiers{'not_null'} : 1;
401 delete $qualifiers{'not_null'};
403 my @comments = ( @{ $item[1] }, @{ $item[5] }, @{ $item[8] } );
406 supertype => 'field',
407 name => $item{'field_name'},
408 data_type => $item{'data_type'}{'type'},
409 size => $item{'data_type'}{'size'},
410 list => $item{'data_type'}{'list'},
412 constraints => $item{'reference_definition(?)'},
413 comments => [ @comments ],
419 field_qualifier : not_null
422 null => $item{'not_null'},
426 field_qualifier : default_val
429 default => $item{'default_val'},
433 field_qualifier : auto_inc
436 is_auto_inc => $item{'auto_inc'},
440 field_qualifier : primary_key
443 is_primary_key => $item{'primary_key'},
447 field_qualifier : unsigned
450 is_unsigned => $item{'unsigned'},
454 field_qualifier : /character set/i WORD
457 'CHARACTER SET' => $item[2],
461 field_qualifier : /collate/i WORD
468 field_qualifier : /on update/i CURRENT_TIMESTAMP
471 'ON UPDATE' => $item[2],
475 field_qualifier : /unique/i KEY(?)
482 field_qualifier : KEY
489 reference_definition : /references/i table_name parens_field_list(?) match_type(?) on_delete(?) on_update(?)
492 type => 'foreign_key',
493 reference_table => $item[2],
494 reference_fields => $item[3][0],
495 match_type => $item[4][0],
496 on_delete => $item[5][0],
497 on_update => $item[6][0],
501 match_type : /match full/i { 'full' }
503 /match partial/i { 'partial' }
505 on_delete : /on delete/i reference_option
509 /on update/i 'CURRENT_TIMESTAMP'
512 /on update/i reference_option
515 reference_option: /restrict/i |
532 data_type : WORD parens_value_list(s?) type_qualifier(s?)
535 my $size; # field size, applicable only to non-set fields
536 my $list; # set list, applicable only to sets (duh)
538 if ( uc($type) =~ /^(SET|ENUM)$/ ) {
552 qualifiers => $item[3],
556 parens_field_list : '(' field_name(s /,/) ')'
559 parens_value_list : '(' VALUE(s /,/) ')'
562 type_qualifier : /(BINARY|UNSIGNED|ZEROFILL)/i
567 create_index : /create/i /index/i
569 not_null : /not/i /null/i
575 unsigned : /unsigned/i { $return = 0 }
577 #default_val : /default/i /(?:')?[\s\w\d:.-]*(?:')?/
579 # $item[2] =~ s/'//g;
580 # $return = $item[2];
584 /default/i 'CURRENT_TIMESTAMP'
589 /default/i /'(?:.*?\\')*.*?'|(?:')?[\w\d:.-]*(?:')?/
591 $item[2] =~ s/^\s*'|'\s*$//g;
595 auto_inc : /auto_increment/i { 1 }
597 primary_key : /primary/i /key/i { 1 }
599 constraint : primary_key_def
604 foreign_key_def : foreign_key_def_begin parens_field_list reference_definition
607 supertype => 'constraint',
608 type => 'foreign_key',
611 %{ $item{'reference_definition'} },
615 foreign_key_def_begin : /constraint/i /foreign key/i WORD
616 { $return = $item[3] }
618 /constraint/i NAME /foreign key/i
619 { $return = $item[2] }
621 /constraint/i /foreign key/i
625 { $return = $item[2] }
630 primary_key_def : primary_key index_name(?) '(' name_with_opt_paren(s /,/) ')'
633 supertype => 'constraint',
634 name => $item{'index_name(?)'}[0],
635 type => 'primary_key',
640 unique_key_def : UNIQUE KEY(?) index_name(?) '(' name_with_opt_paren(s /,/) ')'
643 supertype => 'constraint',
644 name => $item{'index_name(?)'}[0],
650 normal_index : KEY index_name(?) '(' name_with_opt_paren(s /,/) ')'
653 supertype => 'index',
655 name => $item{'index_name(?)'}[0],
660 fulltext_index : /fulltext/i KEY(?) index_name(?) '(' name_with_opt_paren(s /,/) ')'
663 supertype => 'index',
665 name => $item{'index_name(?)'}[0],
670 name_with_opt_paren : NAME parens_value_list(s?)
671 { $item[2][0] ? "$item[1]($item[2][0][0])" : $item[1] }
673 UNIQUE : /unique/i { 1 }
675 KEY : /key/i | /index/i
677 table_option : /comment/i /=/ /'.*?'/
679 my $comment = $item[3];
682 $return = { comment => $comment };
684 | /(default )?(charset|character set)/i /\s*=\s*/ WORD
686 $return = { 'CHARACTER SET' => $item[3] };
690 $return = { 'COLLATE' => $item[2] }
692 | WORD /\s*=\s*/ WORD
694 $return = { $item[1] => $item[3] };
705 TEMPORARY : /temporary/i
717 NAME : BACKTICK /\w+/ BACKTICK
722 VALUE : /[-+]?\.?\d+(?:[eE]\d+)?/
726 # remove leading/trailing quotes
728 $val =~ s/^['"]|['"]$//g;
734 CURRENT_TIMESTAMP : /current_timestamp(\(\))?/i
736 { 'CURRENT_TIMESTAMP' }
740 # -------------------------------------------------------------------
742 my ( $translator, $data ) = @_;
743 my $parser = Parse::RecDescent->new($GRAMMAR);
745 local $::RD_TRACE = $translator->trace ? 1 : undef;
746 local $DEBUG = $translator->debug;
748 unless (defined $parser) {
749 return $translator->error("Error instantiating Parse::RecDescent ".
750 "instance: Bad grammer");
753 # Preprocess for MySQL-specific and not-before-version comments from mysqldump
754 my $parser_version = $translator->parser_args->{mysql_parser_version} || DEFAULT_PARSER_VERSION;
755 while ( $data =~ s#/\*!(\d{5})?(.*?)\*/#($1 && $1 > $parser_version ? '' : $2)#es ) {}
757 my $result = $parser->startrule($data);
758 return $translator->error( "Parse failed." ) unless defined $result;
759 warn "Parse result:".Dumper( $result ) if $DEBUG;
761 my $schema = $translator->schema;
762 $schema->name($result->{'database_name'}) if $result->{'database_name'};
765 $result->{'tables'}{ $a }{'order'}
767 $result->{'tables'}{ $b }{'order'}
768 } keys %{ $result->{'tables'} };
770 for my $table_name ( @tables ) {
771 my $tdata = $result->{tables}{ $table_name };
772 my $table = $schema->add_table(
773 name => $tdata->{'table_name'},
774 ) or die $schema->error;
776 $table->comments( $tdata->{'comments'} );
779 $tdata->{'fields'}->{$a}->{'order'}
781 $tdata->{'fields'}->{$b}->{'order'}
782 } keys %{ $tdata->{'fields'} };
784 for my $fname ( @fields ) {
785 my $fdata = $tdata->{'fields'}{ $fname };
786 my $field = $table->add_field(
787 name => $fdata->{'name'},
788 data_type => $fdata->{'data_type'},
789 size => $fdata->{'size'},
790 default_value => $fdata->{'default'},
791 is_auto_increment => $fdata->{'is_auto_inc'},
792 is_nullable => $fdata->{'null'},
793 comments => $fdata->{'comments'},
794 ) or die $table->error;
796 $table->primary_key( $field->name ) if $fdata->{'is_primary_key'};
798 for my $qual ( qw[ binary unsigned zerofill list collate ],
799 'character set', 'on update' ) {
800 if ( my $val = $fdata->{ $qual } || $fdata->{ uc $qual } ) {
801 next if ref $val eq 'ARRAY' && !@$val;
802 $field->extra( $qual, $val );
806 if ( $fdata->{'has_index'} ) {
810 fields => $fdata->{'name'},
811 ) or die $table->error;
814 if ( $fdata->{'is_unique'} ) {
815 $table->add_constraint(
818 fields => $fdata->{'name'},
819 ) or die $table->error;
822 for my $cdata ( @{ $fdata->{'constraints'} } ) {
823 next unless $cdata->{'type'} eq 'foreign_key';
824 $cdata->{'fields'} ||= [ $field->name ];
825 push @{ $tdata->{'constraints'} }, $cdata;
830 for my $idata ( @{ $tdata->{'indices'} || [] } ) {
831 my $index = $table->add_index(
832 name => $idata->{'name'},
833 type => uc $idata->{'type'},
834 fields => $idata->{'fields'},
835 ) or die $table->error;
838 if ( my @options = @{ $tdata->{'table_options'} || [] } ) {
839 $table->options( \@options ) or die $table->error;
842 for my $cdata ( @{ $tdata->{'constraints'} || [] } ) {
843 my $constraint = $table->add_constraint(
844 name => $cdata->{'name'},
845 type => $cdata->{'type'},
846 fields => $cdata->{'fields'},
847 reference_table => $cdata->{'reference_table'},
848 reference_fields => $cdata->{'reference_fields'},
849 match_type => $cdata->{'match_type'} || '',
850 on_delete => $cdata->{'on_delete'} || $cdata->{'on_delete_do'},
851 on_update => $cdata->{'on_update'} || $cdata->{'on_update_do'},
852 ) or die $table->error;
855 # After the constrains and PK/idxs have been created, we normalize fields
856 normalize_field($_) for $table->get_fields;
859 my @procedures = sort {
860 $result->{procedures}->{ $a }->{'order'} <=> $result->{procedures}->{ $b }->{'order'}
861 } keys %{ $result->{procedures} };
862 foreach my $proc_name (@procedures) {
863 $schema->add_procedure(
865 owner => $result->{procedures}->{$proc_name}->{owner},
866 sql => $result->{procedures}->{$proc_name}->{sql},
871 $result->{views}->{ $a }->{'order'} <=> $result->{views}->{ $b }->{'order'}
872 } keys %{ $result->{views} };
873 foreach my $view_name (keys %{ $result->{views} }) {
876 sql => $result->{views}->{$view_name}->{sql},
883 # Takes a field, and returns
884 sub normalize_field {
886 my ($size, $type, $list, $changed) = @_;
888 $size = $field->size;
889 $type = $field->data_type;
890 $list = $field->extra->{list} || [];
892 if ( !ref $size && $size eq 0 ) {
893 if ( lc $type eq 'tinyint' ) {
894 $changed = $size != 4;
897 elsif ( lc $type eq 'smallint' ) {
898 $changed = $size != 6;
901 elsif ( lc $type eq 'mediumint' ) {
902 $changed = $size != 9;
905 elsif ( $type =~ /^int(eger)?$/i ) {
906 $changed = $size != 11 || $type ne 'int';
910 elsif ( lc $type eq 'bigint' ) {
911 $changed = $size != 20;
914 elsif ( lc $type =~ /(float|double|decimal|numeric|real|fixed|dec)/ ) {
915 my $old_size = (ref $size || '') eq 'ARRAY' ? $size : [];
916 $changed = @$old_size != 2 || $old_size->[0] != 8 || $old_size->[1] != 2;
921 if ( $type =~ /^tiny(text|blob)$/i ) {
922 $changed = $size != 255;
925 elsif ( $type =~ /^(blob|text)$/i ) {
926 $changed = $size != 65_535;
929 elsif ( $type =~ /^medium(blob|text)$/i ) {
930 $changed = $size != 16_777_215;
933 elsif ( $type =~ /^long(blob|text)$/i ) {
934 $changed = $size != 4_294_967_295;
935 $size = 4_294_967_295;
937 if ( $field->data_type =~ /(set|enum)/i && !$field->size ) {
938 my %extra = $field->extra;
940 for my $len ( map { length } @{ $extra{'list'} || [] } ) {
941 $longest = $len if $len > $longest;
944 $size = $longest if $longest;
949 # We only want to clone the field, not *everything*
950 { local $field->{table} = undef;
951 $field->parsed_field(dclone($field));
952 $field->parsed_field->{table} = $field->table;
955 $field->data_type($type);
956 $field->sql_data_type( $type_mapping{lc $type} ) if exists $type_mapping{lc $type};
957 $field->extra->{list} = $list if @$list;
964 # -------------------------------------------------------------------
965 # Where man is not nature is barren.
967 # -------------------------------------------------------------------
973 Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>,
974 Chris Mungall E<lt>cjm@fruitfly.orgE<gt>.
978 Parse::RecDescent, SQL::Translator::Schema.