X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FSQL%2FTranslator%2FParser%2FDBIx%2FClass.pm;h=97e333cf336bf9010bfa3fbdef24b1807c0f98db;hb=6d0ee587eb31c41e28a432de3caf261a66b4c2ca;hp=013805055c16c29a06308999e5341b25c9fe8b28;hpb=d25d7fc27925eb19fe407dcfb41f45d26a8c5236;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/SQL/Translator/Parser/DBIx/Class.pm b/lib/SQL/Translator/Parser/DBIx/Class.pm index 0138050..97e333c 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 @@ -10,11 +9,10 @@ package # hide from PAUSE 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 base qw(Exporter); @@ -24,32 +22,34 @@ 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. # ------------------------------------------------------------------- sub parse { my ($tr, $data) = @_; my $args = $tr->parser_args; - my $dbixschema = $args->{'DBIx::Schema'} || $data; - $dbixschema ||= $args->{'package'}; + my $dbicschema = $args->{'DBIx::Class::Schema'} || $args->{"DBIx::Schema"} ||$data; + $dbicschema ||= $args->{'package'}; my $limit_sources = $args->{'sources'}; - die 'No DBIx::Schema' unless ($dbixschema); - if (!ref $dbixschema) { - eval "use $dbixschema;"; - die "Can't load $dbixschema ($@)" if($@); + die 'No DBIx::Class::Schema' unless ($dbicschema); + if (!ref $dbicschema) { + eval "use $dbicschema;"; + die "Can't load $dbicschema ($@)" if($@); } my $schema = $tr->schema; my $table_no = 0; -# print Dumper($dbixschema->registered_classes); - - #foreach my $tableclass ($dbixschema->registered_classes) + $schema->name( ref($dbicschema) . " v" . ($dbicschema->schema_version || '1.x')) + unless ($schema->name); my %seen_tables; - my @monikers = $dbixschema->sources; + 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'; @@ -65,10 +65,25 @@ sub parse { } - foreach my $moniker (@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); + } elsif( $source->isa('DBIx::Class::ResultSource::View') ){ + next if $source->is_virtual; + push(@view_monikers, $moniker); + } + } + + foreach my $moniker (sort @table_monikers) { - my $source = $dbixschema->source($moniker); + my $source = $dbicschema->source($moniker); + + # Skip custom query sources + next if ref($source->name); + # Its possible to have multiple DBIC source using same table next if $seen_tables{$source->name}++; my $table = $schema->add_table( @@ -96,36 +111,25 @@ sub parse { $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', - ); - } my %unique_constraints = $source->unique_constraints; - foreach my $uniq (keys %unique_constraints) { - if (!$source->compare_relationship_keys($unique_constraints{$uniq}, \@primary)) { + foreach my $uniq (sort keys %unique_constraints) { + 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( - name => $unique_constraints{$uniq}->[0], - fields => $unique_constraints{$uniq}, - type => 'NORMAL', - ); - } } my @rels = $source->relationships(); 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; - foreach my $rel (@rels) + foreach my $rel (sort @rels) { my $rel_info = $source->relationship_info($rel); @@ -135,70 +139,118 @@ sub parse { my $othertable = $source->related_source($rel); my $rel_table = $othertable->name; + 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}}); + # 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"}; + } + else { + warn "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", @keys); + next if $created_FK_rels{$rel_table}->{$key_test}; + + my $is_deferrable = $rel_info->{attrs}{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; - #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 - if ( ! exists $created_FK_rels{$rel_table}->{$key_test} && - ( exists $rel_info->{attrs}{is_foreign_key_constraint} && - $rel_info->{attrs}{is_foreign_key_constraint} || - !$source->compare_relationship_keys(\@keys, \@primary) - ) - ) - { - $created_FK_rels{$rel_table}->{$key_test} = 1; - if (scalar(@keys)) { - $table->add_constraint( + + $created_FK_rels{$rel_table}->{$key_test} = 1; + if (scalar(@keys)) { + $table->add_constraint( type => 'foreign_key', - name => $table->name . "_fk_$keys[0]", + name => join('_', $table->name, 'fk', @keys), fields => \@keys, reference_fields => \@refkeys, reference_table => $rel_table, - on_delete => $on_delete, - on_update => $on_update - ); + on_delete => uc ($cascade->{delete} || ''), + on_update => uc ($cascade->{update} || ''), + (defined $is_deferrable ? ( deferrable => $is_deferrable ) : ()), + ); - my $index = $table->add_index( - name => $keys[0], - fields => \@keys, - type => 'NORMAL', - ); - } - - } + if ($add_fk_index_rel) { + my $index = $table->add_index( + name => join('_', $table->name, 'idx', @keys), + fields => \@keys, + type => 'NORMAL', + ); + } + } } } + + $source->_invoke_sqlt_deploy_hook($table); + } + + foreach my $moniker (sort @view_monikers) + { + my $source = $dbicschema->source($moniker); + # Skip custom query sources + next if ref($source->name); + + # Its possible to have multiple DBIC source using same table + next if $seen_tables{$source->name}++; + my $view = $schema->add_view( + name => $source->name, + fields => [ $source->columns ], + $source->view_definition ? ( 'sql' => $source->view_definition ) : () + ); if ($source->result_class->can('sqlt_deploy_hook')) { - $source->result_class->sqlt_deploy_hook($table); + $source->result_class->sqlt_deploy_hook($view); } + + $source->_invoke_sqlt_deploy_hook($view); } - if ($dbixschema->can('sqlt_deploy_hook')) { - $dbixschema->sqlt_deploy_hook($schema); + if ($dbicschema->can('sqlt_deploy_hook')) { + $dbicschema->sqlt_deploy_hook($schema); } return 1; @@ -206,3 +258,57 @@ sub parse { 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. + +It's 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