Some cleanup of the resolve_relationship_condition callsites
[dbsrgits/DBIx-Class.git] / lib / SQL / Translator / Parser / DBIx / Class.pm
CommitLineData
392cebac 1package SQL::Translator::Parser::DBIx::Class;
b02b20b5 2
3# AUTHOR: Jess Robinson
4
1d996af5 5# Some mistakes the fault of Matt S Trout
6
c385ecea 7# Others the fault of Ash Berlin
8
b02b20b5 9use strict;
10use warnings;
f9cc85ce 11our ($DEBUG, $VERSION, @EXPORT_OK);
4a9f6cdc 12$VERSION = '1.10';
b02b20b5 13$DEBUG = 0 unless defined $DEBUG;
ebed3aaf 14
b02b20b5 15use Exporter;
b02b20b5 16use SQL::Translator::Utils qw(debug normalize_name);
70c28808 17use DBIx::Class::Carp qw/^SQL::Translator|^DBIx::Class|^Try::Tiny/;
e2741c7f 18use DBIx::Class::_Util qw( dbic_internal_try dbic_internal_catch );
63a18cfe 19use Class::C3::Componentised;
7536c92b 20use Scalar::Util 'blessed';
fd323bf1 21use namespace::clean;
b02b20b5 22
23use base qw(Exporter);
24
25@EXPORT_OK = qw(parse);
26
27# -------------------------------------------------------------------
28# parse($tr, $data)
29#
0e2c6809 30# setting parser_args => { add_fk_index => 0 } will prevent
31# the auto-generation of an index for each FK.
32#
880a1a0c 33# Note that $data, in the case of this parser, is not useful.
b02b20b5 34# We're working with DBIx::Class Schemas, not data streams.
35# -------------------------------------------------------------------
36sub parse {
499adf63 37 my ($tr, $data) = @_;
38 my $args = $tr->parser_args;
a07ae2aa 39
40 my $dbicschema = $data || $args->{dbic_schema};
41
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");
45
46 # move it from the deprecated to the proper $args slot
47 unless ($dbicschema) {
48 $args->{dbic_schema} = $dbicschema = $s;
49 }
50 }
51 }
48850f9a 52
70c28808 53 DBIx::Class::Exception->throw('No DBIx::Class::Schema') unless ($dbicschema);
a07ae2aa 54
b7e303a8 55 if (!ref $dbicschema) {
ddcc02d1 56 dbic_internal_try {
63a18cfe 57 Class::C3::Componentised->ensure_class_loaded($dbicschema)
e2741c7f 58 }
59 dbic_internal_catch {
63a18cfe 60 DBIx::Class::Exception->throw("Can't load $dbicschema: $_");
61 }
b02b20b5 62 }
63
31399b48 64 if (
65 ref $args->{dbic_schema}
66 and
67 $args->{dbic_schema}->storage
68 ) {
69 # we have a storage-holding $schema instance in $args
70 # we need to dissociate it from that $storage
71 # otherwise SQLT insanity may ensue due to how some
72 # serializing producers treat $args (crazy crazy shit)
73 local $args->{dbic_schema}{storage};
74 $args->{dbic_schema} = $args->{dbic_schema}->clone;
75 }
76
b02b20b5 77 my $schema = $tr->schema;
78 my $table_no = 0;
79
b1f9d92e 80 $schema->name( ref($dbicschema) . " v" . ($dbicschema->schema_version || '1.x'))
b7e303a8 81 unless ($schema->name);
38e48163 82
b7e303a8 83 my @monikers = sort $dbicschema->sources;
a07ae2aa 84 if (my $limit_sources = $args->{'sources'}) {
499adf63 85 my $ref = ref $limit_sources || '';
eb0bc670 86 $dbicschema->throw_exception ("'sources' parameter must be an array or hash ref")
87 unless( $ref eq 'ARRAY' || ref eq 'HASH' );
499adf63 88
fd323bf1 89 # limit monikers to those specified in
499adf63 90 my $sources;
91 if ($ref eq 'ARRAY') {
92 $sources->{$_} = 1 for (@$limit_sources);
93 } else {
94 $sources = $limit_sources;
95 }
96 @monikers = grep { $sources->{$_} } @monikers;
97 }
98
99
a7f4b74c 100 my(%table_monikers, %view_monikers);
1d521afd 101 for my $moniker (@monikers){
102 my $source = $dbicschema->source($moniker);
5f5e87cf 103 if ( $source->isa('DBIx::Class::ResultSource::Table') ) {
a7f4b74c 104 $table_monikers{$moniker}++;
5f5e87cf 105 } elsif( $source->isa('DBIx::Class::ResultSource::View') ){
bccd177f 106 next if $source->is_virtual;
a7f4b74c 107 $view_monikers{$moniker}++;
1d521afd 108 }
109 }
499adf63 110
48850f9a 111 my %tables;
a7f4b74c 112 foreach my $moniker (sort keys %table_monikers)
b02b20b5 113 {
b7e303a8 114 my $source = $dbicschema->source($moniker);
48850f9a 115 my $table_name = $source->name;
39be4120 116
4678e9da 117 # FIXME - this isn't the right way to do it, but sqlt does not
118 # support quoting properly to be signaled about this
a8fcfb9f 119 $table_name = $$table_name if ref $table_name eq 'SCALAR';
b02b20b5 120
e3d5a547 121 # It's possible to have multiple DBIC sources using the same table
48850f9a 122 next if $tables{$table_name};
38e48163 123
48850f9a 124 $tables{$table_name}{source} = $source;
125 my $table = $tables{$table_name}{object} = SQL::Translator::Schema::Table->new(
126 name => $table_name,
b02b20b5 127 type => 'TABLE',
48850f9a 128 );
b83736a7 129
130 my $ci = $source->columns_info;
131
132 # same order as add_columns
b02b20b5 133 foreach my $col ($source->columns)
134 {
d6c79cb3 135 # assuming column_info in dbic is the same as DBI (?)
b02b20b5 136 # data_type is a number, column_type is text?
137 my %colinfo = (
138 name => $col,
b02b20b5 139 size => 0,
140 is_auto_increment => 0,
141 is_foreign_key => 0,
142 is_nullable => 0,
b83736a7 143 %{$ci->{$col} || {}}
b02b20b5 144 );
0009fa49 145 if ($colinfo{is_nullable}) {
146 $colinfo{default} = '' unless exists $colinfo{default};
147 }
eb0bc670 148 my $f = $table->add_field(%colinfo)
149 || $dbicschema->throw_exception ($table->error);
b02b20b5 150 }
b02b20b5 151
7b90bb13 152 my @primary = $source->primary_columns;
36e9e24f 153
154 $table->primary_key(@primary) if @primary;
155
7b90bb13 156 my %unique_constraints = $source->unique_constraints;
b7e303a8 157 foreach my $uniq (sort keys %unique_constraints) {
6d0ee587 158 if (!$source->_compare_relationship_keys($unique_constraints{$uniq}, \@primary)) {
7b90bb13 159 $table->add_constraint(
160 type => 'unique',
a7e65bb5 161 name => $uniq,
7b90bb13 162 fields => $unique_constraints{$uniq}
163 );
164 }
165 }
166
b02b20b5 167 my @rels = $source->relationships();
499adf63 168
169 my %created_FK_rels;
48850f9a 170
2581038c 171 # global add_fk_index set in parser_args
a7f4b74c 172 my $add_fk_index = (exists $args->{add_fk_index} && ! $args->{add_fk_index}) ? 0 : 1;
499adf63 173
e089c417 174 REL:
175 foreach my $rel (sort @rels) {
a7f4b74c 176
b02b20b5 177 my $rel_info = $source->relationship_info($rel);
637ca936 178
637ca936 179 # Ignore any rel cond that isn't a straight hash
09d2e66a 180 #
181 # FIXME - this can be done *WAY* better via the recolcond resolver
182 # but no time to think through the implications for deploy() at
183 # the moment. Grep for {identity_map_matches_condition} for ideas
184 # how to improve this, and the /^\w+\.(\w+)$/ crap below
637ca936 185 next unless ref $rel_info->{cond} eq 'HASH';
186
ddcc02d1 187 my $relsource = dbic_internal_try { $source->related_source($rel) };
5b9ecfcc 188 unless ($relsource) {
10e37567 189 carp "Ignoring relationship '$rel' on '$moniker' - related resultsource '$rel_info->{class}' is not registered with this schema\n";
5b9ecfcc 190 next;
191 };
a7f4b74c 192
193 # related sources might be excluded via a {sources} filter or might be views
194 next unless exists $table_monikers{$relsource->source_name};
195
196 my $rel_table = $relsource->name;
4678e9da 197
198 # FIXME - this isn't the right way to do it, but sqlt does not
199 # support quoting properly to be signaled about this
200 $rel_table = $$rel_table if ref $rel_table eq 'SCALAR';
de60a93d 201
d1b264d3 202 # Force the order of @cond to match the order of ->add_columns
203 my $idx;
a7f4b74c 204 my %other_columns_idx = map {'foreign.'.$_ => ++$idx } $relsource->columns;
e089c417 205
206 for ( keys %{$rel_info->{cond}} ) {
207 unless (exists $other_columns_idx{$_}) {
10e37567 208 carp "Ignoring relationship '$rel' on '$moniker' - related resultsource '@{[ $relsource->source_name ]}' does not contain one of the specified columns: '$_'\n";
e089c417 209 next REL;
210 }
211 }
212
213 my @cond = sort { $other_columns_idx{$a} <=> $other_columns_idx{$b} } keys(%{$rel_info->{cond}});
48850f9a 214
637ca936 215 # Get the key information, mapping off the foreign/self markers
637ca936 216 my @refkeys = map {/^\w+\.(\w+)$/} @cond;
217 my @keys = map {$rel_info->{cond}->{$_} =~ /^\w+\.(\w+)$/} @cond;
218
e377d723 219 # determine if this relationship is a self.fk => foreign.pk (i.e. belongs_to)
220 my $fk_constraint;
de60a93d 221
e377d723 222 #first it can be specified explicitly
223 if ( exists $rel_info->{attrs}{is_foreign_key_constraint} ) {
224 $fk_constraint = $rel_info->{attrs}{is_foreign_key_constraint};
225 }
226 # it can not be multi
069e49b6 227 elsif ( $rel_info->{attrs}{accessor}
228 && $rel_info->{attrs}{accessor} eq 'multi' ) {
e377d723 229 $fk_constraint = 0;
230 }
231 # if indeed single, check if all self.columns are our primary keys.
232 # this is supposed to indicate a has_one/might_have...
233 # where's the introspection!!?? :)
234 else {
6d0ee587 235 $fk_constraint = not $source->_compare_relationship_keys(\@keys, \@primary);
e377d723 236 }
de60a93d 237
2f077f92 238
e377d723 239 my $cascade;
a4e4185f 240 CASCADE_TYPE:
e377d723 241 for my $c (qw/delete update/) {
242 if (exists $rel_info->{attrs}{"on_$c"}) {
243 if ($fk_constraint) {
244 $cascade->{$c} = $rel_info->{attrs}{"on_$c"};
245 }
db79c254 246 elsif ( $rel_info->{attrs}{"on_$c"} ) {
48850f9a 247 carp "SQLT attribute 'on_$c' was supplied for relationship '$moniker/$rel', which does not appear to be a foreign constraint. "
e377d723 248 . "If you are sure that SQLT must generate a constraint for this relationship, add 'is_foreign_key_constraint => 1' to the attributes.\n";
249 }
250 }
a4e4185f 251 else {
252 for my $revrelinfo (values %{ $source->reverse_relationship_info($rel) } ) {
253 ( ( $cascade->{$c} = 'CASCADE' ), next CASCADE_TYPE ) if (
254 $revrelinfo->{attrs}
255 ->{ ($c eq 'update')
256 ? 'cascade_copy'
257 : 'cascade_delete'
258 }
259 );
260 }
de60a93d 261 }
e377d723 262 }
263
cae467a7 264 if($rel_table) {
e377d723 265 # Constraints are added only if applicable
266 next unless $fk_constraint;
267
ac86dfe1 268 # Make sure we don't create the same foreign key constraint twice
e3d5a547 269 my $key_test = join("\x00", sort @keys);
e377d723 270 next if $created_FK_rels{$rel_table}->{$key_test};
de60a93d 271
48850f9a 272 if (scalar(@keys)) {
48850f9a 273 $created_FK_rels{$rel_table}->{$key_test} = 1;
13de943d 274
48850f9a 275 my $is_deferrable = $rel_info->{attrs}{is_deferrable};
276
a7f4b74c 277 # calculate dependencies: do not consider deferrable constraints and
278 # self-references for dependency calculations
48850f9a 279 if (! $is_deferrable and $rel_table ne $table_name) {
280 $tables{$table_name}{foreign_table_deps}{$rel_table}++;
281 }
7b5d0b84 282
0e14d918 283 # trim schema before generating constraint/index names
284 (my $table_abbrev = $table_name) =~ s/ ^ [^\.]+ \. //x;
285
7b5d0b84 286 $table->add_constraint(
cae467a7 287 type => 'foreign_key',
0e14d918 288 name => join('_', $table_abbrev, 'fk', @keys),
cae467a7 289 fields => \@keys,
290 reference_fields => \@refkeys,
291 reference_table => $rel_table,
292 on_delete => uc ($cascade->{delete} || ''),
293 on_update => uc ($cascade->{update} || ''),
294 (defined $is_deferrable ? ( deferrable => $is_deferrable ) : ()),
7b5d0b84 295 );
48850f9a 296
297 # global parser_args add_fk_index param can be overridden on the rel def
298 my $add_fk_index_rel = (exists $rel_info->{attrs}{add_fk_index}) ? $rel_info->{attrs}{add_fk_index} : $add_fk_index;
299
c49ff507 300 # Check that we do not create an index identical to the PK index
301 # (some RDBMS croak on this, and it generally doesn't make much sense)
302 # NOTE: we do not sort the key columns because the order of
5930bfc2 303 # columns is important for indexes and two indexes with the
304 # same cols but different order are allowed and sometimes
305 # needed
c49ff507 306 next if join("\x00", @keys) eq join("\x00", @primary);
48850f9a 307
2581038c 308 if ($add_fk_index_rel) {
0e14d918 309 (my $idx_name = $table_name) =~ s/ ^ [^\.]+ \. //x;
0e2c6809 310 my $index = $table->add_index(
0e14d918 311 name => join('_', $table_abbrev, 'idx', @keys),
5930bfc2 312 fields => \@keys,
313 type => 'NORMAL',
314 );
0e2c6809 315 }
316 }
b02b20b5 317 }
318 }
48850f9a 319
b02b20b5 320 }
d6c79cb3 321
48850f9a 322 # attach the tables to the schema in dependency order
323 my $dependencies = {
324 map { $_ => _resolve_deps ($_, \%tables) } (keys %tables)
325 };
9485509b 326
48850f9a 327 for my $table (sort
328 {
329 keys %{$dependencies->{$a} || {} } <=> keys %{ $dependencies->{$b} || {} }
330 ||
331 $a cmp $b
332 }
333 (keys %tables)
334 ) {
335 $schema->add_table ($tables{$table}{object});
336 $tables{$table}{source} -> _invoke_sqlt_deploy_hook( $tables{$table}{object} );
48850f9a 337
7adc2091 338 # the hook might have already removed the table
339 if ($schema->get_table($table) && $table =~ /^ \s* \( \s* SELECT \s+/ix) {
5b9ecfcc 340 carp <<'EOW';
a8fcfb9f 341
7adc2091 342Custom SQL through ->name(\'( SELECT ...') is DEPRECATED, for more details see
343"Arbitrary SQL through a custom ResultSource" in DBIx::Class::Manual::Cookbook
344or http://search.cpan.org/dist/DBIx-Class/lib/DBIx/Class/Manual/Cookbook.pod
39be4120 345
7adc2091 346EOW
39be4120 347
7adc2091 348 # remove the table as there is no way someone might want to
349 # actually deploy this
350 $schema->drop_table ($table);
39be4120 351 }
352 }
48850f9a 353
354 my %views;
51b31bbe 355 my @views = map { $dbicschema->source($_) } keys %view_monikers;
9485509b 356
c418c5cc 357 my $view_dependencies = {
358 map {
a8cbaf38 359 $_ => _resolve_deps( $dbicschema->source($_), \%view_monikers )
c418c5cc 360 } ( keys %view_monikers )
361 };
51b31bbe 362
363 my @view_sources =
364 sort {
c418c5cc 365 keys %{ $view_dependencies->{ $a->source_name } || {} } <=>
366 keys %{ $view_dependencies->{ $b->source_name } || {} }
51b31bbe 367 || $a->source_name cmp $b->source_name
368 }
369 map { $dbicschema->source($_) }
370 keys %view_monikers;
1999a918 371
943538a0 372 foreach my $source (@view_sources)
1d521afd 373 {
48850f9a 374 my $view_name = $source->name;
4678e9da 375
376 # FIXME - this isn't the right way to do it, but sqlt does not
377 # support quoting properly to be signaled about this
378 $view_name = $$view_name if ref $view_name eq 'SCALAR';
48850f9a 379
1d521afd 380 # Skip custom query sources
48850f9a 381 next if ref $view_name;
1d521afd 382
383 # Its possible to have multiple DBIC source using same table
48850f9a 384 next if $views{$view_name}++;
1d521afd 385
ab7e74aa 386 $dbicschema->throw_exception ("view $view_name is missing a view_definition")
387 unless $source->view_definition;
8f1617e2 388
48850f9a 389 my $view = $schema->add_view (
390 name => $view_name,
1d521afd 391 fields => [ $source->columns ],
f534e33b 392 $source->view_definition ? ( 'sql' => $source->view_definition ) : ()
eb0bc670 393 ) || $dbicschema->throw_exception ($schema->error);
a99b214b 394
395 $source->_invoke_sqlt_deploy_hook($view);
1d521afd 396 }
397
48850f9a 398
b7e303a8 399 if ($dbicschema->can('sqlt_deploy_hook')) {
400 $dbicschema->sqlt_deploy_hook($schema);
d6c79cb3 401 }
402
637ca936 403 return 1;
75d07914 404}
b02b20b5 405
48850f9a 406#
407# Quick and dirty dependency graph calculator
408#
409sub _resolve_deps {
a8cbaf38 410 my ( $question, $answers, $seen ) = @_;
c418c5cc 411 my $ret = {};
51b31bbe 412 $seen ||= {};
a8cbaf38 413 my @deps;
51b31bbe 414
415 # copy and bump all deps by one (so we can reconstruct the chain)
416 my %seen = map { $_ => $seen->{$_} + 1 } ( keys %$seen );
6c97a902 417 if ( blessed($question)
418 && $question->isa('DBIx::Class::ResultSource::View') )
419 {
a8cbaf38 420 $seen{ $question->result_class } = 1;
421 @deps = keys %{ $question->{deploy_depends_on} };
422 }
423 else {
424 $seen{$question} = 1;
425 @deps = keys %{ $answers->{$question}{foreign_table_deps} };
426 }
427
428 for my $dep (@deps) {
51b31bbe 429 if ( $seen->{$dep} ) {
430 return {};
431 }
a8cbaf38 432 my $next_dep;
51b31bbe 433
6c97a902 434 if ( blessed($question)
435 && $question->isa('DBIx::Class::ResultSource::View') )
436 {
437 no warnings 'uninitialized';
a8cbaf38 438 my ($next_dep_source_name) =
6c97a902 439 grep {
440 $question->schema->source($_)->result_class eq $dep
441 && !( $question->schema->source($_)
442 ->isa('DBIx::Class::ResultSource::Table') )
443 } @{ [ $question->schema->sources ] };
444 return {} unless $next_dep_source_name;
a8cbaf38 445 $next_dep = $question->schema->source($next_dep_source_name);
446 }
447 else {
448 $next_dep = $dep;
449 }
450 my $subdeps = _resolve_deps( $next_dep, $answers, \%seen );
451 $ret->{$_} += $subdeps->{$_} for ( keys %$subdeps );
51b31bbe 452 ++$ret->{$dep};
453 }
454 return $ret;
455}
456
0da8b7da 4571;
7232ce07 458
459=head1 NAME
460
461SQL::Translator::Parser::DBIx::Class - Create a SQL::Translator schema
462from a DBIx::Class::Schema instance
463
464=head1 SYNOPSIS
465
f26d4b95 466 ## Via DBIx::Class
467 use MyApp::Schema;
468 my $schema = MyApp::Schema->connect("dbi:SQLite:something.db");
469 $schema->create_ddl_dir();
470 ## or
471 $schema->deploy();
472
473 ## Standalone
7232ce07 474 use MyApp::Schema;
475 use SQL::Translator;
d4daee7b 476
7232ce07 477 my $schema = MyApp::Schema->connect;
478 my $trans = SQL::Translator->new (
479 parser => 'SQL::Translator::Parser::DBIx::Class',
37cb0de1 480 parser_args => {
a07ae2aa 481 dbic_schema => $schema,
cae467a7 482 add_fk_index => 0,
37cb0de1 483 sources => [qw/
484 Artist
485 CD
486 /],
487 },
7232ce07 488 producer => 'SQLite',
489 ) or die SQL::Translator->error;
490 my $out = $trans->translate() or die $trans->error;
491
492=head1 DESCRIPTION
493
f26d4b95 494This class requires L<SQL::Translator> installed to work.
495
7232ce07 496C<SQL::Translator::Parser::DBIx::Class> reads a DBIx::Class schema,
497interrogates the columns, and stuffs it all in an $sqlt_schema object.
498
faaba25f 499Its primary use is in deploying database layouts described as a set
db2b2eb6 500of L<DBIx::Class> classes, to a database. To do this, see
501L<DBIx::Class::Schema/deploy>.
f26d4b95 502
503This can also be achieved by having DBIx::Class export the schema as a
504set of SQL files ready for import into your database, or passed to
505other machines that need to have your application installed but don't
db2b2eb6 506have SQL::Translator installed. To do this see
507L<DBIx::Class::Schema/create_ddl_dir>.
f26d4b95 508
cae467a7 509=head1 PARSER OPTIONS
510
a07ae2aa 511=head2 dbic_schema
512
513The DBIx::Class schema (either an instance or a class name) to be parsed.
514This argument is in fact optional - instead one can supply it later at
515translation time as an argument to L<SQL::Translator/translate>. In
516other words both of the following invocations are valid and will produce
517conceptually identical output:
518
519 my $yaml = SQL::Translator->new(
520 parser => 'SQL::Translator::Parser::DBIx::Class',
521 parser_args => {
522 dbic_schema => $schema,
523 },
524 producer => 'SQL::Translator::Producer::YAML',
525 )->translate;
526
527 my $yaml = SQL::Translator->new(
528 parser => 'SQL::Translator::Parser::DBIx::Class',
529 producer => 'SQL::Translator::Producer::YAML',
530 )->translate(data => $schema);
531
cae467a7 532=head2 add_fk_index
533
534Create an index for each foreign key.
ad91ed74 535Enabled by default, as having indexed foreign key columns is normally the
536sensible thing to do.
cae467a7 537
538=head2 sources
539
540=over 4
541
f0ac764e 542=item Arguments: \@class_names
cae467a7 543
544=back
ad91ed74 545
546Limit the amount of parsed sources by supplying an explicit list of source names.
cae467a7 547
7232ce07 548=head1 SEE ALSO
549
f26d4b95 550L<SQL::Translator>, L<DBIx::Class::Schema>
7232ce07 551
a2bd3796 552=head1 FURTHER QUESTIONS?
7232ce07 553
a2bd3796 554Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
7232ce07 555
a2bd3796 556=head1 COPYRIGHT AND LICENSE
7232ce07 557
a2bd3796 558This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
559by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
560redistribute it and/or modify it under the same terms as the
561L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.