1 package SQL::Translator::Parser::SQLite;
3 # -------------------------------------------------------------------
4 # $Id: SQLite.pm,v 1.7 2005-06-28 16:39:41 mwz444 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::SQLite - parser for SQLite
30 use SQL::Translator::Parser::SQLite;
32 my $translator = SQL::Translator->new;
33 $translator->parser("SQL::Translator::Parser::SQLite");
37 This is a grammar for parsing CREATE statements for SQLite as
40 http://www.sqlite.org/lang.html
45 CREATE [TEMP | TEMPORARY] [UNIQUE] INDEX index-name
46 ON [database-name .] table-name ( column-name [, column-name]* )
47 [ ON CONFLICT conflict-algorithm ]
55 CREATE [TEMP | TEMPORARY] TABLE table-name (
56 column-def [, column-def]*
61 CREATE [TEMP | TEMPORARY] TABLE table-name AS select-statement
64 name [type] [[CONSTRAINT name] column-constraint]*
69 typename ( number , number )
72 NOT NULL [ conflict-clause ] |
73 PRIMARY KEY [sort-order] [ conflict-clause ] |
74 UNIQUE [ conflict-clause ] |
75 CHECK ( expr ) [ conflict-clause ] |
79 PRIMARY KEY ( name [, name]* ) [ conflict-clause ]|
80 UNIQUE ( name [, name]* ) [ conflict-clause ] |
81 CHECK ( expr ) [ conflict-clause ]
84 ON CONFLICT conflict-algorithm
89 CREATE [TEMP | TEMPORARY] TRIGGER trigger-name [ BEFORE | AFTER ]
90 database-event ON [database-name .] table-name
94 CREATE [TEMP | TEMPORARY] TRIGGER trigger-name INSTEAD OF
95 database-event ON [database-name .] view-name
102 UPDATE OF column-list
105 [ FOR EACH ROW | FOR EACH STATEMENT ] [ WHEN expression ]
107 trigger-step ; [ trigger-step ; ]*
111 update-statement | insert-statement |
112 delete-statement | select-statement
117 CREATE [TEMP | TEMPORARY] VIEW view-name AS select-statement
122 ON CONFLICT conflict-algorithm
124 conflict-algorithm ::=
125 ROLLBACK | ABORT | FAIL | IGNORE | REPLACE
130 expr binary-op expr |
135 table-name . column-name |
136 database-name . table-name . column-name |
138 function-name ( expr-list | * ) |
142 expr [NOT] BETWEEN expr AND expr |
143 expr [NOT] IN ( value-list ) |
144 expr [NOT] IN ( select-statement ) |
145 ( select-statement ) |
146 CASE [expr] ( WHEN expr THEN expr )+ [ELSE expr] END
149 LIKE | GLOB | NOT LIKE | NOT GLOB
154 use vars qw[ $DEBUG $VERSION $GRAMMAR @EXPORT_OK ];
155 $VERSION = sprintf "%d.%02d", q$Revision: 1.7 $ =~ /(\d+)\.(\d+)/;
156 $DEBUG = 0 unless defined $DEBUG;
159 use Parse::RecDescent;
161 use base qw(Exporter);
163 @EXPORT_OK = qw(parse);
165 # Enable warnings within the Parse::RecDescent module.
166 $::RD_ERRORS = 1; # Make sure the parser dies when it encounters an error
167 $::RD_WARN = 1; # Enable warnings. This will warn on unused rules &c.
168 $::RD_HINT = 1; # Give out hints to help fix problems.
173 my ( %tables, $table_order, @table_comments, @views, @triggers );
177 # The "eofile" rule makes the parser fail if any "statement" rule
178 # fails. Otherwise, the first successful match by a "statement"
179 # won't cause the failure needed to know that the parse, as a whole,
182 startrule : statement(s) eofile {
186 triggers => \@triggers,
192 statement : begin_transaction
198 begin_transaction : /begin transaction/i SEMICOLON
200 commit : /commit/i SEMICOLON
202 comment : /^\s*(?:#|-{2}).*\n/
204 my $comment = $item[1];
205 $comment =~ s/^\s*(#|-{2})\s*//;
206 $comment =~ s/\s*$//;
210 comment : /\/\*/ /[^\*]+/ /\*\//
212 my $comment = $item[2];
213 $comment =~ s/^\s*|\s*$//g;
220 create : CREATE TEMPORARY(?) UNIQUE(?) INDEX WORD ON table_name parens_field_list conflict_clause(?) SEMICOLON
222 my $db_name = $item[7]->{'db_name'} || '';
223 my $table_name = $item[7]->{'name'};
228 on_conflict => $item[9][0],
229 is_temporary => $item[2][0] ? 1 : 0,
232 my $is_unique = $item[3][0];
235 $index->{'type'} = 'unique';
236 push @{ $tables{ $table_name }{'constraints'} }, $index;
239 push @{ $tables{ $table_name }{'indices'} }, $index;
246 create : CREATE TEMPORARY(?) TABLE table_name '(' definition(s /,/) ')' SEMICOLON
248 my $db_name = $item[4]->{'db_name'} || '';
249 my $table_name = $item[4]->{'name'};
251 $tables{ $table_name }{'name'} = $table_name;
252 $tables{ $table_name }{'is_temporary'} = $item[2][0] ? 1 : 0;
253 $tables{ $table_name }{'order'} = ++$table_order;
255 for my $def ( @{ $item[6] } ) {
256 if ( $def->{'supertype'} eq 'column' ) {
257 push @{ $tables{ $table_name }{'fields'} }, $def;
259 elsif ( $def->{'supertype'} eq 'constraint' ) {
260 push @{ $tables{ $table_name }{'constraints'} }, $def;
265 definition : constraint_def | column_def
267 column_def: NAME type(?) column_constraint(s?)
270 supertype => 'column',
272 data_type => $item[2][0]->{'type'},
273 size => $item[2][0]->{'size'},
279 constraints => $item[3],
282 for my $c ( @{ $item[3] } ) {
283 if ( $c->{'type'} eq 'not_null' ) {
284 $column->{'is_nullable'} = 0;
286 elsif ( $c->{'type'} eq 'primary_key' ) {
287 $column->{'is_primary_key'} = 1;
289 elsif ( $c->{'type'} eq 'unique' ) {
290 $column->{'is_unique'} = 1;
292 elsif ( $c->{'type'} eq 'check' ) {
293 $column->{'check'} = $c->{'expression'};
295 elsif ( $c->{'type'} eq 'default' ) {
296 $column->{'default'} = $c->{'value'};
303 type : WORD parens_value_list(?)
311 column_constraint : NOT_NULL conflict_clause(?)
318 PRIMARY_KEY sort_order(?) conflict_clause(?)
321 type => 'primary_key',
322 sort_order => $item[2][0],
323 on_conflict => $item[2][0],
327 UNIQUE conflict_clause(?)
331 on_conflict => $item[2][0],
335 CHECK_C '(' expr ')' conflict_clause(?)
339 expression => $item[3],
340 on_conflict => $item[5][0],
352 constraint_def : PRIMARY_KEY parens_field_list conflict_clause(?)
355 supertype => 'constraint',
356 type => 'primary_key',
358 on_conflict => $item[3][0],
362 UNIQUE parens_field_list conflict_clause(?)
365 supertype => 'constraint',
368 on_conflict => $item[3][0],
372 CHECK_C '(' expr ')' conflict_clause(?)
375 supertype => 'constraint',
377 expression => $item[3],
378 on_conflict => $item[5][0],
382 table_name : qualified_name
384 qualified_name : NAME
385 { $return = { name => $item[1] } }
387 qualified_name : /(\w+)\.(\w+)/
388 { $return = { db_name => $1, name => $2 } }
392 conflict_clause : /on conflict/i conflict_algorigthm
394 conflict_algorigthm : /(rollback|abort|fail|ignore|replace)/i
396 parens_field_list : '(' column_list ')'
399 column_list : field_name(s /,/)
401 parens_value_list : '(' VALUE(s /,/) ')'
406 sort_order : /(ASC|DESC)/i
411 create : CREATE TEMPORARY(?) TRIGGER NAME before_or_after(?) database_event ON table_name trigger_action
413 my $table_name = $item[8]->{'name'};
416 is_temporary => $item[2][0] ? 1 : 0,
419 db_event => $item[6],
424 create : CREATE TEMPORARY(?) TRIGGER NAME instead_of database_event ON view_name trigger_action
426 my $table_name = $item[8]->{'name'};
429 is_temporary => $item[2][0] ? 1 : 0,
432 db_event => $item[6],
437 database_event : /(delete|insert|update)/i
439 database_event : /update of/i column_list
441 trigger_action : for_each(?) when(?) BEGIN_C trigger_step(s) END_C
444 for_each => $item[1][0],
450 for_each : /FOR EACH ROW/i | /FOR EACH STATEMENT/i
452 when : WHEN expr { $item[2] }
454 trigger_step : /(select|delete|insert|update)/i /[^;]+/ SEMICOLON
456 $return = join( ' ', $item[1], $item[2] )
459 before_or_after : /(before|after)/i { $return = lc $1 }
461 instead_of : /instead of/i
463 view_name : qualified_name
468 create : CREATE TEMPORARY(?) VIEW view_name AS select_statement
471 name => $item[4]->{'name'},
473 is_temporary => $item[2][0] ? 1 : 0,
477 select_statement : SELECT /[^;]+/ SEMICOLON
479 $return = join( ' ', $item[1], $item[2] );
491 TEMPORARY : /temp(orary)?/i { 1 }
497 NOT_NULL : /not null/i
499 PRIMARY_KEY : /primary key/i
519 UNIQUE : /unique/i { 1 }
523 NAME : /'?(\w+)'?/ { $return = $1 }
525 VALUE : /[-+]?\.?\d+(?:[eE]\d+)?/
529 # remove leading/trailing quotes
531 $val =~ s/^['"]|['"]$//g;
539 # -------------------------------------------------------------------
541 my ( $translator, $data ) = @_;
542 my $parser = Parse::RecDescent->new($GRAMMAR);
544 local $::RD_TRACE = $translator->trace ? 1 : undef;
545 local $DEBUG = $translator->debug;
547 unless (defined $parser) {
548 return $translator->error("Error instantiating Parse::RecDescent ".
549 "instance: Bad grammer");
552 my $result = $parser->startrule($data);
553 return $translator->error( "Parse failed." ) unless defined $result;
554 warn Dumper( $result ) if $DEBUG;
556 my $schema = $translator->schema;
559 sort { $a->[0] <=> $b->[0] }
560 map { [ $result->{'tables'}{ $_ }->{'order'}, $_ ] }
561 keys %{ $result->{'tables'} };
563 for my $table_name ( @tables ) {
564 my $tdata = $result->{'tables'}{ $table_name };
565 my $table = $schema->add_table(
566 name => $tdata->{'name'},
567 ) or die $schema->error;
569 $table->comments( $tdata->{'comments'} );
571 for my $fdata ( @{ $tdata->{'fields'} } ) {
572 my $field = $table->add_field(
573 name => $fdata->{'name'},
574 data_type => $fdata->{'data_type'},
575 size => $fdata->{'size'},
576 default_value => $fdata->{'default'},
577 is_auto_increment => $fdata->{'is_auto_inc'},
578 is_nullable => $fdata->{'is_nullable'},
579 comments => $fdata->{'comments'},
580 ) or die $table->error;
582 $table->primary_key( $field->name ) if $fdata->{'is_primary_key'};
584 for my $cdata ( @{ $fdata->{'constraints'} } ) {
585 next unless $cdata->{'type'} eq 'foreign_key';
586 $cdata->{'fields'} ||= [ $field->name ];
587 push @{ $tdata->{'constraints'} }, $cdata;
591 for my $idata ( @{ $tdata->{'indices'} || [] } ) {
592 my $index = $table->add_index(
593 name => $idata->{'name'},
594 type => uc $idata->{'type'},
595 fields => $idata->{'fields'},
596 ) or die $table->error;
599 for my $cdata ( @{ $tdata->{'constraints'} || [] } ) {
600 my $constraint = $table->add_constraint(
601 name => $cdata->{'name'},
602 type => $cdata->{'type'},
603 fields => $cdata->{'fields'},
604 reference_table => $cdata->{'reference_table'},
605 reference_fields => $cdata->{'reference_fields'},
606 match_type => $cdata->{'match_type'} || '',
607 on_delete => $cdata->{'on_delete'} || $cdata->{'on_delete_do'},
608 on_update => $cdata->{'on_update'} || $cdata->{'on_update_do'},
609 ) or die $table->error;
613 for my $def ( @{ $result->{'views'} || [] } ) {
614 my $view = $schema->add_view(
615 name => $def->{'name'},
616 sql => $def->{'sql'},
620 for my $def ( @{ $result->{'triggers'} || [] } ) {
621 my $view = $schema->add_trigger(
622 name => $def->{'name'},
623 perform_action_when => $def->{'when'},
624 database_event => $def->{'db_event'},
625 action => $def->{'action'},
634 # -------------------------------------------------------------------
635 # All wholsome food is caught without a net or a trap.
637 # -------------------------------------------------------------------
643 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
647 perl(1), Parse::RecDescent, SQL::Translator::Schema.