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