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=94b241e325389198a5e71589c5757467dbc97b7a;hpb=45f1a484fec2dc2cae461c37af1a597d580ed8e8;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/SQL/Translator/Parser/DBIx/Class.pm b/lib/SQL/Translator/Parser/DBIx/Class.pm index 94b241e..dc13790 100644 --- a/lib/SQL/Translator/Parser/DBIx/Class.pm +++ b/lib/SQL/Translator/Parser/DBIx/Class.pm @@ -1,5 +1,4 @@ -package # hide from PAUSE - SQL::Translator::Parser::DBIx::Class; +package SQL::Translator::Parser::DBIx::Class; # AUTHOR: Jess Robinson @@ -9,12 +8,17 @@ package # hide from PAUSE use strict; use warnings; -use vars qw($DEBUG @EXPORT_OK); +our ($DEBUG, $VERSION, @EXPORT_OK); +$VERSION = '1.10'; $DEBUG = 0 unless defined $DEBUG; use Exporter; -use Data::Dumper; use SQL::Translator::Utils qw(debug normalize_name); +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); @@ -23,6 +27,9 @@ use base qw(Exporter); # ------------------------------------------------------------------- # parse($tr, $data) # +# 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. # ------------------------------------------------------------------- @@ -32,27 +39,26 @@ sub parse { my $dbicschema = $args->{'DBIx::Class::Schema'} || $args->{"DBIx::Schema"} ||$data; $dbicschema ||= $args->{'package'}; my $limit_sources = $args->{'sources'}; - - die 'No DBIx::Class::Schema' unless ($dbicschema); + + DBIx::Class::Exception->throw('No DBIx::Class::Schema') unless ($dbicschema); if (!ref $dbicschema) { - eval "use $dbicschema;"; - die "Can't load $dbicschema ($@)" if($@); + eval "require $dbicschema" + or DBIx::Class::Exception->throw("Can't load $dbicschema: $@"); } my $schema = $tr->schema; my $table_no = 0; - $schema->name( ref($dbicschema) . " v" . ($dbicschema->VERSION || '1.x')) + $schema->name( ref($dbicschema) . " v" . ($dbicschema->schema_version || '1.x')) unless ($schema->name); - my %seen_tables; - my @monikers = sort $dbicschema->sources; if ($limit_sources) { my $ref = ref $limit_sources || ''; - die "'sources' parameter must be an array or hash ref" unless $ref eq 'ARRAY' || ref eq 'HASH'; + $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); @@ -63,18 +69,35 @@ sub parse { } - foreach my $moniker (sort @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}++; + } + } + + my %tables; + foreach my $moniker (sort keys %table_monikers) { my $source = $dbicschema->source($moniker); + my $table_name = $source->name; - # Its possible to have multiple DBIC source using same table - next if $seen_tables{$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'; - my $table = $schema->add_table( - name => $source->name, + # It's possible to have multiple DBIC sources using the same table + next if $tables{$table_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 dbic is the same as DBI (?) @@ -90,34 +113,22 @@ 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; - foreach my $field (@primary) { - my $index = $table->add_index( - name => $field, - fields => [$field], - type => 'NORMAL', - ); - } + + $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)) { + if (!$source->_compare_relationship_keys($unique_constraints{$uniq}, \@primary)) { $table->add_constraint( type => 'unique', - name => "$uniq", + name => $uniq, fields => $unique_constraints{$uniq} ); - - my $index = $table->add_index( - # TODO: Pick a better than that wont conflict - name => $unique_constraints{$uniq}->[0], - fields => $unique_constraints{$uniq}, - type => 'NORMAL', - ); - } } @@ -125,83 +136,210 @@ 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 : 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 = 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 + $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 @cond = keys(%{$rel_info->{cond}}); my @refkeys = map {/^\w+\.(\w+)$/} @cond; my @keys = map {$rel_info->{cond}->{$_} =~ /^\w+\.(\w+)$/} @cond; - if($rel_table) - { - my $reverse_rels = $source->reverse_relationship_info($rel); - my ($otherrelname, $otherrelationship) = each %{$reverse_rels}; + # determine if this relationship is a self.fk => foreign.pk (i.e. belongs_to) + my $fk_constraint; - my $on_delete = ''; - my $on_update = ''; + #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); + } - if (defined $otherrelationship) { - $on_delete = $otherrelationship->{'attrs'}->{cascade_delete} ? 'CASCADE' : ''; - $on_update = $otherrelationship->{'attrs'}->{cascade_copy} ? 'CASCADE' : ''; + 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'; } + } - my $is_deferrable = $rel_info->{attrs}{is_deferrable}; + 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); - - #Decide if this is a foreign key based on whether the self - #items are our primary columns. - - # If the sets are different, then we assume it's a foreign key from - # us to another table. - # OR: If is_foreign_key_constraint attr is explicity set (or set to false) on the relation - next if ( exists $created_FK_rels{$rel_table}->{$key_test} ); - if ( exists $rel_info->{attrs}{is_foreign_key_constraint}) { - # not is this attr set to 0 but definitely if set to 1 - next unless ($rel_info->{attrs}{is_foreign_key_constraint}); - } else { - # not if might have - # next if ($rel_info->{attrs}{accessor} eq 'single' && exists $rel_info->{attrs}{join_type} && uc($rel_info->{attrs}{join_type}) eq 'LEFT'); - # not sure about this one - next if $source->compare_relationship_keys(\@keys, \@primary); - } + my $key_test = join("\x00", sort @keys); + next if $created_FK_rels{$rel_table}->{$key_test}; - $created_FK_rels{$rel_table}->{$key_test} = 1; 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 => $table->name . "_fk_$keys[0]", - fields => \@keys, - reference_fields => \@refkeys, - reference_table => $rel_table, - on_delete => $on_delete, - on_update => $on_update, - defined $is_deferrable ? ( deferrable => $is_deferrable ) : (), - ); - - my $index = $table->add_index( - name => join('_', @keys), - fields => \@keys, - type => 'NORMAL', + 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', + ); + } + } } } - if ($source->result_class->can('sqlt_deploy_hook')) { - $source->result_class->sqlt_deploy_hook($table); - } } + # 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) { + carp <<'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; + 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 $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); } @@ -209,5 +347,137 @@ sub parse { return 1; } +# +# Quick and dirty dependency graph calculator +# +sub _resolve_deps { + 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} }; + } + + for my $dep (@deps) { + if ( $seen->{$dep} ) { + return {}; + } + my $next_dep; + + 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; +=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, + add_fk_index => 0, + sources => [qw/ + Artist + CD + /], + }, + 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 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 + +See L. + +=head1 LICENSE + +You may distribute this code under the same terms as Perl itself. + +=cut