1 package # hide from PAUSE
2 SQL::Translator::Parser::DBIx::Class;
4 # AUTHOR: Jess Robinson
6 # Some mistakes the fault of Matt S Trout
8 # Others the fault of Ash Berlin
12 use vars qw($DEBUG @EXPORT_OK);
13 $DEBUG = 0 unless defined $DEBUG;
17 use SQL::Translator::Utils qw(debug normalize_name);
19 use base qw(Exporter);
21 @EXPORT_OK = qw(parse);
23 # -------------------------------------------------------------------
26 # setting parser_args => { add_fk_index => 0 } will prevent
27 # the auto-generation of an index for each FK.
29 # Note that $data, in the case of this parser, is not useful.
30 # We're working with DBIx::Class Schemas, not data streams.
31 # -------------------------------------------------------------------
34 my $args = $tr->parser_args;
35 my $dbicschema = $args->{'DBIx::Class::Schema'} || $args->{"DBIx::Schema"} ||$data;
36 $dbicschema ||= $args->{'package'};
37 my $limit_sources = $args->{'sources'};
39 die 'No DBIx::Class::Schema' unless ($dbicschema);
40 if (!ref $dbicschema) {
41 eval "use $dbicschema;";
42 die "Can't load $dbicschema ($@)" if($@);
45 my $schema = $tr->schema;
48 $schema->name( ref($dbicschema) . " v" . ($dbicschema->VERSION || '1.x'))
49 unless ($schema->name);
53 my @monikers = sort $dbicschema->sources;
55 my $ref = ref $limit_sources || '';
56 die "'sources' parameter must be an array or hash ref" unless $ref eq 'ARRAY' || ref eq 'HASH';
58 # limit monikers to those specified in
60 if ($ref eq 'ARRAY') {
61 $sources->{$_} = 1 for (@$limit_sources);
63 $sources = $limit_sources;
65 @monikers = grep { $sources->{$_} } @monikers;
68 my(@table_monikers, @view_monikers);
69 for my $moniker (@monikers){
70 my $source = $dbicschema->source($moniker);
71 next if $source->is_virtual;
72 if ( $source->isa('DBIx::Class::ResultSource::Table') ||
73 $source->isa('DBIx::Class::ResultSourceProxy::Table') ) {
74 push(@table_monikers, $moniker);
75 } elsif( $source->isa('DBIx::Class::ResultSource::View') ||
76 $source->isa('DBIx::Class::ResultSourceProxy::View') ){
77 push(@view_monikers, $moniker);
81 foreach my $moniker (sort @table_monikers)
83 my $source = $dbicschema->source($moniker);
85 # Skip custom query sources
86 next if ref($source->name);
88 # Its possible to have multiple DBIC source using same table
89 next if $seen_tables{$source->name}++;
91 my $table = $schema->add_table(
92 name => $source->name,
94 ) || die $schema->error;
96 foreach my $col ($source->columns)
98 # assuming column_info in dbic is the same as DBI (?)
99 # data_type is a number, column_type is text?
103 is_auto_increment => 0,
106 %{$source->column_info($col)}
108 if ($colinfo{is_nullable}) {
109 $colinfo{default} = '' unless exists $colinfo{default};
111 my $f = $table->add_field(%colinfo) || die $table->error;
113 $table->primary_key($source->primary_columns);
115 my @primary = $source->primary_columns;
116 my %unique_constraints = $source->unique_constraints;
117 foreach my $uniq (sort keys %unique_constraints) {
118 if (!$source->compare_relationship_keys($unique_constraints{$uniq}, \@primary)) {
119 $table->add_constraint(
122 fields => $unique_constraints{$uniq}
127 my @rels = $source->relationships();
131 # global add_fk_index set in parser_args
132 my $add_fk_index = (exists $args->{add_fk_index} && ($args->{add_fk_index} == 0)) ? 0 : 1;
134 foreach my $rel (sort @rels)
136 my $rel_info = $source->relationship_info($rel);
138 # Ignore any rel cond that isn't a straight hash
139 next unless ref $rel_info->{cond} eq 'HASH';
141 my $othertable = $source->related_source($rel);
142 my $rel_table = $othertable->name;
144 my $reverse_rels = $source->reverse_relationship_info($rel);
145 my ($otherrelname, $otherrelationship) = each %{$reverse_rels};
147 # Force the order of @cond to match the order of ->add_columns
149 my %other_columns_idx = map {'foreign.'.$_ => ++$idx } $othertable->columns;
150 my @cond = sort { $other_columns_idx{$a} cmp $other_columns_idx{$b} } keys(%{$rel_info->{cond}});
152 # Get the key information, mapping off the foreign/self markers
153 my @refkeys = map {/^\w+\.(\w+)$/} @cond;
154 my @keys = map {$rel_info->{cond}->{$_} =~ /^\w+\.(\w+)$/} @cond;
156 # determine if this relationship is a self.fk => foreign.pk (i.e. belongs_to)
159 #first it can be specified explicitly
160 if ( exists $rel_info->{attrs}{is_foreign_key_constraint} ) {
161 $fk_constraint = $rel_info->{attrs}{is_foreign_key_constraint};
163 # it can not be multi
164 elsif ( $rel_info->{attrs}{accessor} eq 'multi' ) {
167 # if indeed single, check if all self.columns are our primary keys.
168 # this is supposed to indicate a has_one/might_have...
169 # where's the introspection!!?? :)
171 $fk_constraint = not $source->compare_relationship_keys(\@keys, \@primary);
175 for my $c (qw/delete update/) {
176 if (exists $rel_info->{attrs}{"on_$c"}) {
177 if ($fk_constraint) {
178 $cascade->{$c} = $rel_info->{attrs}{"on_$c"};
181 warn "SQLT attribute 'on_$c' was supplied for relationship '$moniker/$rel', which does not appear to be a foreign constraint. "
182 . "If you are sure that SQLT must generate a constraint for this relationship, add 'is_foreign_key_constraint => 1' to the attributes.\n";
185 elsif (defined $otherrelationship and $otherrelationship->{attrs}{$c eq 'update' ? 'cascade_copy' : 'cascade_delete'}) {
186 $cascade->{$c} = 'CASCADE';
192 # Constraints are added only if applicable
193 next unless $fk_constraint;
195 # Make sure we dont create the same foreign key constraint twice
196 my $key_test = join("\x00", @keys);
197 next if $created_FK_rels{$rel_table}->{$key_test};
199 my $is_deferrable = $rel_info->{attrs}{is_deferrable};
201 # global parser_args add_fk_index param can be overridden on the rel def
202 my $add_fk_index_rel = (exists $rel_info->{attrs}{add_fk_index}) ? $rel_info->{attrs}{add_fk_index} : $add_fk_index;
205 $created_FK_rels{$rel_table}->{$key_test} = 1;
207 $table->add_constraint(
208 type => 'foreign_key',
209 name => join('_', $table->name, 'fk', @keys),
211 reference_fields => \@refkeys,
212 reference_table => $rel_table,
213 on_delete => $cascade->{delete},
214 on_update => $cascade->{update},
215 (defined $is_deferrable ? ( deferrable => $is_deferrable ) : ()),
218 if ($add_fk_index_rel) {
219 my $index = $table->add_index(
220 name => join('_', $table->name, 'idx', @keys),
229 if ($source->result_class->can('sqlt_deploy_hook')) {
230 $source->result_class->sqlt_deploy_hook($table);
234 foreach my $moniker (sort @view_monikers)
236 my $source = $dbicschema->source($moniker);
237 # Skip custom query sources
238 next if ref($source->name);
240 # Its possible to have multiple DBIC source using same table
241 next if $seen_tables{$source->name}++;
243 my $view = $schema->add_view(
244 name => $source->name,
245 fields => [ $source->columns ],
246 ($source->view_definition ? $source->view_definition : ())
248 if ($source->result_class->can('sqlt_deploy_hook')) {
249 $source->result_class->sqlt_deploy_hook($view);
254 if ($dbicschema->can('sqlt_deploy_hook')) {
255 $dbicschema->sqlt_deploy_hook($schema);