1 package SQL::Translator::Parser::SQLite;
3 # -------------------------------------------------------------------
4 # Copyright (C) 2002-2009 SQLFairy Authors
6 # This program is free software; you can redistribute it and/or
7 # modify it under the terms of the GNU General Public License as
8 # published by the Free Software Foundation; version 2.
10 # This program is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 # General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
19 # -------------------------------------------------------------------
23 SQL::Translator::Parser::SQLite - parser for SQLite
28 use SQL::Translator::Parser::SQLite;
30 my $translator = SQL::Translator->new;
31 $translator->parser("SQL::Translator::Parser::SQLite");
35 This is a grammar for parsing CREATE statements for SQLite as
38 http://www.sqlite.org/lang.html
43 CREATE [TEMP | TEMPORARY] [UNIQUE] INDEX index-name
44 ON [database-name .] table-name ( column-name [, column-name]* )
45 [ ON CONFLICT conflict-algorithm ]
53 CREATE [TEMP | TEMPORARY] TABLE table-name (
54 column-def [, column-def]*
59 CREATE [TEMP | TEMPORARY] TABLE table-name AS select-statement
62 name [type] [[CONSTRAINT name] column-constraint]*
67 typename ( number , number )
70 NOT NULL [ conflict-clause ] |
71 PRIMARY KEY [sort-order] [ conflict-clause ] |
72 UNIQUE [ conflict-clause ] |
73 CHECK ( expr ) [ conflict-clause ] |
77 PRIMARY KEY ( name [, name]* ) [ conflict-clause ]|
78 UNIQUE ( name [, name]* ) [ conflict-clause ] |
79 CHECK ( expr ) [ conflict-clause ]
82 ON CONFLICT conflict-algorithm
87 CREATE [TEMP | TEMPORARY] TRIGGER trigger-name [ BEFORE | AFTER ]
88 database-event ON [database-name .] table-name
92 CREATE [TEMP | TEMPORARY] TRIGGER trigger-name INSTEAD OF
93 database-event ON [database-name .] view-name
100 UPDATE OF column-list
103 [ FOR EACH ROW | FOR EACH STATEMENT ] [ WHEN expression ]
105 trigger-step ; [ trigger-step ; ]*
109 update-statement | insert-statement |
110 delete-statement | select-statement
115 CREATE [TEMP | TEMPORARY] VIEW view-name AS select-statement
120 ON CONFLICT conflict-algorithm
122 conflict-algorithm ::=
123 ROLLBACK | ABORT | FAIL | IGNORE | REPLACE
128 expr binary-op expr |
133 table-name . column-name |
134 database-name . table-name . column-name |
136 function-name ( expr-list | * ) |
140 expr [NOT] BETWEEN expr AND expr |
141 expr [NOT] IN ( value-list ) |
142 expr [NOT] IN ( select-statement ) |
143 ( select-statement ) |
144 CASE [expr] ( WHEN expr THEN expr )+ [ELSE expr] END
147 LIKE | GLOB | NOT LIKE | NOT GLOB
152 use vars qw[ $DEBUG $VERSION $GRAMMAR @EXPORT_OK ];
154 $DEBUG = 0 unless defined $DEBUG;
157 use Parse::RecDescent;
159 use base qw(Exporter);
161 @EXPORT_OK = qw(parse);
163 # Enable warnings within the Parse::RecDescent module.
164 $::RD_ERRORS = 1; # Make sure the parser dies when it encounters an error
165 $::RD_WARN = 1; # Enable warnings. This will warn on unused rules &c.
166 $::RD_HINT = 1; # Give out hints to help fix problems.
171 my ( %tables, $table_order, @table_comments, @views, @triggers );
175 # The "eofile" rule makes the parser fail if any "statement" rule
176 # fails. Otherwise, the first successful match by a "statement"
177 # won't cause the failure needed to know that the parse, as a whole,
180 startrule : statement(s) eofile {
184 triggers => \@triggers,
190 statement : begin_transaction
197 begin_transaction : /begin/i TRANSACTION(?) SEMICOLON
199 commit : /commit/i SEMICOLON
201 drop : /drop/i (tbl_drop | view_drop | trg_drop) SEMICOLON
203 tbl_drop: TABLE <commit> table_name
205 view_drop: VIEW if_exists(?) view_name
207 trg_drop: TRIGGER if_exists(?) trigger_name
209 comment : /^\s*(?:#|-{2}).*\n/
211 my $comment = $item[1];
212 $comment =~ s/^\s*(#|-{2})\s*//;
213 $comment =~ s/\s*$//;
217 comment : /\/\*/ /[^\*]+/ /\*\//
219 my $comment = $item[2];
220 $comment =~ s/^\s*|\s*$//g;
227 create : CREATE TEMPORARY(?) UNIQUE(?) INDEX NAME ON table_name parens_field_list conflict_clause(?) SEMICOLON
229 my $db_name = $item[7]->{'db_name'} || '';
230 my $table_name = $item[7]->{'name'};
235 on_conflict => $item[9][0],
236 is_temporary => $item[2][0] ? 1 : 0,
239 my $is_unique = $item[3][0];
242 $index->{'type'} = 'unique';
243 push @{ $tables{ $table_name }{'constraints'} }, $index;
246 push @{ $tables{ $table_name }{'indices'} }, $index;
253 create : CREATE TEMPORARY(?) TABLE table_name '(' definition(s /,/) ')' SEMICOLON
255 my $db_name = $item[4]->{'db_name'} || '';
256 my $table_name = $item[4]->{'name'};
258 $tables{ $table_name }{'name'} = $table_name;
259 $tables{ $table_name }{'is_temporary'} = $item[2][0] ? 1 : 0;
260 $tables{ $table_name }{'order'} = ++$table_order;
262 for my $def ( @{ $item[6] } ) {
263 if ( $def->{'supertype'} eq 'column' ) {
264 push @{ $tables{ $table_name }{'fields'} }, $def;
266 elsif ( $def->{'supertype'} eq 'constraint' ) {
267 push @{ $tables{ $table_name }{'constraints'} }, $def;
272 definition : constraint_def | column_def
274 column_def: comment(s?) NAME type(?) column_constraint_def(s?)
277 supertype => 'column',
279 data_type => $item[3][0]->{'type'},
280 size => $item[3][0]->{'size'},
286 constraints => $item[4],
287 comments => $item[1],
291 for my $c ( @{ $item[4] } ) {
292 if ( $c->{'type'} eq 'not_null' ) {
293 $column->{'is_nullable'} = 0;
295 elsif ( $c->{'type'} eq 'primary_key' ) {
296 $column->{'is_primary_key'} = 1;
298 elsif ( $c->{'type'} eq 'unique' ) {
299 $column->{'is_unique'} = 1;
301 elsif ( $c->{'type'} eq 'check' ) {
302 $column->{'check'} = $c->{'expression'};
304 elsif ( $c->{'type'} eq 'default' ) {
305 $column->{'default'} = $c->{'value'};
307 elsif ( $c->{'type'} eq 'autoincrement' ) {
308 $column->{'is_auto_inc'} = 1;
315 type : WORD parens_value_list(?)
323 column_constraint_def : CONSTRAINT constraint_name column_constraint
333 column_constraint : NOT_NULL conflict_clause(?)
340 PRIMARY_KEY sort_order(?) conflict_clause(?)
343 type => 'primary_key',
344 sort_order => $item[2][0],
345 on_conflict => $item[2][0],
349 UNIQUE conflict_clause(?)
353 on_conflict => $item[2][0],
357 CHECK_C '(' expr ')' conflict_clause(?)
361 expression => $item[3],
362 on_conflict => $item[5][0],
377 type => 'foreign_key',
378 reference_table => $item[2]{'reference_table'},
379 reference_fields => $item[2]{'reference_fields'},
386 type => 'autoincrement',
390 constraint_def : comment(s?) CONSTRAINT constraint_name table_constraint
393 comments => $item[1],
399 comment(s?) table_constraint
402 comments => $item[1],
407 table_constraint : PRIMARY_KEY parens_field_list conflict_clause(?)
410 supertype => 'constraint',
411 type => 'primary_key',
413 on_conflict => $item[3][0],
417 UNIQUE parens_field_list conflict_clause(?)
420 supertype => 'constraint',
423 on_conflict => $item[3][0],
427 CHECK_C '(' expr ')' conflict_clause(?)
430 supertype => 'constraint',
432 expression => $item[3],
433 on_conflict => $item[5][0],
437 ref_def : /(\w+)\s*\((\w+)\)/
438 { $return = { reference_table => $1, reference_fields => $2 } }
440 table_name : qualified_name
442 qualified_name : NAME
443 { $return = { name => $item[1] } }
445 qualified_name : /(\w+)\.(\w+)/
446 { $return = { db_name => $1, name => $2 } }
450 constraint_name : NAME
452 conflict_clause : /on conflict/i conflict_algorigthm
454 conflict_algorigthm : /(rollback|abort|fail|ignore|replace)/i
456 parens_field_list : '(' column_list ')'
459 column_list : field_name(s /,/)
461 parens_value_list : '(' VALUE(s /,/) ')'
466 sort_order : /(ASC|DESC)/i
471 create : CREATE TEMPORARY(?) TRIGGER NAME before_or_after(?) database_event ON table_name trigger_action SEMICOLON
473 my $table_name = $item[8]->{'name'};
476 is_temporary => $item[2][0] ? 1 : 0,
479 db_events => [ $item[6] ],
481 on_table => $table_name,
485 create : CREATE TEMPORARY(?) TRIGGER NAME instead_of database_event ON view_name trigger_action
487 my $table_name = $item[8]->{'name'};
490 is_temporary => $item[2][0] ? 1 : 0,
493 db_events => [ $item[6] ],
495 on_table => $table_name,
499 database_event : /(delete|insert|update)/i
501 database_event : /update of/i column_list
503 trigger_action : for_each(?) when(?) BEGIN_C trigger_step(s) END_C
506 for_each => $item[1][0],
512 for_each : /FOR EACH ROW/i
514 when : WHEN expr { $item[2] }
517 /'(\\.|''|[^\\\'])*'/
519 nonstring : /[^;\'"]+/
521 statement_body : string | nonstring
523 trigger_step : /(select|delete|insert|update)/i statement_body(s?) SEMICOLON
525 $return = join( ' ', $item[1], join ' ', @{ $item[2] || [] } )
528 before_or_after : /(before|after)/i { $return = lc $1 }
530 instead_of : /instead of/i
532 if_exists : /if exists/i
534 view_name : qualified_name
536 trigger_name : qualified_name
541 create : CREATE TEMPORARY(?) VIEW view_name AS select_statement
544 name => $item[4]->{'name'},
546 is_temporary => $item[2][0] ? 1 : 0,
550 select_statement : SELECT /[^;]+/ SEMICOLON
552 $return = join( ' ', $item[1], $item[2] );
562 TRANSACTION: /transaction/i
566 TEMPORARY : /temp(orary)?/i { 1 }
572 NOT_NULL : /not null/i
574 PRIMARY_KEY : /primary key/i
594 REFERENCES : /references/i
596 CONSTRAINT : /constraint/i
598 AUTOINCREMENT : /autoincrement/i
600 UNIQUE : /unique/i { 1 }
604 NAME : /["']?(\w+)["']?/ { $return = $1 }
606 VALUE : /[-+]?\.?\d+(?:[eE]\d+)?/
610 # remove leading/trailing quotes
612 $val =~ s/^['"]|['"]$//g;
617 | /CURRENT_TIMESTAMP/i
618 { 'CURRENT_TIMESTAMP' }
622 # -------------------------------------------------------------------
624 my ( $translator, $data ) = @_;
625 my $parser = Parse::RecDescent->new($GRAMMAR);
627 local $::RD_TRACE = $translator->trace ? 1 : undef;
628 local $DEBUG = $translator->debug;
630 unless (defined $parser) {
631 return $translator->error("Error instantiating Parse::RecDescent ".
632 "instance: Bad grammer");
635 my $result = $parser->startrule($data);
636 return $translator->error( "Parse failed." ) unless defined $result;
637 warn Dumper( $result ) if $DEBUG;
639 my $schema = $translator->schema;
642 sort { $a->[0] <=> $b->[0] }
643 map { [ $result->{'tables'}{ $_ }->{'order'}, $_ ] }
644 keys %{ $result->{'tables'} };
646 for my $table_name ( @tables ) {
647 my $tdata = $result->{'tables'}{ $table_name };
648 my $table = $schema->add_table(
649 name => $tdata->{'name'},
650 ) or die $schema->error;
652 $table->comments( $tdata->{'comments'} );
654 for my $fdata ( @{ $tdata->{'fields'} } ) {
655 my $field = $table->add_field(
656 name => $fdata->{'name'},
657 data_type => $fdata->{'data_type'},
658 size => $fdata->{'size'},
659 default_value => $fdata->{'default'},
660 is_auto_increment => $fdata->{'is_auto_inc'},
661 is_nullable => $fdata->{'is_nullable'},
662 comments => $fdata->{'comments'},
663 ) or die $table->error;
665 $table->primary_key( $field->name ) if $fdata->{'is_primary_key'};
667 for my $cdata ( @{ $fdata->{'constraints'} } ) {
668 next unless $cdata->{'type'} eq 'foreign_key';
669 $cdata->{'fields'} ||= [ $field->name ];
670 push @{ $tdata->{'constraints'} }, $cdata;
674 for my $idata ( @{ $tdata->{'indices'} || [] } ) {
675 my $index = $table->add_index(
676 name => $idata->{'name'},
677 type => uc $idata->{'type'},
678 fields => $idata->{'fields'},
679 ) or die $table->error;
682 for my $cdata ( @{ $tdata->{'constraints'} || [] } ) {
683 my $constraint = $table->add_constraint(
684 name => $cdata->{'name'},
685 type => $cdata->{'type'},
686 fields => $cdata->{'fields'},
687 reference_table => $cdata->{'reference_table'},
688 reference_fields => $cdata->{'reference_fields'},
689 match_type => $cdata->{'match_type'} || '',
690 on_delete => $cdata->{'on_delete'}
691 || $cdata->{'on_delete_do'},
692 on_update => $cdata->{'on_update'}
693 || $cdata->{'on_update_do'},
694 ) or die $table->error;
698 for my $def ( @{ $result->{'views'} || [] } ) {
699 my $view = $schema->add_view(
700 name => $def->{'name'},
701 sql => $def->{'sql'},
705 for my $def ( @{ $result->{'triggers'} || [] } ) {
706 my $view = $schema->add_trigger(
707 name => $def->{'name'},
708 perform_action_when => $def->{'when'},
709 database_events => $def->{'db_events'},
710 action => $def->{'action'},
711 on_table => $def->{'on_table'},
720 # -------------------------------------------------------------------
721 # All wholsome food is caught without a net or a trap.
723 # -------------------------------------------------------------------
729 Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.
733 perl(1), Parse::RecDescent, SQL::Translator::Schema.