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 base qw(Exporter);
145 @EXPORT_OK = qw(parse);
147 # Enable warnings within the Parse::RecDescent module.
148 $::RD_ERRORS = 1; # Make sure the parser dies when it encounters an error
149 $::RD_WARN = 1; # Enable warnings. This will warn on unused rules &c.
150 $::RD_HINT = 1; # Give out hints to help fix problems.
152 use constant DEFAULT_PARSER_VERSION => 30000;
154 $GRAMMAR = << 'END_OF_GRAMMAR';
157 my ( $database_name, %tables, $table_order, @table_comments, %views, $view_order, %procedures, $proc_order );
162 # The "eofile" rule makes the parser fail if any "statement" rule
163 # fails. Otherwise, the first successful match by a "statement"
164 # won't cause the failure needed to know that the parse, as a whole,
167 startrule : statement(s) eofile {
168 { tables => \%tables, database_name => $database_name, views => \%views, procedures =>\%procedures }
184 use : /use/i WORD "$delimiter"
186 $database_name = $item[2];
187 @table_comments = ();
190 set : /set/i /[^;]+/ "$delimiter"
191 { @table_comments = () }
193 drop : /drop/i TABLE /[^;]+/ "$delimiter"
195 drop : /drop/i WORD(s) "$delimiter"
196 { @table_comments = () }
199 # MySQL strings, unlike common SQL strings, can be double-quoted or
200 # single-quoted, and you can escape the delmiters by doubling (but only the
201 # delimiter) or by backslashing.
203 /'(\\.|''|[^\\\'])*'/ |
204 /"(\\.|""|[^\\\"])*"/
205 # For reference, std sql str: /(?:(?:\')(?:[^\']*(?:(?:\'\')[^\']*)*)(?:\'))//
207 nonstring : /[^;\'"]+/
209 statement_body : (string | nonstring)(s?)
211 insert : /insert/i statement_body "$delimiter"
213 delimiter : /delimiter/i /[\S]+/
214 { $delimiter = $item[2] }
216 empty_statement : "$delimiter"
218 alter : ALTER TABLE table_name alter_specification(s /,/) "$delimiter"
220 my $table_name = $item{'table_name'};
221 die "Cannot ALTER table '$table_name'; it does not exist"
222 unless $tables{ $table_name };
223 for my $definition ( @{ $item[4] } ) {
224 $definition->{'extra'}->{'alter'} = 1;
225 push @{ $tables{ $table_name }{'constraints'} }, $definition;
229 alter_specification : ADD foreign_key_def
230 { $return = $item[2] }
232 create : CREATE /database/i WORD "$delimiter"
233 { @table_comments = () }
235 create : CREATE TEMPORARY(?) TABLE opt_if_not_exists(?) table_name '(' create_definition(s /,/) /(,\s*)?\)/ table_option(s?) "$delimiter"
237 my $table_name = $item{'table_name'};
238 $tables{ $table_name }{'order'} = ++$table_order;
239 $tables{ $table_name }{'table_name'} = $table_name;
241 if ( @table_comments ) {
242 $tables{ $table_name }{'comments'} = [ @table_comments ];
243 @table_comments = ();
247 for my $definition ( @{ $item[7] } ) {
248 if ( $definition->{'supertype'} eq 'field' ) {
249 my $field_name = $definition->{'name'};
250 $tables{ $table_name }{'fields'}{ $field_name } =
251 { %$definition, order => $i };
254 if ( $definition->{'is_primary_key'} ) {
255 push @{ $tables{ $table_name }{'constraints'} },
257 type => 'primary_key',
258 fields => [ $field_name ],
263 elsif ( $definition->{'supertype'} eq 'constraint' ) {
264 push @{ $tables{ $table_name }{'constraints'} }, $definition;
266 elsif ( $definition->{'supertype'} eq 'index' ) {
267 push @{ $tables{ $table_name }{'indices'} }, $definition;
271 if ( my @options = @{ $item{'table_option(s?)'} } ) {
272 for my $option ( @options ) {
273 my ( $key, $value ) = each %$option;
274 if ( $key eq 'comment' ) {
275 push @{ $tables{ $table_name }{'comments'} }, $value;
278 push @{ $tables{ $table_name }{'table_options'} }, $option;
286 opt_if_not_exists : /if not exists/i
288 create : CREATE UNIQUE(?) /(index|key)/i index_name /on/i table_name '(' field_name(s /,/) ')' "$delimiter"
290 @table_comments = ();
291 push @{ $tables{ $item{'table_name'} }{'indices'} },
294 type => $item[2] ? 'unique' : 'normal',
300 create : CREATE /trigger/i NAME not_delimiter "$delimiter"
302 @table_comments = ();
305 create : CREATE PROCEDURE NAME not_delimiter "$delimiter"
307 @table_comments = ();
308 my $func_name = $item[3];
310 my $sql = "$item[1] $item[2] $item[3] $item[4]";
312 $procedures{ $func_name }{'order'} = ++$proc_order;
313 $procedures{ $func_name }{'name'} = $func_name;
314 $procedures{ $func_name }{'owner'} = $owner;
315 $procedures{ $func_name }{'sql'} = $sql;
318 PROCEDURE : /procedure/i
321 create : CREATE algorithm /view/i NAME not_delimiter "$delimiter"
323 @table_comments = ();
324 my $view_name = $item[4];
325 my $sql = "$item[1] $item[2] $item[3] $item[4] $item[5]";
327 # Hack to strip database from function calls in SQL
328 $sql =~ s#`\w+`\.(`\w+`\()##g;
330 $views{ $view_name }{'order'} = ++$view_order;
331 $views{ $view_name }{'name'} = $view_name;
332 $views{ $view_name }{'sql'} = $sql;
335 algorithm : /algorithm/i /=/ WORD
337 $return = "$item[1]=$item[3]";
340 not_delimiter : /.*?(?=$delimiter)/is
342 create_definition : constraint
348 comment : /^\s*(?:#|-{2}).*\n/
350 my $comment = $item[1];
351 $comment =~ s/^\s*(#|--)\s*//;
352 $comment =~ s/\s*$//;
356 comment : /\/\*/ /.*?\*\//s
358 my $comment = $item[2];
359 $comment = substr($comment, 0, -2);
360 $comment =~ s/^\s*|\s*$//g;
364 field_comment : /^\s*(?:#|-{2}).*\n/
366 my $comment = $item[1];
367 $comment =~ s/^\s*(#|--)\s*//;
368 $comment =~ s/\s*$//;
373 field_comment2 : /comment/i /'.*?'/
375 my $comment = $item[2];
383 field : field_comment(s?) field_name data_type field_qualifier(s?) field_comment2(?) reference_definition(?) on_update(?) field_comment(s?)
385 my %qualifiers = map { %$_ } @{ $item{'field_qualifier(s?)'} || [] };
386 if ( my @type_quals = @{ $item{'data_type'}{'qualifiers'} || [] } ) {
387 $qualifiers{ $_ } = 1 for @type_quals;
390 my $null = defined $qualifiers{'not_null'}
391 ? $qualifiers{'not_null'} : 1;
392 delete $qualifiers{'not_null'};
394 my @comments = ( @{ $item[1] }, @{ $item[5] }, @{ $item[8] } );
397 supertype => 'field',
398 name => $item{'field_name'},
399 data_type => $item{'data_type'}{'type'},
400 size => $item{'data_type'}{'size'},
401 list => $item{'data_type'}{'list'},
403 constraints => $item{'reference_definition(?)'},
404 comments => [ @comments ],
410 field_qualifier : not_null
413 null => $item{'not_null'},
417 field_qualifier : default_val
420 default => $item{'default_val'},
424 field_qualifier : auto_inc
427 is_auto_inc => $item{'auto_inc'},
431 field_qualifier : primary_key
434 is_primary_key => $item{'primary_key'},
438 field_qualifier : unsigned
441 is_unsigned => $item{'unsigned'},
445 field_qualifier : /character set/i WORD
448 'CHARACTER SET' => $item[2],
452 field_qualifier : /collate/i WORD
459 field_qualifier : /on update/i CURRENT_TIMESTAMP
462 'ON UPDATE' => $item[2],
466 field_qualifier : /unique/i KEY(?)
473 field_qualifier : KEY
480 reference_definition : /references/i table_name parens_field_list(?) match_type(?) on_delete(?) on_update(?)
483 type => 'foreign_key',
484 reference_table => $item[2],
485 reference_fields => $item[3][0],
486 match_type => $item[4][0],
487 on_delete => $item[5][0],
488 on_update => $item[6][0],
492 match_type : /match full/i { 'full' }
494 /match partial/i { 'partial' }
496 on_delete : /on delete/i reference_option
500 /on update/i 'CURRENT_TIMESTAMP'
503 /on update/i reference_option
506 reference_option: /restrict/i |
523 data_type : WORD parens_value_list(s?) type_qualifier(s?)
526 my $size; # field size, applicable only to non-set fields
527 my $list; # set list, applicable only to sets (duh)
529 if ( uc($type) =~ /^(SET|ENUM)$/ ) {
538 unless ( @{ $size || [] } ) {
539 if ( lc $type eq 'tinyint' ) {
542 elsif ( lc $type eq 'smallint' ) {
545 elsif ( lc $type eq 'mediumint' ) {
548 elsif ( $type =~ /^int(eger)?$/i ) {
552 elsif ( lc $type eq 'bigint' ) {
556 lc $type =~ /(float|double|decimal|numeric|real|fixed|dec)/
562 if ( $type =~ /^tiny(text|blob)$/i ) {
565 elsif ( $type =~ /^(blob|text)$/i ) {
568 elsif ( $type =~ /^medium(blob|text)$/i ) {
571 elsif ( $type =~ /^long(blob|text)$/i ) {
572 $size = 4_294_967_295;
579 qualifiers => $item[3],
583 parens_field_list : '(' field_name(s /,/) ')'
586 parens_value_list : '(' VALUE(s /,/) ')'
589 type_qualifier : /(BINARY|UNSIGNED|ZEROFILL)/i
594 create_index : /create/i /index/i
596 not_null : /not/i /null/i
602 unsigned : /unsigned/i { $return = 0 }
604 #default_val : /default/i /(?:')?[\s\w\d:.-]*(?:')?/
606 # $item[2] =~ s/'//g;
607 # $return = $item[2];
611 /default/i 'CURRENT_TIMESTAMP'
616 /default/i /'(?:.*?\\')*.*?'|(?:')?[\w\d:.-]*(?:')?/
618 $item[2] =~ s/^\s*'|'\s*$//g;
622 auto_inc : /auto_increment/i { 1 }
624 primary_key : /primary/i /key/i { 1 }
626 constraint : primary_key_def
631 foreign_key_def : foreign_key_def_begin parens_field_list reference_definition
634 supertype => 'constraint',
635 type => 'foreign_key',
638 %{ $item{'reference_definition'} },
642 foreign_key_def_begin : /constraint/i /foreign key/i WORD
643 { $return = $item[3] }
645 /constraint/i NAME /foreign key/i
646 { $return = $item[2] }
648 /constraint/i /foreign key/i
652 { $return = $item[2] }
657 primary_key_def : primary_key index_name(?) '(' name_with_opt_paren(s /,/) ')'
660 supertype => 'constraint',
661 name => $item{'index_name(?)'}[0],
662 type => 'primary_key',
667 unique_key_def : UNIQUE KEY(?) index_name(?) '(' name_with_opt_paren(s /,/) ')'
670 supertype => 'constraint',
671 name => $item{'index_name(?)'}[0],
677 normal_index : KEY index_name(?) '(' name_with_opt_paren(s /,/) ')'
680 supertype => 'index',
682 name => $item{'index_name(?)'}[0],
687 fulltext_index : /fulltext/i KEY(?) index_name(?) '(' name_with_opt_paren(s /,/) ')'
690 supertype => 'index',
692 name => $item{'index_name(?)'}[0],
697 name_with_opt_paren : NAME parens_value_list(s?)
698 { $item[2][0] ? "$item[1]($item[2][0][0])" : $item[1] }
700 UNIQUE : /unique/i { 1 }
702 KEY : /key/i | /index/i
704 table_option : /comment/i /=/ /'.*?'/
706 my $comment = $item[3];
709 $return = { comment => $comment };
711 | /(default )?(charset|character set)/i /\s*=\s*/ WORD
713 $return = { 'CHARACTER SET' => $item[3] };
715 | WORD /\s*=\s*/ WORD
717 $return = { $item[1] => $item[3] };
728 TEMPORARY : /temporary/i
743 VALUE : /[-+]?\.?\d+(?:[eE]\d+)?/
747 # remove leading/trailing quotes
749 $val =~ s/^['"]|['"]$//g;
755 CURRENT_TIMESTAMP : /current_timestamp(\(\))?/i
757 { 'CURRENT_TIMESTAMP' }
761 # -------------------------------------------------------------------
763 my ( $translator, $data ) = @_;
764 my $parser = Parse::RecDescent->new($GRAMMAR);
766 local $::RD_TRACE = $translator->trace ? 1 : undef;
767 local $DEBUG = $translator->debug;
769 unless (defined $parser) {
770 return $translator->error("Error instantiating Parse::RecDescent ".
771 "instance: Bad grammer");
774 # Preprocess for MySQL-specific and not-before-version comments from mysqldump
775 my $parser_version = $translator->parser_args->{mysql_parser_version} || DEFAULT_PARSER_VERSION;
776 while ( $data =~ s#/\*!(\d{5})?(.*?)\*/#($1 && $1 > $parser_version ? '' : $2)#es ) {}
778 my $result = $parser->startrule($data);
779 return $translator->error( "Parse failed." ) unless defined $result;
780 warn "Parse result:".Dumper( $result ) if $DEBUG;
782 my $schema = $translator->schema;
783 $schema->name($result->{'database_name'}) if $result->{'database_name'};
786 $result->{'tables'}{ $a }{'order'}
788 $result->{'tables'}{ $b }{'order'}
789 } keys %{ $result->{'tables'} };
791 for my $table_name ( @tables ) {
792 my $tdata = $result->{tables}{ $table_name };
793 my $table = $schema->add_table(
794 name => $tdata->{'table_name'},
795 ) or die $schema->error;
797 $table->comments( $tdata->{'comments'} );
800 $tdata->{'fields'}->{$a}->{'order'}
802 $tdata->{'fields'}->{$b}->{'order'}
803 } keys %{ $tdata->{'fields'} };
805 for my $fname ( @fields ) {
806 my $fdata = $tdata->{'fields'}{ $fname };
807 my $field = $table->add_field(
808 name => $fdata->{'name'},
809 data_type => $fdata->{'data_type'},
810 size => $fdata->{'size'},
811 default_value => $fdata->{'default'},
812 is_auto_increment => $fdata->{'is_auto_inc'},
813 is_nullable => $fdata->{'null'},
814 comments => $fdata->{'comments'},
815 ) or die $table->error;
817 $table->primary_key( $field->name ) if $fdata->{'is_primary_key'};
819 for my $qual ( qw[ binary unsigned zerofill list collate ],
820 'character set', 'on update' ) {
821 if ( my $val = $fdata->{ $qual } || $fdata->{ uc $qual } ) {
822 next if ref $val eq 'ARRAY' && !@$val;
823 $field->extra( $qual, $val );
827 if ( $fdata->{'has_index'} ) {
831 fields => $fdata->{'name'},
832 ) or die $table->error;
835 if ( $fdata->{'is_unique'} ) {
836 $table->add_constraint(
839 fields => $fdata->{'name'},
840 ) or die $table->error;
843 if ( $field->data_type =~ /(set|enum)/i && !$field->size ) {
844 my %extra = $field->extra;
846 for my $len ( map { length } @{ $extra{'list'} || [] } ) {
847 $longest = $len if $len > $longest;
849 $field->size( $longest ) if $longest;
852 for my $cdata ( @{ $fdata->{'constraints'} } ) {
853 next unless $cdata->{'type'} eq 'foreign_key';
854 $cdata->{'fields'} ||= [ $field->name ];
855 push @{ $tdata->{'constraints'} }, $cdata;
859 for my $idata ( @{ $tdata->{'indices'} || [] } ) {
860 my $index = $table->add_index(
861 name => $idata->{'name'},
862 type => uc $idata->{'type'},
863 fields => $idata->{'fields'},
864 ) or die $table->error;
867 if ( my @options = @{ $tdata->{'table_options'} || [] } ) {
868 $table->options( \@options ) or die $table->error;
871 for my $cdata ( @{ $tdata->{'constraints'} || [] } ) {
872 my $constraint = $table->add_constraint(
873 name => $cdata->{'name'},
874 type => $cdata->{'type'},
875 fields => $cdata->{'fields'},
876 reference_table => $cdata->{'reference_table'},
877 reference_fields => $cdata->{'reference_fields'},
878 match_type => $cdata->{'match_type'} || '',
879 on_delete => $cdata->{'on_delete'} || $cdata->{'on_delete_do'},
880 on_update => $cdata->{'on_update'} || $cdata->{'on_update_do'},
881 ) or die $table->error;
885 my @procedures = sort {
886 $result->{procedures}->{ $a }->{'order'} <=> $result->{procedures}->{ $b }->{'order'}
887 } keys %{ $result->{procedures} };
888 foreach my $proc_name (@procedures) {
889 $schema->add_procedure(
891 owner => $result->{procedures}->{$proc_name}->{owner},
892 sql => $result->{procedures}->{$proc_name}->{sql},
897 $result->{views}->{ $a }->{'order'} <=> $result->{views}->{ $b }->{'order'}
898 } keys %{ $result->{views} };
899 foreach my $view_name (keys %{ $result->{views} }) {
902 sql => $result->{views}->{$view_name}->{sql},
911 # -------------------------------------------------------------------
912 # Where man is not nature is barren.
914 # -------------------------------------------------------------------
920 Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>,
921 Chris Mungall E<lt>cjm@fruitfly.orgE<gt>.
925 Parse::RecDescent, SQL::Translator::Schema.