X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits%2FDBIx-Class.git;a=blobdiff_plain;f=lib%2FSQL%2FTranslator%2FParser%2FDBIx%2FClass.pm;h=e760580bb156ff833ef7f9a6a1e1f80887581eb9;hp=448c65127723481e39b5ffd4b32a5d65f937113c;hb=a7f4b74cf7a4e82dcf4ef3847c5881f6dad361c9;hpb=2478970cd1dec7679985cb282afa0af420f517cc diff --git a/lib/SQL/Translator/Parser/DBIx/Class.pm b/lib/SQL/Translator/Parser/DBIx/Class.pm index 448c651..e760580 100644 --- a/lib/SQL/Translator/Parser/DBIx/Class.pm +++ b/lib/SQL/Translator/Parser/DBIx/Class.pm @@ -4,15 +4,17 @@ package SQL::Translator::Parser::DBIx::Class; # Some mistakes the fault of Matt S Trout +# Others the fault of Ash Berlin + use strict; use warnings; use vars qw($DEBUG $VERSION @EXPORT_OK); +$VERSION = '1.10'; $DEBUG = 0 unless defined $DEBUG; -$VERSION = sprintf "%d.%02d", q$Revision 1.0$ =~ /(\d+)\.(\d+)/; use Exporter; -use Data::Dumper; use SQL::Translator::Utils qw(debug normalize_name); +use Carp::Clan qw/^SQL::Translator|^DBIx::Class/; use base qw(Exporter); @@ -21,41 +23,80 @@ use base qw(Exporter); # ------------------------------------------------------------------- # parse($tr, $data) # -# Note that $data, in the case of this parser, is unuseful. +# setting parser_args => { add_fk_index => 0 } will prevent +# the auto-generation of an index for each FK. +# +# Note that $data, in the case of this parser, is not useful. # We're working with DBIx::Class Schemas, not data streams. # ------------------------------------------------------------------- sub parse { - my ($tr, $data) = @_; - my $args = $tr->parser_args; - my $dbixschema = $args->{'DBIx::Schema'} || $data; - $dbixschema ||= $args->{'package'}; - - die 'No DBIx::Schema' unless ($dbixschema); - if (!ref $dbixschema) { - eval "use $dbixschema;"; - die "Can't load $dbixschema ($@)" if($@); + my ($tr, $data) = @_; + my $args = $tr->parser_args; + my $dbicschema = $args->{'DBIx::Class::Schema'} || $args->{"DBIx::Schema"} ||$data; + $dbicschema ||= $args->{'package'}; + my $limit_sources = $args->{'sources'}; + + croak 'No DBIx::Class::Schema' unless ($dbicschema); + if (!ref $dbicschema) { + eval "use $dbicschema;"; + croak "Can't load $dbicschema ($@)" if($@); } my $schema = $tr->schema; my $table_no = 0; -# print Dumper($dbixschema->registered_classes); + $schema->name( ref($dbicschema) . " v" . ($dbicschema->schema_version || '1.x')) + unless ($schema->name); + + my @monikers = sort $dbicschema->sources; + if ($limit_sources) { + my $ref = ref $limit_sources || ''; + $dbicschema->throw_exception ("'sources' parameter must be an array or hash ref") + unless( $ref eq 'ARRAY' || ref eq 'HASH' ); + + # limit monikers to those specified in + my $sources; + if ($ref eq 'ARRAY') { + $sources->{$_} = 1 for (@$limit_sources); + } else { + $sources = $limit_sources; + } + @monikers = grep { $sources->{$_} } @monikers; + } + + + my(%table_monikers, %view_monikers); + for my $moniker (@monikers){ + my $source = $dbicschema->source($moniker); + if ( $source->isa('DBIx::Class::ResultSource::Table') ) { + $table_monikers{$moniker}++; + } elsif( $source->isa('DBIx::Class::ResultSource::View') ){ + next if $source->is_virtual; + $view_monikers{$moniker}++; + } + } - #foreach my $tableclass ($dbixschema->registered_classes) - foreach my $moniker ($dbixschema->sources) + my %tables; + foreach my $moniker (sort keys %table_monikers) { - #eval "use $tableclass"; - #print("Can't load $tableclass"), next if($@); - my $source = $dbixschema->source($moniker); + my $source = $dbicschema->source($moniker); + my $table_name = $source->name; + + # FIXME - this isn't the right way to do it, but sqlt does not + # support quoting properly to be signaled about this + $table_name = $$table_name if ref $table_name eq 'SCALAR'; + + # It's possible to have multiple DBIC sources using the same table + next if $tables{$table_name}; - my $table = $schema->add_table( - name => $source->name, + $tables{$table_name}{source} = $source; + my $table = $tables{$table_name}{object} = SQL::Translator::Schema::Table->new( + name => $table_name, type => 'TABLE', - ) || die $schema->error; - my $colcount = 0; + ); foreach my $col ($source->columns) { - # assuming column_info in dbix is the same as DBI (?) + # assuming column_info in dbic is the same as DBI (?) # data_type is a number, column_type is text? my %colinfo = ( name => $col, @@ -68,43 +109,299 @@ sub parse { if ($colinfo{is_nullable}) { $colinfo{default} = '' unless exists $colinfo{default}; } - my $f = $table->add_field(%colinfo) || die $table->error; + my $f = $table->add_field(%colinfo) + || $dbicschema->throw_exception ($table->error); } $table->primary_key($source->primary_columns); + my @primary = $source->primary_columns; + my %unique_constraints = $source->unique_constraints; + foreach my $uniq (sort keys %unique_constraints) { + if (!$source->_compare_relationship_keys($unique_constraints{$uniq}, \@primary)) { + $table->add_constraint( + type => 'unique', + name => $uniq, + fields => $unique_constraints{$uniq} + ); + } + } + my @rels = $source->relationships(); - foreach my $rel (@rels) + + my %created_FK_rels; + + # global add_fk_index set in parser_args + my $add_fk_index = (exists $args->{add_fk_index} && ! $args->{add_fk_index}) ? 0 : 1; + + foreach my $rel (sort @rels) { + my $rel_info = $source->relationship_info($rel); - next if(!exists $rel_info->{attrs}{accessor} || - $rel_info->{attrs}{accessor} eq 'multi'); - # Going by the accessor type isn't such a good idea (yes, I know - # I suggested it). I think the best way to tell if something's a - # foreign key constraint is to assume if it doesn't include our - # primaries then it is (dumb but it'll do). Ignore any rel cond - # that isn't a straight hash, but get both sets of keys in full - # so you don't barf on multi-primaries. Oh, and a dog-simple - # deploy method to chuck the results of this exercise at a db - # for testing is - # $schema->storage->dbh->do($_) for split(";\n", $sql); - # -- mst (03:42 local time, please excuse any mistakes) - my $rel_table = $source->related_source($rel)->name; - my $cond = (keys (%{$rel_info->{cond}}))[0]; - my ($refkey) = $cond =~ /^\w+\.(\w+)$/; - my ($key) = $rel_info->{cond}->{$cond} =~ /^\w+\.(\w+)$/; - if($rel_table && $refkey) - { - $table->add_constraint( - type => 'foreign_key', - name => "fk_${key}", - fields => $key, - reference_fields => $refkey, - reference_table => $rel_table, - ); + + # Ignore any rel cond that isn't a straight hash + next unless ref $rel_info->{cond} eq 'HASH'; + + my $relsource = $source->related_source($rel); + + # related sources might be excluded via a {sources} filter or might be views + next unless exists $table_monikers{$relsource->source_name}; + + my $rel_table = $relsource->name; + + # FIXME - this isn't the right way to do it, but sqlt does not + # support quoting properly to be signaled about this + $rel_table = $$rel_table if ref $rel_table eq 'SCALAR'; + + my $reverse_rels = $source->reverse_relationship_info($rel); + my ($otherrelname, $otherrelationship) = each %{$reverse_rels}; + + # Force the order of @cond to match the order of ->add_columns + my $idx; + my %other_columns_idx = map {'foreign.'.$_ => ++$idx } $relsource->columns; + my @cond = sort { $other_columns_idx{$a} cmp $other_columns_idx{$b} } keys(%{$rel_info->{cond}}); + + # Get the key information, mapping off the foreign/self markers + my @refkeys = map {/^\w+\.(\w+)$/} @cond; + my @keys = map {$rel_info->{cond}->{$_} =~ /^\w+\.(\w+)$/} @cond; + + # determine if this relationship is a self.fk => foreign.pk (i.e. belongs_to) + my $fk_constraint; + + #first it can be specified explicitly + if ( exists $rel_info->{attrs}{is_foreign_key_constraint} ) { + $fk_constraint = $rel_info->{attrs}{is_foreign_key_constraint}; + } + # it can not be multi + elsif ( $rel_info->{attrs}{accessor} + && $rel_info->{attrs}{accessor} eq 'multi' ) { + $fk_constraint = 0; + } + # if indeed single, check if all self.columns are our primary keys. + # this is supposed to indicate a has_one/might_have... + # where's the introspection!!?? :) + else { + $fk_constraint = not $source->_compare_relationship_keys(\@keys, \@primary); + } + + my $cascade; + for my $c (qw/delete update/) { + if (exists $rel_info->{attrs}{"on_$c"}) { + if ($fk_constraint) { + $cascade->{$c} = $rel_info->{attrs}{"on_$c"}; + } + elsif ( $rel_info->{attrs}{"on_$c"} ) { + carp "SQLT attribute 'on_$c' was supplied for relationship '$moniker/$rel', which does not appear to be a foreign constraint. " + . "If you are sure that SQLT must generate a constraint for this relationship, add 'is_foreign_key_constraint => 1' to the attributes.\n"; + } + } + elsif (defined $otherrelationship and $otherrelationship->{attrs}{$c eq 'update' ? 'cascade_copy' : 'cascade_delete'}) { + $cascade->{$c} = 'CASCADE'; + } + } + + if($rel_table) + { + # Constraints are added only if applicable + next unless $fk_constraint; + + # Make sure we dont create the same foreign key constraint twice + my $key_test = join("\x00", sort @keys); + next if $created_FK_rels{$rel_table}->{$key_test}; + + if (scalar(@keys)) { + + $created_FK_rels{$rel_table}->{$key_test} = 1; + + my $is_deferrable = $rel_info->{attrs}{is_deferrable}; + + # calculate dependencies: do not consider deferrable constraints and + # self-references for dependency calculations + if (! $is_deferrable and $rel_table ne $table_name) { + $tables{$table_name}{foreign_table_deps}{$rel_table}++; + } + + $table->add_constraint( + type => 'foreign_key', + name => join('_', $table_name, 'fk', @keys), + fields => \@keys, + reference_fields => \@refkeys, + reference_table => $rel_table, + on_delete => uc ($cascade->{delete} || ''), + on_update => uc ($cascade->{update} || ''), + (defined $is_deferrable ? ( deferrable => $is_deferrable ) : ()), + ); + + # global parser_args add_fk_index param can be overridden on the rel def + my $add_fk_index_rel = (exists $rel_info->{attrs}{add_fk_index}) ? $rel_info->{attrs}{add_fk_index} : $add_fk_index; + + if ($add_fk_index_rel) { + my $index = $table->add_index( + name => join('_', $table_name, 'idx', @keys), + fields => \@keys, + type => 'NORMAL', + ); + } + } } } + } -} + # attach the tables to the schema in dependency order + my $dependencies = { + map { $_ => _resolve_deps ($_, \%tables) } (keys %tables) + }; + for my $table (sort + { + keys %{$dependencies->{$a} || {} } <=> keys %{ $dependencies->{$b} || {} } + || + $a cmp $b + } + (keys %tables) + ) { + $schema->add_table ($tables{$table}{object}); + $tables{$table}{source} -> _invoke_sqlt_deploy_hook( $tables{$table}{object} ); + + # the hook might have already removed the table + if ($schema->get_table($table) && $table =~ /^ \s* \( \s* SELECT \s+/ix) { + warn <<'EOW'; + +Custom SQL through ->name(\'( SELECT ...') is DEPRECATED, for more details see +"Arbitrary SQL through a custom ResultSource" in DBIx::Class::Manual::Cookbook +or http://search.cpan.org/dist/DBIx-Class/lib/DBIx/Class/Manual/Cookbook.pod + +EOW + + # remove the table as there is no way someone might want to + # actually deploy this + $schema->drop_table ($table); + } + } + + my %views; + foreach my $moniker (sort keys %view_monikers) + { + my $source = $dbicschema->source($moniker); + my $view_name = $source->name; + + # FIXME - this isn't the right way to do it, but sqlt does not + # support quoting properly to be signaled about this + $view_name = $$view_name if ref $view_name eq 'SCALAR'; + + # Skip custom query sources + next if ref $view_name; + + # Its possible to have multiple DBIC source using same table + next if $views{$view_name}++; + + $dbicschema->throw_exception ("view $view_name is missing a view_definition") + unless $source->view_definition; + + my $view = $schema->add_view ( + name => $view_name, + fields => [ $source->columns ], + $source->view_definition ? ( 'sql' => $source->view_definition ) : () + ) || $dbicschema->throw_exception ($schema->error); + + $source->_invoke_sqlt_deploy_hook($view); + } + + + if ($dbicschema->can('sqlt_deploy_hook')) { + $dbicschema->sqlt_deploy_hook($schema); + } + + return 1; +} + +# +# Quick and dirty dependency graph calculator +# +sub _resolve_deps { + my ($table, $tables, $seen) = @_; + + my $ret = {}; + $seen ||= {}; + + # copy and bump all deps by one (so we can reconstruct the chain) + my %seen = map { $_ => $seen->{$_} + 1 } (keys %$seen); + $seen{$table} = 1; + + for my $dep (keys %{$tables->{$table}{foreign_table_deps}} ) { + + if ($seen->{$dep}) { + + # warn and remove the circular constraint so we don't get flooded with the same warning over and over + #carp sprintf ("Circular dependency detected, schema may not be deployable:\n%s\n", + # join (' -> ', (sort { $seen->{$b} <=> $seen->{$a} } (keys %$seen) ), $table, $dep ) + #); + #delete $tables->{$table}{foreign_table_deps}{$dep}; + + return {}; + } + + my $subdeps = _resolve_deps ($dep, $tables, \%seen); + $ret->{$_} += $subdeps->{$_} for ( keys %$subdeps ); + + ++$ret->{$dep}; + } + + return $ret; +} 1; + +=head1 NAME + +SQL::Translator::Parser::DBIx::Class - Create a SQL::Translator schema +from a DBIx::Class::Schema instance + +=head1 SYNOPSIS + + ## Via DBIx::Class + use MyApp::Schema; + my $schema = MyApp::Schema->connect("dbi:SQLite:something.db"); + $schema->create_ddl_dir(); + ## or + $schema->deploy(); + + ## Standalone + use MyApp::Schema; + use SQL::Translator; + + my $schema = MyApp::Schema->connect; + my $trans = SQL::Translator->new ( + parser => 'SQL::Translator::Parser::DBIx::Class', + parser_args => { package => $schema }, + producer => 'SQLite', + ) or die SQL::Translator->error; + my $out = $trans->translate() or die $trans->error; + +=head1 DESCRIPTION + +This class requires L installed to work. + +C reads a DBIx::Class schema, +interrogates the columns, and stuffs it all in an $sqlt_schema object. + +Its primary use is in deploying database layouts described as a set +of L classes, to a database. To do this, see +L. + +This can also be achieved by having DBIx::Class export the schema as a +set of SQL files ready for import into your database, or passed to +other machines that need to have your application installed but don't +have SQL::Translator installed. To do this see +L. + +=head1 SEE ALSO + +L, L + +=head1 AUTHORS + +Jess Robinson + +Matt S Trout + +Ash Berlin