1 package SQL::Translator::Parser::DBIx::Class;
3 # AUTHOR: Jess Robinson
5 # Some mistakes the fault of Matt S Trout
7 # Others the fault of Ash Berlin
11 use vars qw($DEBUG @EXPORT_OK);
12 $DEBUG = 0 unless defined $DEBUG;
16 use SQL::Translator::Utils qw(debug normalize_name);
18 use base qw(Exporter);
20 @EXPORT_OK = qw(parse);
22 # -------------------------------------------------------------------
25 # setting parser_args => { add_fk_index => 0 } will prevent
26 # the auto-generation of an index for each FK.
28 # Note that $data, in the case of this parser, is not useful.
29 # We're working with DBIx::Class Schemas, not data streams.
30 # -------------------------------------------------------------------
33 my $args = $tr->parser_args;
34 my $dbicschema = $args->{'DBIx::Class::Schema'} || $args->{"DBIx::Schema"} ||$data;
35 $dbicschema ||= $args->{'package'};
36 my $limit_sources = $args->{'sources'};
38 die 'No DBIx::Class::Schema' unless ($dbicschema);
39 if (!ref $dbicschema) {
40 eval "use $dbicschema;";
41 die "Can't load $dbicschema ($@)" if($@);
44 my $schema = $tr->schema;
47 $schema->name( ref($dbicschema) . " v" . ($dbicschema->schema_version || '1.x'))
48 unless ($schema->name);
52 my @monikers = sort $dbicschema->sources;
54 my $ref = ref $limit_sources || '';
55 die "'sources' parameter must be an array or hash ref" unless $ref eq 'ARRAY' || ref eq 'HASH';
57 # limit monikers to those specified in
59 if ($ref eq 'ARRAY') {
60 $sources->{$_} = 1 for (@$limit_sources);
62 $sources = $limit_sources;
64 @monikers = grep { $sources->{$_} } @monikers;
68 foreach my $moniker (sort @monikers)
70 my $source = $dbicschema->source($moniker);
72 # Skip custom query sources
73 next if ref($source->name);
75 # Its possible to have multiple DBIC source using same table
76 next if $seen_tables{$source->name}++;
78 my $table = $schema->add_table(
79 name => $source->name,
81 ) || die $schema->error;
83 foreach my $col ($source->columns)
85 # assuming column_info in dbic is the same as DBI (?)
86 # data_type is a number, column_type is text?
90 is_auto_increment => 0,
93 %{$source->column_info($col)}
95 if ($colinfo{is_nullable}) {
96 $colinfo{default} = '' unless exists $colinfo{default};
98 my $f = $table->add_field(%colinfo) || die $table->error;
100 $table->primary_key($source->primary_columns);
102 my @primary = $source->primary_columns;
103 my %unique_constraints = $source->unique_constraints;
104 foreach my $uniq (sort keys %unique_constraints) {
105 if (!$source->compare_relationship_keys($unique_constraints{$uniq}, \@primary)) {
106 $table->add_constraint(
109 fields => $unique_constraints{$uniq}
114 my @rels = $source->relationships();
118 # global add_fk_index set in parser_args
119 my $add_fk_index = (exists $args->{add_fk_index} && ($args->{add_fk_index} == 0)) ? 0 : 1;
121 foreach my $rel (sort @rels)
123 my $rel_info = $source->relationship_info($rel);
125 # Ignore any rel cond that isn't a straight hash
126 next unless ref $rel_info->{cond} eq 'HASH';
128 my $othertable = $source->related_source($rel);
129 my $rel_table = $othertable->name;
131 my $reverse_rels = $source->reverse_relationship_info($rel);
132 my ($otherrelname, $otherrelationship) = each %{$reverse_rels};
134 # Force the order of @cond to match the order of ->add_columns
136 my %other_columns_idx = map {'foreign.'.$_ => ++$idx } $othertable->columns;
137 my @cond = sort { $other_columns_idx{$a} cmp $other_columns_idx{$b} } keys(%{$rel_info->{cond}});
139 # Get the key information, mapping off the foreign/self markers
140 my @refkeys = map {/^\w+\.(\w+)$/} @cond;
141 my @keys = map {$rel_info->{cond}->{$_} =~ /^\w+\.(\w+)$/} @cond;
143 # determine if this relationship is a self.fk => foreign.pk (i.e. belongs_to)
146 #first it can be specified explicitly
147 if ( exists $rel_info->{attrs}{is_foreign_key_constraint} ) {
148 $fk_constraint = $rel_info->{attrs}{is_foreign_key_constraint};
150 # it can not be multi
151 elsif ( $rel_info->{attrs}{accessor}
152 && $rel_info->{attrs}{accessor} eq 'multi' ) {
155 # if indeed single, check if all self.columns are our primary keys.
156 # this is supposed to indicate a has_one/might_have...
157 # where's the introspection!!?? :)
159 $fk_constraint = not $source->compare_relationship_keys(\@keys, \@primary);
163 for my $c (qw/delete update/) {
164 if (exists $rel_info->{attrs}{"on_$c"}) {
165 if ($fk_constraint) {
166 $cascade->{$c} = $rel_info->{attrs}{"on_$c"};
169 warn "SQLT attribute 'on_$c' was supplied for relationship '$moniker/$rel', which does not appear to be a foreign constraint. "
170 . "If you are sure that SQLT must generate a constraint for this relationship, add 'is_foreign_key_constraint => 1' to the attributes.\n";
173 elsif (defined $otherrelationship and $otherrelationship->{attrs}{$c eq 'update' ? 'cascade_copy' : 'cascade_delete'}) {
174 $cascade->{$c} = 'CASCADE';
180 # Constraints are added only if applicable
181 next unless $fk_constraint;
183 # Make sure we dont create the same foreign key constraint twice
184 my $key_test = join("\x00", @keys);
185 next if $created_FK_rels{$rel_table}->{$key_test};
187 my $is_deferrable = $rel_info->{attrs}{is_deferrable};
189 # global parser_args add_fk_index param can be overridden on the rel def
190 my $add_fk_index_rel = (exists $rel_info->{attrs}{add_fk_index}) ? $rel_info->{attrs}{add_fk_index} : $add_fk_index;
193 $created_FK_rels{$rel_table}->{$key_test} = 1;
195 $table->add_constraint(
196 type => 'foreign_key',
197 name => join('_', $table->name, 'fk', @keys),
199 reference_fields => \@refkeys,
200 reference_table => $rel_table,
201 on_delete => uc ($cascade->{delete} || ''),
202 on_update => uc ($cascade->{update} || ''),
203 (defined $is_deferrable ? ( deferrable => $is_deferrable ) : ()),
206 if ($add_fk_index_rel) {
207 my $index = $table->add_index(
208 name => join('_', $table->name, 'idx', @keys),
217 $source->sqlt_deploy_hook($table)
220 if ($dbicschema->can('sqlt_deploy_hook')) {
221 $dbicschema->sqlt_deploy_hook($schema);
231 SQL::Translator::Parser::DBIx::Class - Create a SQL::Translator schema
232 from a DBIx::Class::Schema instance
239 my $schema = MyApp::Schema->connect;
240 my $trans = SQL::Translator->new (
241 parser => 'SQL::Translator::Parser::DBIx::Class',
242 parser_args => { package => $schema },
243 producer => 'SQLite',
244 ) or die SQL::Translator->error;
245 my $out = $trans->translate() or die $trans->error;
249 C<SQL::Translator::Parser::DBIx::Class> reads a DBIx::Class schema,
250 interrogates the columns, and stuffs it all in an $sqlt_schema object.