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 $VERSION @EXPORT_OK);
13 $DEBUG = 0 unless defined $DEBUG;
16 use SQL::Translator::Utils qw(debug normalize_name);
17 use Carp::Clan qw/^SQL::Translator|^DBIx::Class/;
19 use base qw(Exporter);
21 @EXPORT_OK = qw(parse);
23 # -------------------------------------------------------------------
26 # setting parser_args => { add_fk_index => 0 } will prevent
27 # the auto-generation of an index for each FK.
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 # -------------------------------------------------------------------
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'};
39 die 'No DBIx::Class::Schema' unless ($dbicschema);
40 if (!ref $dbicschema) {
41 eval "use $dbicschema;";
42 die "Can't load $dbicschema ($@)" if($@);
45 my $schema = $tr->schema;
48 $schema->name( ref($dbicschema) . " v" . ($dbicschema->schema_version || '1.x'))
49 unless ($schema->name);
51 my @monikers = sort $dbicschema->sources;
53 my $ref = ref $limit_sources || '';
54 die "'sources' parameter must be an array or hash ref" unless $ref eq 'ARRAY' || ref eq 'HASH';
56 # limit monikers to those specified in
58 if ($ref eq 'ARRAY') {
59 $sources->{$_} = 1 for (@$limit_sources);
61 $sources = $limit_sources;
63 @monikers = grep { $sources->{$_} } @monikers;
67 my(@table_monikers, @view_monikers);
68 for my $moniker (@monikers){
69 my $source = $dbicschema->source($moniker);
70 if ( $source->isa('DBIx::Class::ResultSource::Table') ) {
71 push(@table_monikers, $moniker);
72 } elsif( $source->isa('DBIx::Class::ResultSource::View') ){
73 next if $source->is_virtual;
74 push(@view_monikers, $moniker);
79 foreach my $moniker (sort @table_monikers)
81 my $source = $dbicschema->source($moniker);
82 my $table_name = $source->name;
84 # Skip custom query sources
85 next if ref $table_name;
87 # Its possible to have multiple DBIC sources using the same table
88 next if $tables{$table_name};
90 $tables{$table_name}{source} = $source;
91 my $table = $tables{$table_name}{object} = SQL::Translator::Schema::Table->new(
95 foreach my $col ($source->columns)
97 # assuming column_info in dbic is the same as DBI (?)
98 # data_type is a number, column_type is text?
102 is_auto_increment => 0,
105 %{$source->column_info($col)}
107 if ($colinfo{is_nullable}) {
108 $colinfo{default} = '' unless exists $colinfo{default};
110 my $f = $table->add_field(%colinfo) || die $table->error;
112 $table->primary_key($source->primary_columns);
114 my @primary = $source->primary_columns;
115 my %unique_constraints = $source->unique_constraints;
116 foreach my $uniq (sort keys %unique_constraints) {
117 if (!$source->_compare_relationship_keys($unique_constraints{$uniq}, \@primary)) {
118 $table->add_constraint(
121 fields => $unique_constraints{$uniq}
126 my @rels = $source->relationships();
130 # global add_fk_index set in parser_args
131 my $add_fk_index = (exists $args->{add_fk_index} && ($args->{add_fk_index} == 0)) ? 0 : 1;
133 foreach my $rel (sort @rels)
135 my $rel_info = $source->relationship_info($rel);
137 # Ignore any rel cond that isn't a straight hash
138 next unless ref $rel_info->{cond} eq 'HASH';
140 my $othertable = $source->related_source($rel);
141 my $rel_table = $othertable->name;
143 my $reverse_rels = $source->reverse_relationship_info($rel);
144 my ($otherrelname, $otherrelationship) = each %{$reverse_rels};
146 # Force the order of @cond to match the order of ->add_columns
148 my %other_columns_idx = map {'foreign.'.$_ => ++$idx } $othertable->columns;
149 my @cond = sort { $other_columns_idx{$a} cmp $other_columns_idx{$b} } keys(%{$rel_info->{cond}});
151 # Get the key information, mapping off the foreign/self markers
152 my @refkeys = map {/^\w+\.(\w+)$/} @cond;
153 my @keys = map {$rel_info->{cond}->{$_} =~ /^\w+\.(\w+)$/} @cond;
155 # determine if this relationship is a self.fk => foreign.pk (i.e. belongs_to)
158 #first it can be specified explicitly
159 if ( exists $rel_info->{attrs}{is_foreign_key_constraint} ) {
160 $fk_constraint = $rel_info->{attrs}{is_foreign_key_constraint};
162 # it can not be multi
163 elsif ( $rel_info->{attrs}{accessor}
164 && $rel_info->{attrs}{accessor} eq 'multi' ) {
167 # if indeed single, check if all self.columns are our primary keys.
168 # this is supposed to indicate a has_one/might_have...
169 # where's the introspection!!?? :)
171 $fk_constraint = not $source->_compare_relationship_keys(\@keys, \@primary);
175 for my $c (qw/delete update/) {
176 if (exists $rel_info->{attrs}{"on_$c"}) {
177 if ($fk_constraint) {
178 $cascade->{$c} = $rel_info->{attrs}{"on_$c"};
181 carp "SQLT attribute 'on_$c' was supplied for relationship '$moniker/$rel', which does not appear to be a foreign constraint. "
182 . "If you are sure that SQLT must generate a constraint for this relationship, add 'is_foreign_key_constraint => 1' to the attributes.\n";
185 elsif (defined $otherrelationship and $otherrelationship->{attrs}{$c eq 'update' ? 'cascade_copy' : 'cascade_delete'}) {
186 $cascade->{$c} = 'CASCADE';
192 # Constraints are added only if applicable
193 next unless $fk_constraint;
195 # Make sure we dont create the same foreign key constraint twice
196 my $key_test = join("\x00", @keys);
197 next if $created_FK_rels{$rel_table}->{$key_test};
201 $created_FK_rels{$rel_table}->{$key_test} = 1;
203 my $is_deferrable = $rel_info->{attrs}{is_deferrable};
205 # do not consider deferrable constraints and self-references
206 # for dependency calculations
207 if (! $is_deferrable and $rel_table ne $table_name) {
208 $tables{$table_name}{foreign_table_deps}{$rel_table}++;
211 $table->add_constraint(
212 type => 'foreign_key',
213 name => join('_', $table_name, 'fk', @keys),
215 reference_fields => \@refkeys,
216 reference_table => $rel_table,
217 on_delete => uc ($cascade->{delete} || ''),
218 on_update => uc ($cascade->{update} || ''),
219 (defined $is_deferrable ? ( deferrable => $is_deferrable ) : ()),
222 # global parser_args add_fk_index param can be overridden on the rel def
223 my $add_fk_index_rel = (exists $rel_info->{attrs}{add_fk_index}) ? $rel_info->{attrs}{add_fk_index} : $add_fk_index;
225 if ($add_fk_index_rel) {
226 my $index = $table->add_index(
227 name => join('_', $table_name, 'idx', @keys),
238 # attach the tables to the schema in dependency order
240 map { $_ => _resolve_deps ($_, \%tables) } (keys %tables)
244 keys %{$dependencies->{$a} || {} } <=> keys %{ $dependencies->{$b} || {} }
250 $schema->add_table ($tables{$table}{object});
251 $tables{$table}{source} -> _invoke_sqlt_deploy_hook( $tables{$table}{object} );
256 foreach my $moniker (sort @view_monikers)
258 my $source = $dbicschema->source($moniker);
259 my $view_name = $source->name;
261 # Skip custom query sources
262 next if ref $view_name;
264 # Its possible to have multiple DBIC source using same table
265 next if $views{$view_name}++;
267 my $view = $schema->add_view (
269 fields => [ $source->columns ],
270 $source->view_definition ? ( 'sql' => $source->view_definition ) : ()
271 ) || die $schema->error;
273 $source->_invoke_sqlt_deploy_hook($view);
277 if ($dbicschema->can('sqlt_deploy_hook')) {
278 $dbicschema->sqlt_deploy_hook($schema);
285 # Quick and dirty dependency graph calculator
288 my ($table, $tables, $seen) = @_;
293 # copy and bump all deps by one (so we can reconstruct the chain)
294 my %seen = map { $_ => $seen->{$_} + 1 } (keys %$seen);
297 for my $dep (keys %{$tables->{$table}{foreign_table_deps}} ) {
301 # warn and remove the circular constraint so we don't get flooded with the same warning over and over
302 #carp sprintf ("Circular dependency detected, schema may not be deployable:\n%s\n",
303 # join (' -> ', (sort { $seen->{$b} <=> $seen->{$a} } (keys %$seen) ), $table, $dep )
305 #delete $tables->{$table}{foreign_table_deps}{$dep};
310 my $subdeps = _resolve_deps ($dep, $tables, \%seen);
311 $ret->{$_} += $subdeps->{$_} for ( keys %$subdeps );
323 SQL::Translator::Parser::DBIx::Class - Create a SQL::Translator schema
324 from a DBIx::Class::Schema instance
330 my $schema = MyApp::Schema->connect("dbi:SQLite:something.db");
331 $schema->create_ddl_dir();
339 my $schema = MyApp::Schema->connect;
340 my $trans = SQL::Translator->new (
341 parser => 'SQL::Translator::Parser::DBIx::Class',
342 parser_args => { package => $schema },
343 producer => 'SQLite',
344 ) or die SQL::Translator->error;
345 my $out = $trans->translate() or die $trans->error;
349 This class requires L<SQL::Translator> installed to work.
351 C<SQL::Translator::Parser::DBIx::Class> reads a DBIx::Class schema,
352 interrogates the columns, and stuffs it all in an $sqlt_schema object.
354 It's primary use is in deploying database layouts described as a set
355 of L<DBIx::Class> classes, to a database. To do this, see
356 L<DBIx::Class::Schema/deploy>.
358 This can also be achieved by having DBIx::Class export the schema as a
359 set of SQL files ready for import into your database, or passed to
360 other machines that need to have your application installed but don't
361 have SQL::Translator installed. To do this see
362 L<DBIx::Class::Schema/create_ddl_dir>.
366 L<SQL::Translator>, L<DBIx::Class::Schema>