lib/SQL/Translator/Parser/DBIx/Class.pm

   1 package SQL::Translator::Parser::DBIx::Class;
   2
   3 # AUTHOR: Jess Robinson
   4
   5 # Some mistakes the fault of Matt S Trout
   6
   7 # Others the fault of Ash Berlin
   8
   9 use strict;
  10 use warnings;
  11 use vars qw($DEBUG $VERSION @EXPORT_OK);
  12 $VERSION = '1.10';
  13 $DEBUG = 0 unless defined $DEBUG;
  14
  15 use Exporter;
  16 use SQL::Translator::Utils qw(debug normalize_name);
  17 use Carp::Clan qw/^SQL::Translator|^DBIx::Class/;
  18
  19 use base qw(Exporter);
  20
  21 @EXPORT_OK = qw(parse);
  22
  23 # -------------------------------------------------------------------
  24 # parse($tr, $data)
  25 #
  26 # setting parser_args => { add_fk_index => 0 } will prevent
  27 # the auto-generation of an index for each FK.
  28 #
  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 # -------------------------------------------------------------------
  32 sub parse {
  33     my ($tr, $data)   = @_;
  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'};
  38
  39     croak 'No DBIx::Class::Schema' unless ($dbicschema);
  40     if (!ref $dbicschema) {
  41       eval "use $dbicschema;";
  42       croak "Can't load $dbicschema ($@)" if($@);
  43     }
  44
  45     my $schema      = $tr->schema;
  46     my $table_no    = 0;
  47
  48     $schema->name( ref($dbicschema) . " v" . ($dbicschema->schema_version || '1.x'))
  49       unless ($schema->name);
  50
  51     my @monikers = sort $dbicschema->sources;
  52     if ($limit_sources) {
  53         my $ref = ref $limit_sources || '';
  54         $dbicschema->throw_exception ("'sources' parameter must be an array or hash ref")
  55           unless( $ref eq 'ARRAY' || ref eq 'HASH' );
  56
  57         # limit monikers to those specified in
  58         my $sources;
  59         if ($ref eq 'ARRAY') {
  60             $sources->{$_} = 1 for (@$limit_sources);
  61         } else {
  62             $sources = $limit_sources;
  63         }
  64         @monikers = grep { $sources->{$_} } @monikers;
  65     }
  66
  67
  68     my(@table_monikers, @view_monikers);
  69     for my $moniker (@monikers){
  70       my $source = $dbicschema->source($moniker);
  71        if ( $source->isa('DBIx::Class::ResultSource::Table') ) {
  72          push(@table_monikers, $moniker);
  73       } elsif( $source->isa('DBIx::Class::ResultSource::View') ){
  74           next if $source->is_virtual;
  75          push(@view_monikers, $moniker);
  76       }
  77     }
  78
  79     my %tables;
  80     foreach my $moniker (sort @table_monikers)
  81     {
  82         my $source = $dbicschema->source($moniker);
  83         my $table_name = $source->name;
  84
  85         if (ref $table_name) {
  86           if (ref $table_name eq 'SCALAR') {
  87             $table_name = $$table_name;
  88           } else {
  89             next;
  90           }
  91         }
  92
  93         # Its possible to have multiple DBIC sources using the same table
  94         next if $tables{$table_name};
  95
  96         $tables{$table_name}{source} = $source;
  97         my $table = $tables{$table_name}{object} = SQL::Translator::Schema::Table->new(
  98                                        name => $table_name,
  99                                        type => 'TABLE',
 100                                        );
 101         foreach my $col ($source->columns)
 102         {
 103             # assuming column_info in dbic is the same as DBI (?)
 104             # data_type is a number, column_type is text?
 105             my %colinfo = (
 106               name => $col,
 107               size => 0,
 108               is_auto_increment => 0,
 109               is_foreign_key => 0,
 110               is_nullable => 0,
 111               %{$source->column_info($col)}
 112             );
 113             if ($colinfo{is_nullable}) {
 114               $colinfo{default} = '' unless exists $colinfo{default};
 115             }
 116             my $f = $table->add_field(%colinfo)
 117               || $dbicschema->throw_exception ($table->error);
 118         }
 119         $table->primary_key($source->primary_columns);
 120
 121         my @primary = $source->primary_columns;
 122         my %unique_constraints = $source->unique_constraints;
 123         foreach my $uniq (sort keys %unique_constraints) {
 124             if (!$source->_compare_relationship_keys($unique_constraints{$uniq}, \@primary)) {
 125                 $table->add_constraint(
 126                             type             => 'unique',
 127                             name             => $uniq,
 128                             fields           => $unique_constraints{$uniq}
 129                 );
 130             }
 131         }
 132
 133         my @rels = $source->relationships();
 134
 135         my %created_FK_rels;
 136
 137         # global add_fk_index set in parser_args
 138         my $add_fk_index = (exists $args->{add_fk_index} && ($args->{add_fk_index} == 0)) ? 0 : 1;
 139
 140         foreach my $rel (sort @rels)
 141         {
 142             my $rel_info = $source->relationship_info($rel);
 143
 144             # Ignore any rel cond that isn't a straight hash
 145             next unless ref $rel_info->{cond} eq 'HASH';
 146
 147             my $othertable = $source->related_source($rel);
 148             my $rel_table = $othertable->name;
 149             $rel_table = $$rel_table if ref $rel_table eq 'SCALAR';  #sqlt currently does not do quoting right anyway
 150
 151             my $reverse_rels = $source->reverse_relationship_info($rel);
 152             my ($otherrelname, $otherrelationship) = each %{$reverse_rels};
 153
 154             # Force the order of @cond to match the order of ->add_columns
 155             my $idx;
 156             my %other_columns_idx = map {'foreign.'.$_ => ++$idx } $othertable->columns;
 157             my @cond = sort { $other_columns_idx{$a} cmp $other_columns_idx{$b} } keys(%{$rel_info->{cond}});
 158
 159             # Get the key information, mapping off the foreign/self markers
 160             my @refkeys = map {/^\w+\.(\w+)$/} @cond;
 161             my @keys = map {$rel_info->{cond}->{$_} =~ /^\w+\.(\w+)$/} @cond;
 162
 163             # determine if this relationship is a self.fk => foreign.pk (i.e. belongs_to)
 164             my $fk_constraint;
 165
 166             #first it can be specified explicitly
 167             if ( exists $rel_info->{attrs}{is_foreign_key_constraint} ) {
 168                 $fk_constraint = $rel_info->{attrs}{is_foreign_key_constraint};
 169             }
 170             # it can not be multi
 171             elsif ( $rel_info->{attrs}{accessor}
 172                     && $rel_info->{attrs}{accessor} eq 'multi' ) {
 173                 $fk_constraint = 0;
 174             }
 175             # if indeed single, check if all self.columns are our primary keys.
 176             # this is supposed to indicate a has_one/might_have...
 177             # where's the introspection!!?? :)
 178             else {
 179                 $fk_constraint = not $source->_compare_relationship_keys(\@keys, \@primary);
 180             }
 181
 182             my $cascade;
 183             for my $c (qw/delete update/) {
 184                 if (exists $rel_info->{attrs}{"on_$c"}) {
 185                     if ($fk_constraint) {
 186                         $cascade->{$c} = $rel_info->{attrs}{"on_$c"};
 187                     }
 188                     else {
 189                         carp "SQLT attribute 'on_$c' was supplied for relationship '$moniker/$rel', which does not appear to be a foreign constraint. "
 190                             . "If you are sure that SQLT must generate a constraint for this relationship, add 'is_foreign_key_constraint => 1' to the attributes.\n";
 191                     }
 192                 }
 193                 elsif (defined $otherrelationship and $otherrelationship->{attrs}{$c eq 'update' ? 'cascade_copy' : 'cascade_delete'}) {
 194                     $cascade->{$c} = 'CASCADE';
 195                 }
 196             }
 197
 198             if($rel_table)
 199             {
 200                 # Constraints are added only if applicable
 201                 next unless $fk_constraint;
 202
 203                 # Make sure we dont create the same foreign key constraint twice
 204                 my $key_test = join("\x00", @keys);
 205                 next if $created_FK_rels{$rel_table}->{$key_test};
 206
 207                 if (scalar(@keys)) {
 208
 209                   $created_FK_rels{$rel_table}->{$key_test} = 1;
 210
 211                   my $is_deferrable = $rel_info->{attrs}{is_deferrable};
 212
 213                   # do not consider deferrable constraints and self-references
 214                   # for dependency calculations
 215                   if (! $is_deferrable and $rel_table ne $table_name) {
 216                     $tables{$table_name}{foreign_table_deps}{$rel_table}++;
 217                   }
 218
 219                   $table->add_constraint(
 220                                     type             => 'foreign_key',
 221                                     name             => join('_', $table_name, 'fk', @keys),
 222                                     fields           => \@keys,
 223                                     reference_fields => \@refkeys,
 224                                     reference_table  => $rel_table,
 225                                     on_delete        => uc ($cascade->{delete} || ''),
 226                                     on_update        => uc ($cascade->{update} || ''),
 227                                     (defined $is_deferrable ? ( deferrable => $is_deferrable ) : ()),
 228                   );
 229
 230                   # global parser_args add_fk_index param can be overridden on the rel def
 231                   my $add_fk_index_rel = (exists $rel_info->{attrs}{add_fk_index}) ? $rel_info->{attrs}{add_fk_index} : $add_fk_index;
 232
 233                   if ($add_fk_index_rel) {
 234                       my $index = $table->add_index(
 235                                                     name   => join('_', $table_name, 'idx', @keys),
 236                                                     fields => \@keys,
 237                                                     type   => 'NORMAL',
 238                                                     );
 239                   }
 240               }
 241             }
 242         }
 243
 244     }
 245
 246     # attach the tables to the schema in dependency order
 247     my $dependencies = {
 248       map { $_ => _resolve_deps ($_, \%tables) } (keys %tables)
 249     };
 250     for my $table (sort
 251       {
 252         keys %{$dependencies->{$a} || {} } <=> keys %{ $dependencies->{$b} || {} }
 253           ||
 254         $a cmp $b
 255       }
 256       (keys %tables)
 257     ) {
 258       $schema->add_table ($tables{$table}{object});
 259       $tables{$table}{source} -> _invoke_sqlt_deploy_hook( $tables{$table}{object} );
 260
 261       if ($schema->get_table($table) && $table =~ /\( \s* SELECT \s+/x) {
 262         warn <<'EOF';
 263 Custom SQL through ->name(\'( SELECT ...') is DEPRECATED, see the "Arbitrary
 264 SQL" entry in:
 265
 266   perldoc DBIx::Class::Manual::Cookbook
 267
 268 for the current method of doing this.
 269
 270 To exclude this Result class from ->deploy, add the following to it:
 271
 272   sub sqlt_deploy_hook { $_[1]->schema->drop_table ($_[1]) }
 273
 274 EOF
 275       }
 276     }
 277
 278     my %views;
 279     foreach my $moniker (sort @view_monikers)
 280     {
 281         my $source = $dbicschema->source($moniker);
 282         my $view_name = $source->name;
 283         $view_name = $$view_name if ref $view_name eq 'SCALAR';  #sqlt currently does not do quoting right anyway
 284
 285         # Skip custom query sources
 286         next if ref $view_name;
 287
 288         # Its possible to have multiple DBIC source using same table
 289         next if $views{$view_name}++;
 290
 291         my $view = $schema->add_view (
 292           name => $view_name,
 293           fields => [ $source->columns ],
 294           $source->view_definition ? ( 'sql' => $source->view_definition ) : ()
 295         ) || $dbicschema->throw_exception ($schema->error);
 296
 297         $source->_invoke_sqlt_deploy_hook($view);
 298     }
 299
 300
 301     if ($dbicschema->can('sqlt_deploy_hook')) {
 302       $dbicschema->sqlt_deploy_hook($schema);
 303     }
 304
 305     return 1;
 306 }
 307
 308 #
 309 # Quick and dirty dependency graph calculator
 310 #
 311 sub _resolve_deps {
 312   my ($table, $tables, $seen) = @_;
 313
 314   my $ret = {};
 315   $seen ||= {};
 316
 317   # copy and bump all deps by one (so we can reconstruct the chain)
 318   my %seen = map { $_ => $seen->{$_} + 1 } (keys %$seen);
 319   $seen{$table} = 1;
 320
 321   for my $dep (keys %{$tables->{$table}{foreign_table_deps}} ) {
 322
 323     if ($seen->{$dep}) {
 324
 325       # warn and remove the circular constraint so we don't get flooded with the same warning over and over
 326       #carp sprintf ("Circular dependency detected, schema may not be deployable:\n%s\n",
 327       #  join (' -> ', (sort { $seen->{$b} <=> $seen->{$a} } (keys %$seen) ), $table, $dep )
 328       #);
 329       #delete $tables->{$table}{foreign_table_deps}{$dep};
 330
 331       return {};
 332     }
 333
 334     my $subdeps = _resolve_deps ($dep, $tables, \%seen);
 335     $ret->{$_} += $subdeps->{$_} for ( keys %$subdeps );
 336
 337     ++$ret->{$dep};
 338   }
 339
 340   return $ret;
 341 }
 342
 343 1;
 344
 345 =head1 NAME
 346
 347 SQL::Translator::Parser::DBIx::Class - Create a SQL::Translator schema
 348 from a DBIx::Class::Schema instance
 349
 350 =head1 SYNOPSIS
 351
 352  ## Via DBIx::Class
 353  use MyApp::Schema;
 354  my $schema = MyApp::Schema->connect("dbi:SQLite:something.db");
 355  $schema->create_ddl_dir();
 356  ## or
 357  $schema->deploy();
 358
 359  ## Standalone
 360  use MyApp::Schema;
 361  use SQL::Translator;
 362
 363  my $schema = MyApp::Schema->connect;
 364  my $trans  = SQL::Translator->new (
 365       parser      => 'SQL::Translator::Parser::DBIx::Class',
 366       parser_args => { package => $schema },
 367       producer    => 'SQLite',
 368      ) or die SQL::Translator->error;
 369  my $out = $trans->translate() or die $trans->error;
 370
 371 =head1 DESCRIPTION
 372
 373 This class requires L<SQL::Translator> installed to work.
 374
 375 C<SQL::Translator::Parser::DBIx::Class> reads a DBIx::Class schema,
 376 interrogates the columns, and stuffs it all in an $sqlt_schema object.
 377
 378 Its primary use is in deploying database layouts described as a set
 379 of L<DBIx::Class> classes, to a database. To do this, see
 380 L<DBIx::Class::Schema/deploy>.
 381
 382 This can also be achieved by having DBIx::Class export the schema as a
 383 set of SQL files ready for import into your database, or passed to
 384 other machines that need to have your application installed but don't
 385 have SQL::Translator installed. To do this see
 386 L<DBIx::Class::Schema/create_ddl_dir>.
 387
 388 =head1 SEE ALSO
 389
 390 L<SQL::Translator>, L<DBIx::Class::Schema>
 391
 392 =head1 AUTHORS
 393
 394 Jess Robinson
 395
 396 Matt S Trout
 397
 398 Ash Berlin