Release 0.07047
[dbsrgits/DBIx-Class-Schema-Loader.git] / lib / DBIx / Class / Schema / Loader / DBI / SQLite.pm
index cbe9ae0..2f6be90 100644 (file)
@@ -2,46 +2,51 @@ package DBIx::Class::Schema::Loader::DBI::SQLite;
 
 use strict;
 use warnings;
-use base qw/
-    DBIx::Class::Schema::Loader::DBI::Component::QuotedDefault
-    DBIx::Class::Schema::Loader::DBI
-/;
-use Carp::Clan qw/^DBIx::Class/;
-use Text::Balanced qw( extract_bracketed );
-use Class::C3;
+use base 'DBIx::Class::Schema::Loader::DBI::Component::QuotedDefault';
+use mro 'c3';
+use DBIx::Class::Schema::Loader::Table ();
 
-our $VERSION = '0.05001';
+our $VERSION = '0.07047';
 
 =head1 NAME
 
 DBIx::Class::Schema::Loader::DBI::SQLite - DBIx::Class::Schema::Loader::DBI SQLite Implementation.
 
-=head1 SYNOPSIS
-
-  package My::Schema;
-  use base qw/DBIx::Class::Schema::Loader/;
-
-  __PACKAGE__->loader_options( debug => 1 );
-
-  1;
-
 =head1 DESCRIPTION
 
-See L<DBIx::Class::Schema::Loader::Base>.
+See L<DBIx::Class::Schema::Loader> and L<DBIx::Class::Schema::Loader::Base>.
 
 =head1 METHODS
 
 =head2 rescan
 
-SQLite will fail all further commands on a connection if the
-underlying schema has been modified.  Therefore, any runtime
-changes requiring C<rescan> also require us to re-connect
-to the database.  The C<rescan> method here handles that
-reconnection for you, but beware that this must occur for
-any other open sqlite connections as well.
+SQLite will fail all further commands on a connection if the underlying schema
+has been modified.  Therefore, any runtime changes requiring C<rescan> also
+require us to re-connect to the database.  The C<rescan> method here handles
+that reconnection for you, but beware that this must occur for any other open
+sqlite connections as well.
 
 =cut
 
+sub _setup {
+    my $self = shift;
+
+    $self->next::method(@_);
+
+    if (not defined $self->preserve_case) {
+        $self->preserve_case(0);
+    }
+
+    if ($self->db_schema) {
+        warn <<'EOF';
+db_schema is not supported on SQLite, the option is implemented only for qualify_objects testing.
+EOF
+        if ($self->db_schema->[0] eq '%') {
+            $self->db_schema(undef);
+        }
+    }
+}
+
 sub rescan {
     my ($self, $schema) = @_;
 
@@ -49,153 +54,210 @@ sub rescan {
     $self->next::method($schema);
 }
 
-# XXX this really needs a re-factor
-sub _sqlite_parse_table {
-    my ($self, $table) = @_;
+sub _columns_info_for {
+    my $self = shift;
+    my ($table) = @_;
 
-    my @rels;
-    my @uniqs;
-    my %auto_inc;
+    my $result = $self->next::method(@_);
 
-    my $dbh = $self->schema->storage->dbh;
-    my $sth = $self->{_cache}->{sqlite_master}
-        ||= $dbh->prepare(q{SELECT sql FROM sqlite_master WHERE tbl_name = ?});
+    local $self->dbh->{FetchHashKeyName} = 'NAME_lc';
 
-    $sth->execute($table);
-    my ($sql) = $sth->fetchrow_array;
-    $sth->finish;
+    my $sth = $self->dbh->prepare(
+        "pragma table_info(" . $self->dbh->quote_identifier($table) . ")"
+    );
+    $sth->execute;
+    my $cols = $sth->fetchall_hashref('name');
 
-    # Cut "CREATE TABLE ( )" blabla...
-    $sql =~ /^[\w\s']+\((.*)\)$/si;
-    my $cols = $1;
-
-    # strip single-line comments
-    $cols =~ s/\-\-.*\n/\n/g;
-
-    # temporarily replace any commas inside parens,
-    # so we don't incorrectly split on them below
-    my $cols_no_bracketed_commas = $cols;
-    while ( my $extracted =
-        ( extract_bracketed( $cols, "()", "[^(]*" ) )[0] )
-    {
-        my $replacement = $extracted;
-        $replacement              =~ s/,/--comma--/g;
-        $replacement              =~ s/^\(//;
-        $replacement              =~ s/\)$//;
-        $cols_no_bracketed_commas =~ s/$extracted/$replacement/m;
+    # copy and case according to preserve_case mode
+    # no need to check for collisions, SQLite does not allow them
+    my %cols;
+    while (my ($col, $info) = each %$cols) {
+        $cols{ $self->_lc($col) } = $info;
     }
 
-    # Split column definitions
-    for my $col ( split /,/, $cols_no_bracketed_commas ) {
-
-        # put the paren-bracketed commas back, to help
-        # find multi-col fks below
-        $col =~ s/\-\-comma\-\-/,/g;
-
-        $col =~ s/^\s*FOREIGN\s+KEY\s*//i;
-
-        # Strip punctuations around key and table names
-        $col =~ s/[\[\]'"]/ /g;
-        $col =~ s/^\s+//gs;
-
-        # Grab reference
-        chomp $col;
-
-        if($col =~ /^(.*)\s+UNIQUE/i) {
-            my $colname = $1;
-            $colname =~ s/\s+.*$//;
-            push(@uniqs, [ "${colname}_unique" => [ lc $colname ] ]);
-        }
-        elsif($col =~/^\s*UNIQUE\s*\(\s*(.*)\)/i) {
-            my $cols = $1;
-            $cols =~ s/\s+$//;
-            my @cols = map { lc } split(/\s*,\s*/, $cols);
-            my $name = join(q{_}, @cols) . '_unique';
-            push(@uniqs, [ $name => \@cols ]);
+    my ($num_pk, $pk_col) = (0);
+    # SQLite doesn't give us the info we need to do this nicely :(
+    # If there is exactly one column marked PK, and its type is integer,
+    # set it is_auto_increment. This isn't 100%, but it's better than the
+    # alternatives.
+    while (my ($col_name, $info) = each %$result) {
+        if ($cols{$col_name}{pk}) {
+            $num_pk++;
+            if (lc($cols{$col_name}{type}) eq 'integer') {
+                $pk_col = $col_name;
+            }
         }
+    }
 
-        if ($col =~ /AUTOINCREMENT/i) {
-            $col =~ /^(\S+)/;
-            $auto_inc{lc $1} = 1;
-        }
-
-        next if $col !~ /^(.*\S)\s+REFERENCES\s+(\w+) (?: \s* \( (.*) \) )? /ix;
-
-        my ($cols, $f_table, $f_cols) = ($1, $2, $3);
-
-        if($cols =~ /^\(/) { # Table-level
-            $cols =~ s/^\(\s*//;
-            $cols =~ s/\s*\)$//;
+    while (my ($col, $info) = each %$result) {
+        if ((eval { ${ $info->{default_value} } }||'') eq 'CURRENT_TIMESTAMP') {
+            ${ $info->{default_value} } = 'current_timestamp';
         }
-        else {               # Inline
-            $cols =~ s/\s+.*$//;
-        }
-
-        my @cols = map { s/\s*//g; lc $_ } split(/\s*,\s*/,$cols);
-        my $rcols;
-        if($f_cols) {
-            my @f_cols = map { s/\s*//g; lc $_ } split(/\s*,\s*/,$f_cols);
-            croak "Mismatched column count in rel for $table => $f_table"
-              if @cols != @f_cols;
-            $rcols = \@f_cols;
+        if ($num_pk == 1 and defined $pk_col and $pk_col eq $col) {
+            $info->{is_auto_increment} = 1;
         }
-        push(@rels, {
-            local_columns => \@cols,
-            remote_columns => $rcols,
-            remote_table => $f_table,
-        });
     }
 
-    return { rels => \@rels, uniqs => \@uniqs, auto_inc => \%auto_inc };
+    return $result;
 }
 
-sub _extra_column_info {
-    my ($self, $table, $col_name, $sth, $col_num) = @_;
-    ($table, $col_name) = @{$table}{qw/TABLE_NAME COLUMN_NAME/} if ref $table;
-    my %extra_info;
+sub _table_fk_info {
+    my ($self, $table) = @_;
+
+    my $sth = $self->dbh->prepare(
+        "pragma foreign_key_list(" . $self->dbh->quote_identifier($table) . ")"
+    );
+    $sth->execute;
 
-    $self->{_sqlite_parse_data}->{$table} ||=
-        $self->_sqlite_parse_table($table);
+    my @rels;
+    while (my $fk = $sth->fetchrow_hashref) {
+        my $rel = $rels[ $fk->{id} ] ||= {
+            local_columns => [],
+            remote_columns => undef,
+            remote_table => DBIx::Class::Schema::Loader::Table->new(
+                loader => $self,
+                name   => $fk->{table},
+                ($self->db_schema ? (
+                    schema        => $self->db_schema->[0],
+                    ignore_schema => 1,
+                ) : ()),
+            ),
+        };
+
+        push @{ $rel->{local_columns} }, $self->_lc($fk->{from});
+        push @{ $rel->{remote_columns} }, $self->_lc($fk->{to}) if defined $fk->{to};
+
+        $rel->{attrs} ||= {
+            on_delete => uc $fk->{on_delete},
+            on_update => uc $fk->{on_update},
+        };
+
+        warn "This is supposed to be the same rel but remote_table changed from ",
+            $rel->{remote_table}->name, " to ", $fk->{table}
+            if $rel->{remote_table}->name ne $fk->{table};
+    }
+    $sth->finish;
 
-    if ($self->{_sqlite_parse_data}->{$table}->{auto_inc}->{$col_name}) {
-        $extra_info{is_auto_increment} = 1;
+    # now we need to determine whether each FK is DEFERRABLE, this can only be
+    # done by parsing the DDL from sqlite_master
+
+    my $ddl = $self->dbh->selectcol_arrayref(<<"EOF", undef, $table->name, $table->name)->[0];
+select sql from sqlite_master
+where name = ? and tbl_name = ?
+EOF
+
+    foreach my $fk (@rels) {
+        my $local_cols  = '"?' . (join '"? \s* , \s* "?', map quotemeta, @{ $fk->{local_columns} })        . '"?';
+        my $remote_cols = '"?' . (join '"? \s* , \s* "?', map quotemeta, @{ $fk->{remote_columns} || [] }) . '"?';
+        my ($deferrable_clause) = $ddl =~ /
+                foreign \s+ key \s* \( \s* $local_cols \s* \) \s* references \s* (?:\S+|".+?(?<!")") \s*
+                (?:\( \s* $remote_cols \s* \) \s*)?
+                (?:(?:
+                    on \s+ (?:delete|update) \s+ (?:set \s+ null|set \s+ default|cascade|restrict|no \s+ action)
+                |
+                    match \s* (?:\S+|".+?(?<!")")
+                ) \s*)*
+                ((?:not)? \s* deferrable)?
+        /sxi;
+
+        if ($deferrable_clause) {
+            $fk->{attrs}{is_deferrable} = $deferrable_clause =~ /not/i ? 0 : 1;
+        }
+        else {
+            # check for inline constraint if 1 local column
+            if (@{ $fk->{local_columns} } == 1) {
+                my ($local_col)  = @{ $fk->{local_columns} };
+                my ($remote_col) = @{ $fk->{remote_columns} || [] };
+                $remote_col ||= '';
+
+                my ($deferrable_clause) = $ddl =~ /
+                    "?\Q$local_col\E"? \s* (?:\w+\s*)* (?: \( \s* \d\+ (?:\s*,\s*\d+)* \s* \) )? \s*
+                    references \s+ (?:\S+|".+?(?<!")") (?:\s* \( \s* "?\Q$remote_col\E"? \s* \))? \s*
+                    (?:(?:
+                      on \s+ (?:delete|update) \s+ (?:set \s+ null|set \s+ default|cascade|restrict|no \s+ action)
+                    |
+                      match \s* (?:\S+|".+?(?<!")")
+                    ) \s*)*
+                    ((?:not)? \s* deferrable)?
+                /sxi;
+
+                if ($deferrable_clause) {
+                    $fk->{attrs}{is_deferrable} = $deferrable_clause =~ /not/i ? 0 : 1;
+                }
+                else {
+                    $fk->{attrs}{is_deferrable} = 0;
+                }
+            }
+            else {
+                $fk->{attrs}{is_deferrable} = 0;
+            }
+        }
     }
 
-    return \%extra_info;
+    return \@rels;
 }
 
-sub _table_fk_info {
+sub _table_uniq_info {
     my ($self, $table) = @_;
 
-    $self->{_sqlite_parse_data}->{$table} ||=
-        $self->_sqlite_parse_table($table);
+    my $sth = $self->dbh->prepare(
+        "pragma index_list(" . $self->dbh->quote($table) . ")"
+    );
+    $sth->execute;
 
-    return $self->{_sqlite_parse_data}->{$table}->{rels};
-}
+    my @uniqs;
+    while (my $idx = $sth->fetchrow_hashref) {
+        next unless $idx->{unique};
 
-sub _table_uniq_info {
-    my ($self, $table) = @_;
+        my $name = $idx->{name};
+
+        my $get_idx_sth = $self->dbh->prepare("pragma index_info(" . $self->dbh->quote($name) . ")");
+        $get_idx_sth->execute;
+        my @cols;
+        while (my $idx_row = $get_idx_sth->fetchrow_hashref) {
+            push @cols, $self->_lc($idx_row->{name});
+        }
+        $get_idx_sth->finish;
 
-    $self->{_sqlite_parse_data}->{$table} ||=
-        $self->_sqlite_parse_table($table);
+        # Rename because SQLite complains about sqlite_ prefixes on identifiers
+        # and ignores constraint names in DDL.
+        $name = (join '_', @cols) . '_unique';
 
-    return $self->{_sqlite_parse_data}->{$table}->{uniqs};
+        push @uniqs, [ $name => \@cols ];
+    }
+    $sth->finish;
+    return [ sort { $a->[0] cmp $b->[0] } @uniqs ];
 }
 
 sub _tables_list {
-    my $self = shift;
+    my ($self) = @_;
 
-    my $dbh = $self->schema->storage->dbh;
-    my $sth = $dbh->prepare("SELECT * FROM sqlite_master");
+    my $sth = $self->dbh->prepare("SELECT * FROM sqlite_master");
     $sth->execute;
     my @tables;
     while ( my $row = $sth->fetchrow_hashref ) {
-        next unless lc( $row->{type} ) eq 'table';
+        next unless $row->{type} =~ /^(?:table|view)\z/i;
         next if $row->{tbl_name} =~ /^sqlite_/;
-        push @tables, $row->{tbl_name};
+        push @tables, DBIx::Class::Schema::Loader::Table->new(
+            loader => $self,
+            name   => $row->{tbl_name},
+            ($self->db_schema ? (
+                schema        => $self->db_schema->[0],
+                ignore_schema => 1, # for qualify_objects tests
+            ) : ()),
+        );
     }
     $sth->finish;
-    return @tables;
+    return $self->_filter_tables(\@tables);
+}
+
+sub _table_info_matches {
+    my ($self, $table, $info) = @_;
+
+    my $table_schema = $table->schema;
+    $table_schema = 'main' if !defined $table_schema;
+    return $info->{TABLE_SCHEM} eq $table_schema
+        && $info->{TABLE_NAME}  eq $table->name;
 }
 
 =head1 SEE ALSO
@@ -203,9 +265,9 @@ sub _tables_list {
 L<DBIx::Class::Schema::Loader>, L<DBIx::Class::Schema::Loader::Base>,
 L<DBIx::Class::Schema::Loader::DBI>
 
-=head1 AUTHOR
+=head1 AUTHORS
 
-See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
+See L<DBIx::Class::Schema::Loader/AUTHORS>.
 
 =head1 LICENSE
 
@@ -215,3 +277,4 @@ the same terms as Perl itself.
 =cut
 
 1;
+# vim:et sts=4 sw=4 tw=0: