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 our ($DEBUG, $VERSION, @EXPORT_OK);
13 $DEBUG = 0 unless defined $DEBUG;
16 use SQL::Translator::Utils qw(debug normalize_name);
17 use DBIx::Class::Carp qw/^SQL::Translator|^DBIx::Class|^Try::Tiny/;
18 use DBIx::Class::Exception;
19 use Scalar::Util 'blessed';
23 use base qw(Exporter);
25 @EXPORT_OK = qw(parse);
27 # -------------------------------------------------------------------
30 # setting parser_args => { add_fk_index => 0 } will prevent
31 # the auto-generation of an index for each FK.
33 # Note that $data, in the case of this parser, is not useful.
34 # We're working with DBIx::Class Schemas, not data streams.
35 # -------------------------------------------------------------------
38 my $args = $tr->parser_args;
40 my $dbicschema = $data || $args->{dbic_schema};
42 for (qw(DBIx::Class::Schema DBIx::Schema package)) {
43 if (defined (my $s = delete $args->{$_} )) {
44 carp_unique("Supplying a schema via ... parser_args => { '$_' => \$schema } is deprecated. Please use parser_args => { dbic_schema => \$schema } instead");
46 # move it from the deprecated to the proper $args slot
47 unless ($dbicschema) {
48 $args->{dbic_schema} = $dbicschema = $s;
53 DBIx::Class::Exception->throw('No DBIx::Class::Schema') unless ($dbicschema);
55 if (!ref $dbicschema) {
56 eval "require $dbicschema"
57 or DBIx::Class::Exception->throw("Can't load $dbicschema: $@");
61 ref $args->{dbic_schema}
63 $args->{dbic_schema}->storage
65 # we have a storage-holding $schema instance in $args
66 # we need to dissociate it from that $storage
67 # otherwise SQLT insanity may ensue due to how some
68 # serializing producers treat $args (crazy crazy shit)
69 local $args->{dbic_schema}{storage};
70 $args->{dbic_schema} = $args->{dbic_schema}->clone;
73 my $schema = $tr->schema;
76 $schema->name( ref($dbicschema) . " v" . ($dbicschema->schema_version || '1.x'))
77 unless ($schema->name);
79 my @monikers = sort $dbicschema->sources;
80 if (my $limit_sources = $args->{'sources'}) {
81 my $ref = ref $limit_sources || '';
82 $dbicschema->throw_exception ("'sources' parameter must be an array or hash ref")
83 unless( $ref eq 'ARRAY' || ref eq 'HASH' );
85 # limit monikers to those specified in
87 if ($ref eq 'ARRAY') {
88 $sources->{$_} = 1 for (@$limit_sources);
90 $sources = $limit_sources;
92 @monikers = grep { $sources->{$_} } @monikers;
96 my(%table_monikers, %view_monikers);
97 for my $moniker (@monikers){
98 my $source = $dbicschema->source($moniker);
99 if ( $source->isa('DBIx::Class::ResultSource::Table') ) {
100 $table_monikers{$moniker}++;
101 } elsif( $source->isa('DBIx::Class::ResultSource::View') ){
102 next if $source->is_virtual;
103 $view_monikers{$moniker}++;
108 foreach my $moniker (sort keys %table_monikers)
110 my $source = $dbicschema->source($moniker);
111 my $table_name = $source->name;
113 # FIXME - this isn't the right way to do it, but sqlt does not
114 # support quoting properly to be signaled about this
115 $table_name = $$table_name if ref $table_name eq 'SCALAR';
117 # It's possible to have multiple DBIC sources using the same table
118 next if $tables{$table_name};
120 $tables{$table_name}{source} = $source;
121 my $table = $tables{$table_name}{object} = SQL::Translator::Schema::Table->new(
125 foreach my $col ($source->columns)
127 # assuming column_info in dbic is the same as DBI (?)
128 # data_type is a number, column_type is text?
132 is_auto_increment => 0,
135 %{$source->column_info($col)}
137 if ($colinfo{is_nullable}) {
138 $colinfo{default} = '' unless exists $colinfo{default};
140 my $f = $table->add_field(%colinfo)
141 || $dbicschema->throw_exception ($table->error);
144 my @primary = $source->primary_columns;
146 $table->primary_key(@primary) if @primary;
148 my %unique_constraints = $source->unique_constraints;
149 foreach my $uniq (sort keys %unique_constraints) {
150 if (!$source->_compare_relationship_keys($unique_constraints{$uniq}, \@primary)) {
151 $table->add_constraint(
154 fields => $unique_constraints{$uniq}
159 my @rels = $source->relationships();
163 # global add_fk_index set in parser_args
164 my $add_fk_index = (exists $args->{add_fk_index} && ! $args->{add_fk_index}) ? 0 : 1;
166 foreach my $rel (sort @rels)
169 my $rel_info = $source->relationship_info($rel);
171 # Ignore any rel cond that isn't a straight hash
172 next unless ref $rel_info->{cond} eq 'HASH';
174 my $relsource = try { $source->related_source($rel) };
175 unless ($relsource) {
176 carp "Ignoring relationship '$rel' - related resultsource '$rel_info->{class}' is not registered with this schema\n";
180 # related sources might be excluded via a {sources} filter or might be views
181 next unless exists $table_monikers{$relsource->source_name};
183 my $rel_table = $relsource->name;
185 # FIXME - this isn't the right way to do it, but sqlt does not
186 # support quoting properly to be signaled about this
187 $rel_table = $$rel_table if ref $rel_table eq 'SCALAR';
189 my $reverse_rels = $source->reverse_relationship_info($rel);
190 my ($otherrelname, $otherrelationship) = each %{$reverse_rels};
192 # Force the order of @cond to match the order of ->add_columns
194 my %other_columns_idx = map {'foreign.'.$_ => ++$idx } $relsource->columns;
195 my @cond = sort { $other_columns_idx{$a} cmp $other_columns_idx{$b} } keys(%{$rel_info->{cond}});
197 # Get the key information, mapping off the foreign/self markers
198 my @refkeys = map {/^\w+\.(\w+)$/} @cond;
199 my @keys = map {$rel_info->{cond}->{$_} =~ /^\w+\.(\w+)$/} @cond;
201 # determine if this relationship is a self.fk => foreign.pk (i.e. belongs_to)
204 #first it can be specified explicitly
205 if ( exists $rel_info->{attrs}{is_foreign_key_constraint} ) {
206 $fk_constraint = $rel_info->{attrs}{is_foreign_key_constraint};
208 # it can not be multi
209 elsif ( $rel_info->{attrs}{accessor}
210 && $rel_info->{attrs}{accessor} eq 'multi' ) {
213 # if indeed single, check if all self.columns are our primary keys.
214 # this is supposed to indicate a has_one/might_have...
215 # where's the introspection!!?? :)
217 $fk_constraint = not $source->_compare_relationship_keys(\@keys, \@primary);
221 for my $c (qw/delete update/) {
222 if (exists $rel_info->{attrs}{"on_$c"}) {
223 if ($fk_constraint) {
224 $cascade->{$c} = $rel_info->{attrs}{"on_$c"};
226 elsif ( $rel_info->{attrs}{"on_$c"} ) {
227 carp "SQLT attribute 'on_$c' was supplied for relationship '$moniker/$rel', which does not appear to be a foreign constraint. "
228 . "If you are sure that SQLT must generate a constraint for this relationship, add 'is_foreign_key_constraint => 1' to the attributes.\n";
231 elsif (defined $otherrelationship and $otherrelationship->{attrs}{$c eq 'update' ? 'cascade_copy' : 'cascade_delete'}) {
232 $cascade->{$c} = 'CASCADE';
237 # Constraints are added only if applicable
238 next unless $fk_constraint;
240 # Make sure we don't create the same foreign key constraint twice
241 my $key_test = join("\x00", sort @keys);
242 next if $created_FK_rels{$rel_table}->{$key_test};
245 $created_FK_rels{$rel_table}->{$key_test} = 1;
247 my $is_deferrable = $rel_info->{attrs}{is_deferrable};
249 # calculate dependencies: do not consider deferrable constraints and
250 # self-references for dependency calculations
251 if (! $is_deferrable and $rel_table ne $table_name) {
252 $tables{$table_name}{foreign_table_deps}{$rel_table}++;
255 # trim schema before generating constraint/index names
256 (my $table_abbrev = $table_name) =~ s/ ^ [^\.]+ \. //x;
258 $table->add_constraint(
259 type => 'foreign_key',
260 name => join('_', $table_abbrev, 'fk', @keys),
262 reference_fields => \@refkeys,
263 reference_table => $rel_table,
264 on_delete => uc ($cascade->{delete} || ''),
265 on_update => uc ($cascade->{update} || ''),
266 (defined $is_deferrable ? ( deferrable => $is_deferrable ) : ()),
269 # global parser_args add_fk_index param can be overridden on the rel def
270 my $add_fk_index_rel = (exists $rel_info->{attrs}{add_fk_index}) ? $rel_info->{attrs}{add_fk_index} : $add_fk_index;
272 # Check that we do not create an index identical to the PK index
273 # (some RDBMS croak on this, and it generally doesn't make much sense)
274 # NOTE: we do not sort the key columns because the order of
275 # columns is important for indexes and two indexes with the
276 # same cols but different order are allowed and sometimes
278 next if join("\x00", @keys) eq join("\x00", @primary);
280 if ($add_fk_index_rel) {
281 (my $idx_name = $table_name) =~ s/ ^ [^\.]+ \. //x;
282 my $index = $table->add_index(
283 name => join('_', $table_abbrev, 'idx', @keys),
294 # attach the tables to the schema in dependency order
296 map { $_ => _resolve_deps ($_, \%tables) } (keys %tables)
301 keys %{$dependencies->{$a} || {} } <=> keys %{ $dependencies->{$b} || {} }
307 $schema->add_table ($tables{$table}{object});
308 $tables{$table}{source} -> _invoke_sqlt_deploy_hook( $tables{$table}{object} );
310 # the hook might have already removed the table
311 if ($schema->get_table($table) && $table =~ /^ \s* \( \s* SELECT \s+/ix) {
314 Custom SQL through ->name(\'( SELECT ...') is DEPRECATED, for more details see
315 "Arbitrary SQL through a custom ResultSource" in DBIx::Class::Manual::Cookbook
316 or http://search.cpan.org/dist/DBIx-Class/lib/DBIx/Class/Manual/Cookbook.pod
320 # remove the table as there is no way someone might want to
321 # actually deploy this
322 $schema->drop_table ($table);
327 my @views = map { $dbicschema->source($_) } keys %view_monikers;
329 my $view_dependencies = {
331 $_ => _resolve_deps( $dbicschema->source($_), \%view_monikers )
332 } ( keys %view_monikers )
337 keys %{ $view_dependencies->{ $a->source_name } || {} } <=>
338 keys %{ $view_dependencies->{ $b->source_name } || {} }
339 || $a->source_name cmp $b->source_name
341 map { $dbicschema->source($_) }
344 foreach my $source (@view_sources)
346 my $view_name = $source->name;
348 # FIXME - this isn't the right way to do it, but sqlt does not
349 # support quoting properly to be signaled about this
350 $view_name = $$view_name if ref $view_name eq 'SCALAR';
352 # Skip custom query sources
353 next if ref $view_name;
355 # Its possible to have multiple DBIC source using same table
356 next if $views{$view_name}++;
358 $dbicschema->throw_exception ("view $view_name is missing a view_definition")
359 unless $source->view_definition;
361 my $view = $schema->add_view (
363 fields => [ $source->columns ],
364 $source->view_definition ? ( 'sql' => $source->view_definition ) : ()
365 ) || $dbicschema->throw_exception ($schema->error);
367 $source->_invoke_sqlt_deploy_hook($view);
371 if ($dbicschema->can('sqlt_deploy_hook')) {
372 $dbicschema->sqlt_deploy_hook($schema);
379 # Quick and dirty dependency graph calculator
382 my ( $question, $answers, $seen ) = @_;
387 # copy and bump all deps by one (so we can reconstruct the chain)
388 my %seen = map { $_ => $seen->{$_} + 1 } ( keys %$seen );
389 if ( blessed($question)
390 && $question->isa('DBIx::Class::ResultSource::View') )
392 $seen{ $question->result_class } = 1;
393 @deps = keys %{ $question->{deploy_depends_on} };
396 $seen{$question} = 1;
397 @deps = keys %{ $answers->{$question}{foreign_table_deps} };
400 for my $dep (@deps) {
401 if ( $seen->{$dep} ) {
406 if ( blessed($question)
407 && $question->isa('DBIx::Class::ResultSource::View') )
409 no warnings 'uninitialized';
410 my ($next_dep_source_name) =
412 $question->schema->source($_)->result_class eq $dep
413 && !( $question->schema->source($_)
414 ->isa('DBIx::Class::ResultSource::Table') )
415 } @{ [ $question->schema->sources ] };
416 return {} unless $next_dep_source_name;
417 $next_dep = $question->schema->source($next_dep_source_name);
422 my $subdeps = _resolve_deps( $next_dep, $answers, \%seen );
423 $ret->{$_} += $subdeps->{$_} for ( keys %$subdeps );
433 SQL::Translator::Parser::DBIx::Class - Create a SQL::Translator schema
434 from a DBIx::Class::Schema instance
440 my $schema = MyApp::Schema->connect("dbi:SQLite:something.db");
441 $schema->create_ddl_dir();
449 my $schema = MyApp::Schema->connect;
450 my $trans = SQL::Translator->new (
451 parser => 'SQL::Translator::Parser::DBIx::Class',
453 dbic_schema => $schema,
460 producer => 'SQLite',
461 ) or die SQL::Translator->error;
462 my $out = $trans->translate() or die $trans->error;
466 This class requires L<SQL::Translator> installed to work.
468 C<SQL::Translator::Parser::DBIx::Class> reads a DBIx::Class schema,
469 interrogates the columns, and stuffs it all in an $sqlt_schema object.
471 Its primary use is in deploying database layouts described as a set
472 of L<DBIx::Class> classes, to a database. To do this, see
473 L<DBIx::Class::Schema/deploy>.
475 This can also be achieved by having DBIx::Class export the schema as a
476 set of SQL files ready for import into your database, or passed to
477 other machines that need to have your application installed but don't
478 have SQL::Translator installed. To do this see
479 L<DBIx::Class::Schema/create_ddl_dir>.
481 =head1 PARSER OPTIONS
485 The DBIx::Class schema (either an instance or a class name) to be parsed.
486 This argument is in fact optional - instead one can supply it later at
487 translation time as an argument to L<SQL::Translator/translate>. In
488 other words both of the following invocations are valid and will produce
489 conceptually identical output:
491 my $yaml = SQL::Translator->new(
492 parser => 'SQL::Translator::Parser::DBIx::Class',
494 dbic_schema => $schema,
496 producer => 'SQL::Translator::Producer::YAML',
499 my $yaml = SQL::Translator->new(
500 parser => 'SQL::Translator::Parser::DBIx::Class',
501 producer => 'SQL::Translator::Producer::YAML',
502 )->translate(data => $schema);
506 Create an index for each foreign key.
507 Enabled by default, as having indexed foreign key columns is normally the
508 sensible thing to do.
514 =item Arguments: \@class_names
518 Limit the amount of parsed sources by supplying an explicit list of source names.
522 L<SQL::Translator>, L<DBIx::Class::Schema>
526 See L<DBIx::Class/CONTRIBUTORS>.
530 You may distribute this code under the same terms as Perl itself.