X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FSQL%2FTranslator%2FParser%2FDBIx%2FClass.pm;h=dc13790748fe948950770a29bdd87da18db9373e;hb=7536c92b1affd50dd567cb1acae7a38f2222d04d;hp=bb40c9108879b76e579b618afd5362e2377c0f04;hpb=e3d5a54703819b831dc177f60ded50328629973b;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/SQL/Translator/Parser/DBIx/Class.pm b/lib/SQL/Translator/Parser/DBIx/Class.pm index bb40c91..dc13790 100644 --- a/lib/SQL/Translator/Parser/DBIx/Class.pm +++ b/lib/SQL/Translator/Parser/DBIx/Class.pm @@ -8,13 +8,17 @@ package SQL::Translator::Parser::DBIx::Class; use strict; use warnings; -use vars qw($DEBUG $VERSION @EXPORT_OK); +our ($DEBUG, $VERSION, @EXPORT_OK); $VERSION = '1.10'; $DEBUG = 0 unless defined $DEBUG; use Exporter; use SQL::Translator::Utils qw(debug normalize_name); -use Carp::Clan qw/^SQL::Translator|^DBIx::Class/; +use DBIx::Class::Carp qw/^SQL::Translator|^DBIx::Class|^Try::Tiny/; +use DBIx::Class::Exception; +use Scalar::Util 'blessed'; +use Try::Tiny; +use namespace::clean; use base qw(Exporter); @@ -36,10 +40,10 @@ sub parse { $dbicschema ||= $args->{'package'}; my $limit_sources = $args->{'sources'}; - croak 'No DBIx::Class::Schema' unless ($dbicschema); + DBIx::Class::Exception->throw('No DBIx::Class::Schema') unless ($dbicschema); if (!ref $dbicschema) { - eval "use $dbicschema;"; - croak "Can't load $dbicschema ($@)" if($@); + eval "require $dbicschema" + or DBIx::Class::Exception->throw("Can't load $dbicschema: $@"); } my $schema = $tr->schema; @@ -54,7 +58,7 @@ sub parse { $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 + # limit monikers to those specified in my $sources; if ($ref eq 'ARRAY') { $sources->{$_} = 1 for (@$limit_sources); @@ -65,19 +69,19 @@ sub parse { } - my(@table_monikers, @view_monikers); + my(%table_monikers, %view_monikers); for my $moniker (@monikers){ my $source = $dbicschema->source($moniker); if ( $source->isa('DBIx::Class::ResultSource::Table') ) { - push(@table_monikers, $moniker); + $table_monikers{$moniker}++; } elsif( $source->isa('DBIx::Class::ResultSource::View') ){ next if $source->is_virtual; - push(@view_monikers, $moniker); + $view_monikers{$moniker}++; } } my %tables; - foreach my $moniker (sort @table_monikers) + foreach my $moniker (sort keys %table_monikers) { my $source = $dbicschema->source($moniker); my $table_name = $source->name; @@ -112,9 +116,11 @@ sub parse { my $f = $table->add_field(%colinfo) || $dbicschema->throw_exception ($table->error); } - $table->primary_key($source->primary_columns); my @primary = $source->primary_columns; + + $table->primary_key(@primary) if @primary; + my %unique_constraints = $source->unique_constraints; foreach my $uniq (sort keys %unique_constraints) { if (!$source->_compare_relationship_keys($unique_constraints{$uniq}, \@primary)) { @@ -131,18 +137,26 @@ sub parse { 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)) ? 0 : 1; + 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); # Ignore any rel cond that isn't a straight hash next unless ref $rel_info->{cond} eq 'HASH'; - my $othertable = $source->related_source($rel); - next if $othertable->isa('DBIx::Class::ResultSource::View'); # can't define constraints referencing a view - my $rel_table = $othertable->name; + my $relsource = try { $source->related_source($rel) }; + unless ($relsource) { + carp "Ignoring relationship '$rel' - related resultsource '$rel_info->{class}' is not registered with this schema\n"; + next; + }; + + # 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 @@ -153,8 +167,8 @@ sub parse { # Force the order of @cond to match the order of ->add_columns my $idx; - my %other_columns_idx = map {'foreign.'.$_ => ++$idx } $othertable->columns; - my @cond = sort { $other_columns_idx{$a} cmp $other_columns_idx{$b} } keys(%{$rel_info->{cond}}); + 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; @@ -195,8 +209,7 @@ sub parse { } } - if($rel_table) - { + if($rel_table) { # Constraints are added only if applicable next unless $fk_constraint; @@ -205,36 +218,44 @@ sub parse { 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}; - # do not consider deferrable constraints and self-references - # for dependency calculations + # 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 ) : ()), + 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; + # Check that we do not create an index identical to the PK index + # (some RDBMS croak on this, and it generally doesn't make much sense) + # NOTE: we do not sort the key columns because the order of + # columns is important for indexes and two indexes with the + # same cols but different order are allowed and sometimes + # needed + next if join("\x00", @keys) eq join("\x00", @primary); + if ($add_fk_index_rel) { my $index = $table->add_index( - name => join('_', $table_name, 'idx', @keys), - fields => \@keys, - type => 'NORMAL', - ); + name => join('_', $table_name, 'idx', @keys), + fields => \@keys, + type => 'NORMAL', + ); } } } @@ -246,6 +267,7 @@ sub parse { my $dependencies = { map { $_ => _resolve_deps ($_, \%tables) } (keys %tables) }; + for my $table (sort { keys %{$dependencies->{$a} || {} } <=> keys %{ $dependencies->{$b} || {} } @@ -259,7 +281,7 @@ sub parse { # the hook might have already removed the table if ($schema->get_table($table) && $table =~ /^ \s* \( \s* SELECT \s+/ix) { - warn <<'EOW'; + carp <<'EOW'; Custom SQL through ->name(\'( SELECT ...') is DEPRECATED, for more details see "Arbitrary SQL through a custom ResultSource" in DBIx::Class::Manual::Cookbook @@ -274,9 +296,25 @@ EOW } my %views; - foreach my $moniker (sort @view_monikers) + my @views = map { $dbicschema->source($_) } keys %view_monikers; + + my $view_dependencies = { + map { + $_ => _resolve_deps( $dbicschema->source($_), \%view_monikers ) + } ( keys %view_monikers ) + }; + + my @view_sources = + sort { + keys %{ $view_dependencies->{ $a->source_name } || {} } <=> + keys %{ $view_dependencies->{ $b->source_name } || {} } + || $a->source_name cmp $b->source_name + } + map { $dbicschema->source($_) } + keys %view_monikers; + + foreach my $source (@view_sources) { - my $source = $dbicschema->source($moniker); my $view_name = $source->name; # FIXME - this isn't the right way to do it, but sqlt does not @@ -289,6 +327,9 @@ EOW # 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 ], @@ -310,35 +351,51 @@ EOW # 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 ( $question, $answers, $seen ) = @_; + my $ret = {}; + $seen ||= {}; + my @deps; + + # copy and bump all deps by one (so we can reconstruct the chain) + my %seen = map { $_ => $seen->{$_} + 1 } ( keys %$seen ); + if ( blessed($question) + && $question->isa('DBIx::Class::ResultSource::View') ) + { + $seen{ $question->result_class } = 1; + @deps = keys %{ $question->{deploy_depends_on} }; + } + else { + $seen{$question} = 1; + @deps = keys %{ $answers->{$question}{foreign_table_deps} }; } - my $subdeps = _resolve_deps ($dep, $tables, \%seen); - $ret->{$_} += $subdeps->{$_} for ( keys %$subdeps ); - - ++$ret->{$dep}; - } + for my $dep (@deps) { + if ( $seen->{$dep} ) { + return {}; + } + my $next_dep; - return $ret; + if ( blessed($question) + && $question->isa('DBIx::Class::ResultSource::View') ) + { + no warnings 'uninitialized'; + my ($next_dep_source_name) = + grep { + $question->schema->source($_)->result_class eq $dep + && !( $question->schema->source($_) + ->isa('DBIx::Class::ResultSource::Table') ) + } @{ [ $question->schema->sources ] }; + return {} unless $next_dep_source_name; + $next_dep = $question->schema->source($next_dep_source_name); + } + else { + $next_dep = $dep; + } + my $subdeps = _resolve_deps( $next_dep, $answers, \%seen ); + $ret->{$_} += $subdeps->{$_} for ( keys %$subdeps ); + ++$ret->{$dep}; + } + return $ret; } 1; @@ -364,7 +421,14 @@ from a DBIx::Class::Schema instance my $schema = MyApp::Schema->connect; my $trans = SQL::Translator->new ( parser => 'SQL::Translator::Parser::DBIx::Class', - parser_args => { package => $schema }, + parser_args => { + package => $schema, + add_fk_index => 0, + sources => [qw/ + Artist + CD + /], + }, producer => 'SQLite', ) or die SQL::Translator->error; my $out = $trans->translate() or die $trans->error; @@ -386,14 +450,34 @@ other machines that need to have your application installed but don't have SQL::Translator installed. To do this see L. +=head1 PARSER OPTIONS + +=head2 add_fk_index + +Create an index for each foreign key. +Enabled by default, as having indexed foreign key columns is normally the +sensible thing to do. + +=head2 sources + +=over 4 + +=item Arguments: \@class_names + +=back + +Limit the amount of parsed sources by supplying an explicit list of source names. + =head1 SEE ALSO L, L =head1 AUTHORS -Jess Robinson +See L. + +=head1 LICENSE -Matt S Trout +You may distribute this code under the same terms as Perl itself. -Ash Berlin +=cut