[dbsrgits/DBIx-Class.git] / lib / SQL / Translator / Parser / DBIx / Class.pm

package SQL::Translator::Parser::DBIx::Class;

# AUTHOR: Jess Robinson

# Some mistakes the fault of Matt S Trout

# Others the fault of Ash Berlin

use strict;
use warnings;
use vars qw($DEBUG $VERSION @EXPORT_OK);
$VERSION = '1.10';
$DEBUG = 0 unless defined $DEBUG;

use Exporter;
use SQL::Translator::Utils qw(debug normalize_name);
use Carp::Clan qw/^SQL::Translator|^DBIx::Class/;

use base qw(Exporter);

@EXPORT_OK = qw(parse);

# -------------------------------------------------------------------
# parse($tr, $data)
#
# setting parser_args => { add_fk_index => 0 } will prevent
# the auto-generation of an index for each FK.
#
# Note that $data, in the case of this parser, is not useful.
# We're working with DBIx::Class Schemas, not data streams.
# -------------------------------------------------------------------
sub parse {
    my ($tr, $data)   = @_;
    my $args          = $tr->parser_args;
    my $dbicschema    = $args->{'DBIx::Class::Schema'} ||  $args->{"DBIx::Schema"} ||$data;
    $dbicschema     ||= $args->{'package'};
    my $limit_sources = $args->{'sources'};

    croak 'No DBIx::Class::Schema' unless ($dbicschema);
    if (!ref $dbicschema) {
      eval "use $dbicschema;";
      croak "Can't load $dbicschema ($@)" if($@);
    }

    my $schema      = $tr->schema;
    my $table_no    = 0;

    $schema->name( ref($dbicschema) . " v" . ($dbicschema->schema_version || '1.x'))
      unless ($schema->name);

    my @monikers = sort $dbicschema->sources;
    if ($limit_sources) {
        my $ref = ref $limit_sources || '';
        $dbicschema->throw_exception ("'sources' parameter must be an array or hash ref")
          unless( $ref eq 'ARRAY' || ref eq 'HASH' );

        # limit monikers to those specified in 
        my $sources;
        if ($ref eq 'ARRAY') {
            $sources->{$_} = 1 for (@$limit_sources);
        } else {
            $sources = $limit_sources;
        }
        @monikers = grep { $sources->{$_} } @monikers;
    }


    my(@table_monikers, @view_monikers);
    for my $moniker (@monikers){
      my $source = $dbicschema->source($moniker);
       if ( $source->isa('DBIx::Class::ResultSource::Table') ) {
         push(@table_monikers, $moniker);
      } elsif( $source->isa('DBIx::Class::ResultSource::View') ){
          next if $source->is_virtual;
         push(@view_monikers, $moniker);
      }
    }

    my %tables;
    foreach my $moniker (sort @table_monikers)
    {
        my $source = $dbicschema->source($moniker);
        my $table_name = $source->name;

        # FIXME - this isn't the right way to do it, but sqlt does not
        # support quoting properly to be signaled about this
        $table_name = $$table_name if ref $table_name eq 'SCALAR';

        # Its possible to have multiple DBIC sources using the same table
        next if $tables{$table_name};

        $tables{$table_name}{source} = $source;
        my $table = $tables{$table_name}{object} = SQL::Translator::Schema::Table->new(
                                       name => $table_name,
                                       type => 'TABLE',
                                       );
        foreach my $col ($source->columns)
        {
            # assuming column_info in dbic is the same as DBI (?)
            # data_type is a number, column_type is text?
            my %colinfo = (
              name => $col,
              size => 0,
              is_auto_increment => 0,
              is_foreign_key => 0,
              is_nullable => 0,
              %{$source->column_info($col)}
            );
            if ($colinfo{is_nullable}) {
              $colinfo{default} = '' unless exists $colinfo{default};
            }
            my $f = $table->add_field(%colinfo)
              || $dbicschema->throw_exception ($table->error);
        }
        $table->primary_key($source->primary_columns);

        my @primary = $source->primary_columns;
        my %unique_constraints = $source->unique_constraints;
        foreach my $uniq (sort keys %unique_constraints) {
            if (!$source->_compare_relationship_keys($unique_constraints{$uniq}, \@primary)) {
                $table->add_constraint(
                            type             => 'unique',
                            name             => $uniq,
                            fields           => $unique_constraints{$uniq}
                );
            }
        }

        my @rels = $source->relationships();

        my %created_FK_rels;

        # global add_fk_index set in parser_args
        my $add_fk_index = (exists $args->{add_fk_index} && ($args->{add_fk_index} == 0)) ? 0 : 1;

        foreach my $rel (sort @rels)
        {
            my $rel_info = $source->relationship_info($rel);

            # Ignore any rel cond that isn't a straight hash
            next unless ref $rel_info->{cond} eq 'HASH';

            my $othertable = $source->related_source($rel);
            my $rel_table = $othertable->name;

            # FIXME - this isn't the right way to do it, but sqlt does not
            # support quoting properly to be signaled about this
            $rel_table = $$rel_table if ref $rel_table eq 'SCALAR';

            my $reverse_rels = $source->reverse_relationship_info($rel);
            my ($otherrelname, $otherrelationship) = each %{$reverse_rels};

            # Force the order of @cond to match the order of ->add_columns
            my $idx;
            my %other_columns_idx = map {'foreign.'.$_ => ++$idx } $othertable->columns;            
            my @cond = sort { $other_columns_idx{$a} cmp $other_columns_idx{$b} } keys(%{$rel_info->{cond}}); 

            # Get the key information, mapping off the foreign/self markers
            my @refkeys = map {/^\w+\.(\w+)$/} @cond;
            my @keys = map {$rel_info->{cond}->{$_} =~ /^\w+\.(\w+)$/} @cond;

            # determine if this relationship is a self.fk => foreign.pk (i.e. belongs_to)
            my $fk_constraint;

            #first it can be specified explicitly
            if ( exists $rel_info->{attrs}{is_foreign_key_constraint} ) {
                $fk_constraint = $rel_info->{attrs}{is_foreign_key_constraint};
            }
            # it can not be multi
            elsif ( $rel_info->{attrs}{accessor}
                    && $rel_info->{attrs}{accessor} eq 'multi' ) {
                $fk_constraint = 0;
            }
            # if indeed single, check if all self.columns are our primary keys.
            # this is supposed to indicate a has_one/might_have...
            # where's the introspection!!?? :)
            else {
                $fk_constraint = not $source->_compare_relationship_keys(\@keys, \@primary);
            }

            my $cascade;
            for my $c (qw/delete update/) {
                if (exists $rel_info->{attrs}{"on_$c"}) {
                    if ($fk_constraint) {
                        $cascade->{$c} = $rel_info->{attrs}{"on_$c"};
                    }
                    else {
                        carp "SQLT attribute 'on_$c' was supplied for relationship '$moniker/$rel', which does not appear to be a foreign constraint. "
                            . "If you are sure that SQLT must generate a constraint for this relationship, add 'is_foreign_key_constraint => 1' to the attributes.\n";
                    }
                }
                elsif (defined $otherrelationship and $otherrelationship->{attrs}{$c eq 'update' ? 'cascade_copy' : 'cascade_delete'}) {
                    $cascade->{$c} = 'CASCADE';
                }
            }

            if($rel_table)
            {
                # Constraints are added only if applicable
                next unless $fk_constraint;

                # Make sure we dont create the same foreign key constraint twice
                my $key_test = join("\x00", @keys);
                next if $created_FK_rels{$rel_table}->{$key_test};

                if (scalar(@keys)) {

                  $created_FK_rels{$rel_table}->{$key_test} = 1;

                  my $is_deferrable = $rel_info->{attrs}{is_deferrable};

                  # do not consider deferrable constraints and self-references
                  # for dependency calculations
                  if (! $is_deferrable and $rel_table ne $table_name) {
                    $tables{$table_name}{foreign_table_deps}{$rel_table}++;
                  }

                  $table->add_constraint(
                                    type             => 'foreign_key',
                                    name             => join('_', $table_name, 'fk', @keys),
                                    fields           => \@keys,
                                    reference_fields => \@refkeys,
                                    reference_table  => $rel_table,
                                    on_delete        => uc ($cascade->{delete} || ''),
                                    on_update        => uc ($cascade->{update} || ''),
                                    (defined $is_deferrable ? ( deferrable => $is_deferrable ) : ()),
                  );

                  # global parser_args add_fk_index param can be overridden on the rel def
                  my $add_fk_index_rel = (exists $rel_info->{attrs}{add_fk_index}) ? $rel_info->{attrs}{add_fk_index} : $add_fk_index;

                  if ($add_fk_index_rel) {
                      my $index = $table->add_index(
                                                    name   => join('_', $table_name, 'idx', @keys),
                                                    fields => \@keys,
                                                    type   => 'NORMAL',
                                                    );
                  }
              }
            }
        }

    }

    # attach the tables to the schema in dependency order
    my $dependencies = {
      map { $_ => _resolve_deps ($_, \%tables) } (keys %tables)
    };
    for my $table (sort
      {
        keys %{$dependencies->{$a} || {} } <=> keys %{ $dependencies->{$b} || {} }
          ||
        $a cmp $b
      }
      (keys %tables)
    ) {
      $schema->add_table ($tables{$table}{object});
      $tables{$table}{source} -> _invoke_sqlt_deploy_hook( $tables{$table}{object} );

      # the hook might have already removed the table
      if ($schema->get_table($table) && $table =~ /^ \s* \( \s* SELECT \s+/ix) {
        warn <<'EOW';

Custom SQL through ->name(\'( SELECT ...') is DEPRECATED, for more details see
"Arbitrary SQL through a custom ResultSource" in DBIx::Class::Manual::Cookbook
or http://search.cpan.org/dist/DBIx-Class/lib/DBIx/Class/Manual/Cookbook.pod

EOW

        # remove the table as there is no way someone might want to
        # actually deploy this
        $schema->drop_table ($table);
      }
    }

    my %views;
    my @view_sources =
      sort {
        (exists $a->depends_on->{$b->source_name} ? 1 : 0)
        <=>
        (exists $b->depends_on->{$a->source_name} ? 1 : 0)
      }
      map { $dbicschema->source($_) } @view_monikers;
    
    foreach my $source (@view_sources)
    {
        my $view_name = $source->name;

        # FIXME - this isn't the right way to do it, but sqlt does not
        # support quoting properly to be signaled about this
        $view_name = $$view_name if ref $view_name eq 'SCALAR';

        # Skip custom query sources
        next if ref $view_name;

        # Its possible to have multiple DBIC source using same table
        next if $views{$view_name}++;

        my $view = $schema->add_view (
          name => $view_name,
          fields => [ $source->columns ],
          $source->view_definition ? ( 'sql' => $source->view_definition ) : ()
        ) || $dbicschema->throw_exception ($schema->error);

        $source->_invoke_sqlt_deploy_hook($view);
    }


    if ($dbicschema->can('sqlt_deploy_hook')) {
      $dbicschema->sqlt_deploy_hook($schema);
    }

    return 1;
}

#
# Quick and dirty dependency graph calculator
#
sub _resolve_deps {
  my ($table, $tables, $seen) = @_;

  my $ret = {};
  $seen ||= {};

  # copy and bump all deps by one (so we can reconstruct the chain)
  my %seen = map { $_ => $seen->{$_} + 1 } (keys %$seen);
  $seen{$table} = 1;

  for my $dep (keys %{$tables->{$table}{foreign_table_deps}} ) {

    if ($seen->{$dep}) {

      # warn and remove the circular constraint so we don't get flooded with the same warning over and over
      #carp sprintf ("Circular dependency detected, schema may not be deployable:\n%s\n",
      #  join (' -> ', (sort { $seen->{$b} <=> $seen->{$a} } (keys %$seen) ), $table, $dep )
      #);
      #delete $tables->{$table}{foreign_table_deps}{$dep};

      return {};
    }

    my $subdeps = _resolve_deps ($dep, $tables, \%seen);
    $ret->{$_} += $subdeps->{$_} for ( keys %$subdeps );

    ++$ret->{$dep};
  }

  return $ret;
}

1;

=head1 NAME

SQL::Translator::Parser::DBIx::Class - Create a SQL::Translator schema
from a DBIx::Class::Schema instance

=head1 SYNOPSIS

 ## Via DBIx::Class
 use MyApp::Schema;
 my $schema = MyApp::Schema->connect("dbi:SQLite:something.db");
 $schema->create_ddl_dir();
 ## or
 $schema->deploy();

 ## Standalone
 use MyApp::Schema;
 use SQL::Translator;

 my $schema = MyApp::Schema->connect;
 my $trans  = SQL::Translator->new (
      parser      => 'SQL::Translator::Parser::DBIx::Class',
      parser_args => { package => $schema },
      producer    => 'SQLite',
     ) or die SQL::Translator->error;
 my $out = $trans->translate() or die $trans->error;

=head1 DESCRIPTION

This class requires L<SQL::Translator> installed to work.

C<SQL::Translator::Parser::DBIx::Class> reads a DBIx::Class schema,
interrogates the columns, and stuffs it all in an $sqlt_schema object.

Its primary use is in deploying database layouts described as a set
of L<DBIx::Class> classes, to a database. To do this, see
L<DBIx::Class::Schema/deploy>.

This can also be achieved by having DBIx::Class export the schema as a
set of SQL files ready for import into your database, or passed to
other machines that need to have your application installed but don't
have SQL::Translator installed. To do this see
L<DBIx::Class::Schema/create_ddl_dir>.

=head1 SEE ALSO

L<SQL::Translator>, L<DBIx::Class::Schema>

=head1 AUTHORS

Jess Robinson

Matt S Trout

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