package SQL::Translator::Parser::MySQL;
# -------------------------------------------------------------------
-# $Id: MySQL.pm,v 1.10 2003-01-29 13:28:28 dlc Exp $
+# $Id: MySQL.pm,v 1.44 2004-03-01 17:39:22 kycl4rk Exp $
# -------------------------------------------------------------------
-# Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>,
-# darren chamberlain <darren@cpan.org>,
-# Chris Mungall <cjm@fruitfly.org>
+# Copyright (C) 2002-4 SQLFairy Authors
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
The grammar is influenced heavily by Tim Bunce's "mysql2ora" grammar.
+Here's the word from the MySQL site
+(http://www.mysql.com/doc/en/CREATE_TABLE.html):
+
+ CREATE [TEMPORARY] TABLE [IF NOT EXISTS] tbl_name [(create_definition,...)]
+ [table_options] [select_statement]
+
+ or
+
+ CREATE [TEMPORARY] TABLE [IF NOT EXISTS] tbl_name LIKE old_table_name;
+
+ create_definition:
+ col_name type [NOT NULL | NULL] [DEFAULT default_value] [AUTO_INCREMENT]
+ [PRIMARY KEY] [reference_definition]
+ or PRIMARY KEY (index_col_name,...)
+ or KEY [index_name] (index_col_name,...)
+ or INDEX [index_name] (index_col_name,...)
+ or UNIQUE [INDEX] [index_name] (index_col_name,...)
+ or FULLTEXT [INDEX] [index_name] (index_col_name,...)
+ or [CONSTRAINT symbol] FOREIGN KEY [index_name] (index_col_name,...)
+ [reference_definition]
+ or CHECK (expr)
+
+ type:
+ TINYINT[(length)] [UNSIGNED] [ZEROFILL]
+ or SMALLINT[(length)] [UNSIGNED] [ZEROFILL]
+ or MEDIUMINT[(length)] [UNSIGNED] [ZEROFILL]
+ or INT[(length)] [UNSIGNED] [ZEROFILL]
+ or INTEGER[(length)] [UNSIGNED] [ZEROFILL]
+ or BIGINT[(length)] [UNSIGNED] [ZEROFILL]
+ or REAL[(length,decimals)] [UNSIGNED] [ZEROFILL]
+ or DOUBLE[(length,decimals)] [UNSIGNED] [ZEROFILL]
+ or FLOAT[(length,decimals)] [UNSIGNED] [ZEROFILL]
+ or DECIMAL(length,decimals) [UNSIGNED] [ZEROFILL]
+ or NUMERIC(length,decimals) [UNSIGNED] [ZEROFILL]
+ or CHAR(length) [BINARY]
+ or VARCHAR(length) [BINARY]
+ or DATE
+ or TIME
+ or TIMESTAMP
+ or DATETIME
+ or TINYBLOB
+ or BLOB
+ or MEDIUMBLOB
+ or LONGBLOB
+ or TINYTEXT
+ or TEXT
+ or MEDIUMTEXT
+ or LONGTEXT
+ or ENUM(value1,value2,value3,...)
+ or SET(value1,value2,value3,...)
+
+ index_col_name:
+ col_name [(length)]
+
+ reference_definition:
+ REFERENCES tbl_name [(index_col_name,...)]
+ [MATCH FULL | MATCH PARTIAL]
+ [ON DELETE reference_option]
+ [ON UPDATE reference_option]
+
+ reference_option:
+ RESTRICT | CASCADE | SET NULL | NO ACTION | SET DEFAULT
+
+ table_options:
+ TYPE = {BDB | HEAP | ISAM | InnoDB | MERGE | MRG_MYISAM | MYISAM }
+ or AUTO_INCREMENT = #
+ or AVG_ROW_LENGTH = #
+ or CHECKSUM = {0 | 1}
+ or COMMENT = "string"
+ or MAX_ROWS = #
+ or MIN_ROWS = #
+ or PACK_KEYS = {0 | 1 | DEFAULT}
+ or PASSWORD = "string"
+ or DELAY_KEY_WRITE = {0 | 1}
+ or ROW_FORMAT= { default | dynamic | fixed | compressed }
+ or RAID_TYPE= {1 | STRIPED | RAID0 } RAID_CHUNKS=# RAID_CHUNKSIZE=#
+ or UNION = (table_name,[table_name...])
+ or INSERT_METHOD= {NO | FIRST | LAST }
+ or DATA DIRECTORY="absolute path to directory"
+ or INDEX DIRECTORY="absolute path to directory"
+
=cut
use strict;
use vars qw[ $DEBUG $VERSION $GRAMMAR @EXPORT_OK ];
-$VERSION = sprintf "%d.%02d", q$Revision: 1.10 $ =~ /(\d+)\.(\d+)/;
+$VERSION = sprintf "%d.%02d", q$Revision: 1.44 $ =~ /(\d+)\.(\d+)/;
$DEBUG = 0 unless defined $DEBUG;
use Data::Dumper;
$::RD_WARN = 1; # Enable warnings. This will warn on unused rules &c.
$::RD_HINT = 1; # Give out hints to help fix problems.
-my $parser; # should we do this? There's no programmic way to
- # change the grammar, so I think this is safe.
-
$GRAMMAR = q!
-{ our ( %tables, $table_order ) }
+{
+ my ( %tables, $table_order, @table_comments );
+}
+
+#
+# The "eofile" rule makes the parser fail if any "statement" rule
+# fails. Otherwise, the first successful match by a "statement"
+# won't cause the failure needed to know that the parse, as a whole,
+# failed. -ky
+#
+startrule : statement(s) eofile { \%tables }
-startrule : statement(s) { \%tables }
+eofile : /^\Z/
statement : comment
+ | use
+ | set
| drop
| create
| <error>
+use : /use/i WORD ';'
+ { @table_comments = () }
+
+set : /set/i /[^;]+/ ';'
+ { @table_comments = () }
+
+drop : /drop/i TABLE /[^;]+/ ';'
+
drop : /drop/i WORD(s) ';'
+ { @table_comments = () }
-create : create_table table_name '(' create_definition(s /,/) ')' table_option(s?) ';'
+create : CREATE /database/i WORD ';'
+ { @table_comments = () }
+
+create : CREATE TEMPORARY(?) TABLE opt_if_not_exists(?) table_name '(' create_definition(s /,/) ')' table_option(s?) ';'
{
my $table_name = $item{'table_name'};
$tables{ $table_name }{'order'} = ++$table_order;
$tables{ $table_name }{'table_name'} = $table_name;
+ if ( @table_comments ) {
+ $tables{ $table_name }{'comments'} = [ @table_comments ];
+ @table_comments = ();
+ }
+
my $i = 1;
- for my $definition ( @{ $item[4] } ) {
- if ( $definition->{'type'} eq 'field' ) {
+ for my $definition ( @{ $item[7] } ) {
+ if ( $definition->{'supertype'} eq 'field' ) {
my $field_name = $definition->{'name'};
$tables{ $table_name }{'fields'}{ $field_name } =
{ %$definition, order => $i };
$i++;
if ( $definition->{'is_primary_key'} ) {
- push @{ $tables{ $table_name }{'indices'} },
+ push @{ $tables{ $table_name }{'constraints'} },
{
type => 'primary_key',
fields => [ $field_name ],
;
}
}
- else {
- push @{ $tables{ $table_name }{'indices'} },
- $definition;
+ elsif ( $definition->{'supertype'} eq 'constraint' ) {
+ push @{ $tables{ $table_name }{'constraints'} }, $definition;
+ }
+ elsif ( $definition->{'supertype'} eq 'index' ) {
+ push @{ $tables{ $table_name }{'indices'} }, $definition;
}
}
- for my $opt ( @{ $item{'table_option'} } ) {
- if ( my ( $key, $val ) = each %$opt ) {
- $tables{ $table_name }{'table_options'}{ $key } = $val;
- }
+ if ( my @options = @{ $item{'table_option(s?)'} } ) {
+ $tables{ $table_name }{'table_options'} = \@options;
}
+
+ 1;
}
-create : /CREATE/i unique(?) /(INDEX|KEY)/i index_name /on/i table_name '(' field_name(s /,/) ')' ';'
+opt_if_not_exists : /if not exists/i
+
+create : CREATE UNIQUE(?) /(index|key)/i index_name /on/i table_name '(' field_name(s /,/) ')' ';'
{
+ @table_comments = ();
push @{ $tables{ $item{'table_name'} }{'indices'} },
{
name => $item[4],
;
}
-create_definition : index
+create_definition : constraint
+ | index
| field
+ | comment
| <error>
-comment : /^\s*(?:#|-{2}).*\n/
+comment : /^\s*(?:#|-{2}).*\n/
+ {
+ my $comment = $item[1];
+ $comment =~ s/^\s*(#|--)\s*//;
+ $comment =~ s/\s*$//;
+ $return = $comment;
+ push @table_comments, $comment;
+ }
+
+field_comment : /^\s*(?:#|-{2}).*\n/
+ {
+ my $comment = $item[1];
+ $comment =~ s/^\s*(#|--)\s*//;
+ $comment =~ s/\s*$//;
+ $return = $comment;
+ }
blank : /\s*/
-field : field_name data_type field_qualifier(s?)
+field : field_comment(s?) field_name data_type field_qualifier(s?) reference_definition(?) field_comment(s?)
{
- my %qualifiers = map { %$_ } @{ $item{'field_qualifier'} || [] };
- my $null = defined $item{'not_null'} ? $item{'not_null'} : 1;
- delete $qualifiers{'not_null'};
+ my %qualifiers = map { %$_ } @{ $item{'field_qualifier(s?)'} || [] };
if ( my @type_quals = @{ $item{'data_type'}{'qualifiers'} || [] } ) {
$qualifiers{ $_ } = 1 for @type_quals;
}
+ my $null = defined $qualifiers{'not_null'}
+ ? $qualifiers{'not_null'} : 1;
+ delete $qualifiers{'not_null'};
+
+ my @comments = ( @{ $item[1] }, @{ $item[6] } );
+
$return = {
- type => 'field',
- name => $item{'field_name'},
- data_type => $item{'data_type'}{'type'},
- size => $item{'data_type'}{'size'},
- list => $item{'data_type'}{'list'},
- null => $null,
+ supertype => 'field',
+ name => $item{'field_name'},
+ data_type => $item{'data_type'}{'type'},
+ size => $item{'data_type'}{'size'},
+ list => $item{'data_type'}{'list'},
+ null => $null,
+ constraints => $item{'reference_definition(?)'},
+ comments => [ @comments ],
%qualifiers,
}
}
}
}
-index : primary_key_index
- | unique_index
- | normal_index
+field_qualifier : /character set/i WORD
+ {
+ $return = {
+ character_set => $item[2],
+ }
+ }
+
+reference_definition : /references/i table_name parens_field_list(?) match_type(?) on_delete_do(?) on_update_do(?)
+ {
+ $return = {
+ type => 'foreign_key',
+ reference_table => $item[2],
+ reference_fields => $item[3][0],
+ match_type => $item[4][0],
+ on_delete_do => $item[5][0],
+ on_update_do => $item[6][0],
+ }
+ }
+
+match_type : /match full/i { 'full' }
+ |
+ /match partial/i { 'partial' }
+
+on_delete_do : /on delete/i reference_option
+ { $item[2] }
+
+on_update_do : /on update/i reference_option
+ { $item[2] }
+
+reference_option: /restrict/i |
+ /cascade/i |
+ /set null/i |
+ /no action/i |
+ /set default/i
+ { $item[1] }
+
+index : normal_index
+ | fulltext_index
+ | <error>
-table_name : WORD
+table_name : NAME
-field_name : WORD
+field_name : NAME
-index_name : WORD
+index_name : NAME
data_type : WORD parens_value_list(s?) type_qualifier(s?)
{
$list = [];
}
+ unless ( @{ $size || [] } ) {
+ if ( lc $type eq 'tinyint' ) {
+ $size = 4;
+ }
+ elsif ( lc $type eq 'smallint' ) {
+ $size = 6;
+ }
+ elsif ( lc $type eq 'mediumint' ) {
+ $size = 9;
+ }
+ elsif ( $type =~ /^int(eger)?$/ ) {
+ $type = 'int';
+ $size = 11;
+ }
+ elsif ( lc $type eq 'bigint' ) {
+ $size = 20;
+ }
+ elsif (
+ lc $type =~ /(float|double|decimal|numeric|real|fixed|dec)/
+ ) {
+ $size = [8,2];
+ }
+ }
+
+ if ( $type =~ /^tiny(text|blob)$/i ) {
+ $size = 255;
+ }
+ elsif ( $type =~ /^(blob|text)$/i ) {
+ $size = 65_535;
+ }
+ elsif ( $type =~ /^medium(blob|text)$/i ) {
+ $size = 16_777_215;
+ }
+ elsif ( $type =~ /^long(blob|text)$/i ) {
+ $size = 4_294_967_295;
+ }
+
$return = {
type => $type,
size => $size,
}
}
+parens_field_list : '(' field_name(s /,/) ')'
+ { $item[2] }
+
parens_value_list : '(' VALUE(s /,/) ')'
{ $item[2] }
field_type : WORD
-field_size : '(' num_range ')' { $item{'num_range'} }
-
-num_range : DIGITS ',' DIGITS
- { $return = $item[1].','.$item[3] }
- | DIGITS
- { $return = $item[1] }
-
-create_table : /create/i /table/i
-
create_index : /create/i /index/i
not_null : /not/i /null/i { $return = 0 }
unsigned : /unsigned/i { $return = 0 }
-default_val : /default/i /(?:')?[\w\d.-]*(?:')?/
- {
- $item[2] =~ s/'//g;
+#default_val : /default/i /(?:')?[\s\w\d:.-]*(?:')?/
+# {
+# $item[2] =~ s/'//g;
+# $return = $item[2];
+# }
+
+default_val : /default/i /'(?:.*?\\')*.*?'|(?:')?[\w\d:.-]*(?:')?/
+ {
+ $item[2] =~ s/^\s*'|'\s*$//g;
$return = $item[2];
}
primary_key : /primary/i /key/i { 1 }
-primary_key_index : primary_key index_name(?) '(' field_name(s /,/) ')'
+constraint : primary_key_def
+ | unique_key_def
+ | foreign_key_def
+ | <error>
+
+foreign_key_def : foreign_key_def_begin parens_field_list reference_definition
+ {
+ $return = {
+ supertype => 'constraint',
+ type => 'foreign_key',
+ name => $item[1],
+ fields => $item[2],
+ %{ $item{'reference_definition'} },
+ }
+ }
+
+foreign_key_def_begin : /constraint/i /foreign key/i
+ { $return = '' }
+ |
+ /constraint/i WORD /foreign key/i
+ { $return = $item[2] }
+ |
+ /foreign key/i
+ { $return = '' }
+
+primary_key_def : primary_key index_name(?) '(' name_with_opt_paren(s /,/) ')'
+ {
+ $return = {
+ supertype => 'constraint',
+ name => $item{'index_name(?)'}[0],
+ type => 'primary_key',
+ fields => $item[4],
+ };
+ }
+
+unique_key_def : UNIQUE KEY(?) index_name(?) '(' name_with_opt_paren(s /,/) ')'
{
- $return = {
- name => $item{'index_name'}[0],
- type => 'primary_key',
- fields => $item[4],
+ $return = {
+ supertype => 'constraint',
+ name => $item{'index_name(?)'}[0],
+ type => 'unique',
+ fields => $item[5],
}
}
-normal_index : key index_name(?) '(' name_with_opt_paren(s /,/) ')'
+normal_index : KEY index_name(?) '(' name_with_opt_paren(s /,/) ')'
{
- $return = {
- name => $item{'index_name'}[0],
- type => 'normal',
- fields => $item[4],
+ $return = {
+ supertype => 'index',
+ type => 'normal',
+ name => $item{'index_name(?)'}[0],
+ fields => $item[4],
}
}
-unique_index : unique key(?) index_name(?) '(' name_with_opt_paren(s /,/) ')'
+fulltext_index : /fulltext/i KEY(?) index_name(?) '(' name_with_opt_paren(s /,/) ')'
{
- $return = {
- name => $item{'index_name'}[0],
- type => 'unique',
- fields => $item[5],
+ $return = {
+ supertype => 'index',
+ type => 'fulltext',
+ name => $item{'index_name(?)'}[0],
+ fields => $item[5],
}
}
name_with_opt_paren : NAME parens_value_list(s?)
{ $item[2][0] ? "$item[1]($item[2][0][0])" : $item[1] }
-unique : /unique/i { 1 }
+UNIQUE : /unique/i { 1 }
-key : /key/i | /index/i
+KEY : /key/i | /index/i
-table_option : /[^\s;]*/
+table_option : WORD /\s*=\s*/ WORD
{
- $return = { split /=/, $item[1] }
+ $return = { $item[1] => $item[3] };
}
+CREATE : /create/i
+
+TEMPORARY : /temporary/i
+
+TABLE : /table/i
+
WORD : /\w+/
DIGITS : /\d+/
VALUE : /[-+]?\.?\d+(?:[eE]\d+)?/
{ $item[1] }
- | /'.*?'/ # XXX doesn't handle embedded quotes
- { $item[1] }
+ | /'.*?'/
+ {
+ # remove leading/trailing quotes
+ my $val = $item[1];
+ $val =~ s/^['"]|['"]$//g;
+ $return = $val;
+ }
| /NULL/
{ 'NULL' }
# -------------------------------------------------------------------
sub parse {
my ( $translator, $data ) = @_;
- $parser ||= Parse::RecDescent->new($GRAMMAR);
+ my $parser = Parse::RecDescent->new($GRAMMAR);
- $::RD_TRACE = $translator->trace ? 1 : undef;
- $DEBUG = $translator->debug;
+ local $::RD_TRACE = $translator->trace ? 1 : undef;
+ local $DEBUG = $translator->debug;
unless (defined $parser) {
return $translator->error("Error instantiating Parse::RecDescent ".
}
my $result = $parser->startrule($data);
- die "Parse failed.\n" unless defined $result;
- warn Dumper($result) if $DEBUG;
- return $result;
+ return $translator->error( "Parse failed." ) unless defined $result;
+ warn Dumper( $result ) if $DEBUG;
+
+ my $schema = $translator->schema;
+ my @tables = sort {
+ $result->{ $a }->{'order'} <=> $result->{ $b }->{'order'}
+ } keys %{ $result };
+
+ for my $table_name ( @tables ) {
+ my $tdata = $result->{ $table_name };
+ my $table = $schema->add_table(
+ name => $tdata->{'table_name'},
+ ) or die $schema->error;
+
+ $table->comments( $tdata->{'comments'} );
+
+ my @fields = sort {
+ $tdata->{'fields'}->{$a}->{'order'}
+ <=>
+ $tdata->{'fields'}->{$b}->{'order'}
+ } keys %{ $tdata->{'fields'} };
+
+ for my $fname ( @fields ) {
+ my $fdata = $tdata->{'fields'}{ $fname };
+ my $field = $table->add_field(
+ name => $fdata->{'name'},
+ data_type => $fdata->{'data_type'},
+ size => $fdata->{'size'},
+ default_value => $fdata->{'default'},
+ is_auto_increment => $fdata->{'is_auto_inc'},
+ is_nullable => $fdata->{'null'},
+ comments => $fdata->{'comments'},
+ ) or die $table->error;
+
+ $table->primary_key( $field->name ) if $fdata->{'is_primary_key'};
+
+ for my $qual ( qw[ binary unsigned zerofill list ] ) {
+ if ( my $val = $fdata->{ $qual } || $fdata->{ uc $qual } ) {
+ next if ref $val eq 'ARRAY' && !@$val;
+ $field->extra( $qual, $val );
+ }
+ }
+
+ if ( $field->data_type =~ /(set|enum)/i && !$field->size ) {
+ my %extra = $field->extra;
+ my $longest = 0;
+ for my $len ( map { length } @{ $extra{'list'} || [] } ) {
+ $longest = $len if $len > $longest;
+ }
+ $field->size( $longest ) if $longest;
+ }
+
+ for my $cdata ( @{ $fdata->{'constraints'} } ) {
+ next unless $cdata->{'type'} eq 'foreign_key';
+ $cdata->{'fields'} ||= [ $field->name ];
+ push @{ $tdata->{'constraints'} }, $cdata;
+ }
+ }
+
+ for my $idata ( @{ $tdata->{'indices'} || [] } ) {
+ my $index = $table->add_index(
+ name => $idata->{'name'},
+ type => uc $idata->{'type'},
+ fields => $idata->{'fields'},
+ ) or die $table->error;
+ }
+
+ if ( my @options = @{ $tdata->{'table_options'} || [] } ) {
+ $table->options( \@options ) or die $table->error;
+ }
+
+ for my $cdata ( @{ $tdata->{'constraints'} || [] } ) {
+ my $constraint = $table->add_constraint(
+ name => $cdata->{'name'},
+ type => $cdata->{'type'},
+ fields => $cdata->{'fields'},
+ reference_table => $cdata->{'reference_table'},
+ reference_fields => $cdata->{'reference_fields'},
+ match_type => $cdata->{'match_type'} || '',
+ on_delete => $cdata->{'on_delete_do'},
+ on_update => $cdata->{'on_update_do'},
+ ) or die $table->error;
+ }
+ }
+
+ return 1;
}
1;
-#-----------------------------------------------------
+# -------------------------------------------------------------------
# Where man is not nature is barren.
# William Blake
-#-----------------------------------------------------
+# -------------------------------------------------------------------
=pod
=head1 AUTHOR
Ken Y. Clark E<lt>kclark@cpan.orgE<gt>,
-Chris Mungall
+Chris Mungall E<lt>cjm@fruitfly.orgE<gt>.
=head1 SEE ALSO
-perl(1), Parse::RecDescent.
+perl(1), Parse::RecDescent, SQL::Translator::Schema.
=cut