X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FSQL%2FTranslator%2FParser%2FDBIx%2FClass.pm;h=e4e480a3f328a439c4f05620510b0dbee03a5333;hb=fd323bf1046faa7de5a8c985268d80ec5b703361;hp=09665626768aa24dbf4a83c8dd8fb42bb2190ccd;hpb=eb0bc670a8a144695c757cddab22920abaede088;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/SQL/Translator/Parser/DBIx/Class.pm b/lib/SQL/Translator/Parser/DBIx/Class.pm index 0966562..e4e480a 100644 --- a/lib/SQL/Translator/Parser/DBIx/Class.pm +++ b/lib/SQL/Translator/Parser/DBIx/Class.pm @@ -14,7 +14,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 Carp::Clan qw/^SQL::Translator|^DBIx::Class|^Try::Tiny/; +use Scalar::Util (); +use Try::Tiny; +use namespace::clean; use base qw(Exporter); @@ -30,6 +33,10 @@ use base qw(Exporter); # We're working with DBIx::Class Schemas, not data streams. # ------------------------------------------------------------------- sub parse { + # this is a hack to prevent schema leaks due to a retarded SQLT implementation + # DO NOT REMOVE (until SQLT2 is out, the all of this will be rewritten anyway) + Scalar::Util::weaken ($_[1]) if ref ($_[1]); + my ($tr, $data) = @_; my $args = $tr->parser_args; my $dbicschema = $args->{'DBIx::Class::Schema'} || $args->{"DBIx::Schema"} ||$data; @@ -38,8 +45,12 @@ sub parse { croak 'No DBIx::Class::Schema' unless ($dbicschema); if (!ref $dbicschema) { - eval "use $dbicschema;"; - croak "Can't load $dbicschema ($@)" if($@); + try { + eval "require $dbicschema;" + } + catch { + croak "Can't load $dbicschema ($_)"; + } } my $schema = $tr->schema; @@ -54,7 +65,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,27 +76,28 @@ 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; - # Skip custom query sources - next if ref $table_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'; - # Its possible to have multiple DBIC sources using the same table + # It's possible to have multiple DBIC sources using the same table next if $tables{$table_name}; $tables{$table_name}{source} = $source; @@ -111,9 +123,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)) { @@ -130,25 +144,34 @@ 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); - my $rel_table = $othertable->name; + 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 } $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; @@ -179,7 +202,7 @@ sub parse { if ($fk_constraint) { $cascade->{$c} = $rel_info->{attrs}{"on_$c"}; } - else { + 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"; } @@ -189,47 +212,53 @@ sub parse { } } - if($rel_table) - { + 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", @keys); + 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}; - # 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', + ); } } } @@ -251,21 +280,42 @@ sub parse { ) { $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 @view_monikers) + 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 ], @@ -337,11 +387,18 @@ from a DBIx::Class::Schema instance ## 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 }, + 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; @@ -353,7 +410,7 @@ 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. -It's primary use is in deploying database layouts described as a set +Its primary use is in deploying database layouts described as a set of L classes, to a database. To do this, see L. @@ -363,14 +420,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