[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 Data::Dumper;
use SQL::Translator::Utils qw(debug normalize_name);

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'};
    
    die 'No DBIx::Class::Schema' unless ($dbicschema);
    if (!ref $dbicschema) {
      eval "use $dbicschema;";
      die "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 %seen_tables;

    my @monikers = sort $dbicschema->sources;
    if ($limit_sources) {
        my $ref = ref $limit_sources || '';
        die "'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);
      next if $source->is_virtual;
       if ( $source->isa('DBIx::Class::ResultSource::Table') ) {
         push(@table_monikers, $moniker);
      } elsif( $source->isa('DBIx::Class::ResultSource::View') ){
         push(@view_monikers, $moniker);
      }
    }

    foreach my $moniker (sort @table_monikers)
    {
        my $source = $dbicschema->source($moniker);
        
        # Skip custom query sources
        next if ref($source->name);

        # Its possible to have multiple DBIC source using same table
        next if $seen_tables{$source->name}++;

        my $table = $schema->add_table(
                                       name => $source->name,
                                       type => 'TABLE',
                                       ) || die $schema->error;
        my $colcount = 0;
        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) || die $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;

            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 {
                        warn "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};

                my $is_deferrable = $rel_info->{attrs}{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;


                $created_FK_rels{$rel_table}->{$key_test} = 1;
                if (scalar(@keys)) {
                  $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 ) : ()),
                  );
                    
                  if ($add_fk_index_rel) {
                      my $index = $table->add_index(
                                                    name   => join('_', $table->name, 'idx', @keys),
                                                    fields => \@keys,
                                                    type   => 'NORMAL',
                                                    );
                  }
              }
            }
        }
		
        $source->_invoke_sqlt_deploy_hook($table);
    }

    foreach my $moniker (sort @view_monikers)
    {
        my $source = $dbicschema->source($moniker);
        # Skip custom query sources
        next if ref($source->name);

        # Its possible to have multiple DBIC source using same table
        next if $seen_tables{$source->name}++;

        my $view = $schema->add_view(
          name => $source->name,
          fields => [ $source->columns ],
          $source->view_definition ? ( 'sql' => $source->view_definition ) : ()
        );
        if ($source->result_class->can('sqlt_deploy_hook')) {
          $source->result_class->sqlt_deploy_hook($view);
        }
    }

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

    return 1;
}

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.

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

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 the
L<DBIx::Class::Schema/create_ddl_dir> method.

=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
	15	use Exporter;
	16	use Data::Dumper;
	17	use SQL::Translator::Utils qw(debug normalize_name);
	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'};
b02b20b5	38
b7e303a8	39	die 'No DBIx::Class::Schema' unless ($dbicschema);
	40	if (!ref $dbicschema) {
	41	eval "use $dbicschema;";
	42	die "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
	51	my %seen_tables;
	52
b7e303a8	53	my @monikers = sort $dbicschema->sources;
499adf63	54	if ($limit_sources) {
499adf63	55	my $ref = ref $limit_sources \|\| '';
5bdf1b3d	56	die "'sources' parameter must be an array or hash ref" unless $ref eq 'ARRAY' \|\| ref eq 'HASH';
499adf63	57
	58	# limit monikers to those specified in
	59	my $sources;
	60	if ($ref eq 'ARRAY') {
	61	$sources->{$_} = 1 for (@$limit_sources);
	62	} else {
	63	$sources = $limit_sources;
	64	}
	65	@monikers = grep { $sources->{$_} } @monikers;
	66	}
	67
	68
1d521afd	69	my(@table_monikers, @view_monikers);
	70	for my $moniker (@monikers){
	71	my $source = $dbicschema->source($moniker);
9774f48b	72	next if $source->is_virtual;
5f5e87cf	73	if ( $source->isa('DBIx::Class::ResultSource::Table') ) {
1d521afd	74	push(@table_monikers, $moniker);
5f5e87cf	75	} elsif( $source->isa('DBIx::Class::ResultSource::View') ){
1d521afd	76	push(@view_monikers, $moniker);
	77	}
	78	}
499adf63	79
1d521afd	80	foreach my $moniker (sort @table_monikers)
b02b20b5	81	{
b7e303a8	82	my $source = $dbicschema->source($moniker);
90c11f68	83
	84	# Skip custom query sources
	85	next if ref($source->name);
b02b20b5	86
b7e303a8	87	# Its possible to have multiple DBIC source using same table
38e48163	88	next if $seen_tables{$source->name}++;
38e48163	89
b02b20b5	90	my $table = $schema->add_table(
	91	name => $source->name,
	92	type => 'TABLE',
	93	) \|\| die $schema->error;
	94	my $colcount = 0;
	95	foreach my $col ($source->columns)
	96	{
d6c79cb3	97	# assuming column_info in dbic is the same as DBI (?)
b02b20b5	98	# data_type is a number, column_type is text?
	99	my %colinfo = (
	100	name => $col,
b02b20b5	101	size => 0,
	102	is_auto_increment => 0,
	103	is_foreign_key => 0,
	104	is_nullable => 0,
	105	%{$source->column_info($col)}
	106	);
0009fa49	107	if ($colinfo{is_nullable}) {
	108	$colinfo{default} = '' unless exists $colinfo{default};
	109	}
b02b20b5	110	my $f = $table->add_field(%colinfo) \|\| die $table->error;
	111	}
	112	$table->primary_key($source->primary_columns);
	113
7b90bb13	114	my @primary = $source->primary_columns;
7b90bb13	115	my %unique_constraints = $source->unique_constraints;
b7e303a8	116	foreach my $uniq (sort keys %unique_constraints) {
de60a93d	117	if (!$source->compare_relationship_keys($unique_constraints{$uniq}, \@primary)) {
7b90bb13	118	$table->add_constraint(
7b90bb13	119	type => 'unique',
a7e65bb5	120	name => $uniq,
7b90bb13	121	fields => $unique_constraints{$uniq}
	122	);
	123	}
	124	}
	125
b02b20b5	126	my @rels = $source->relationships();
499adf63	127
499adf63	128	my %created_FK_rels;
2581038c	129
	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;
499adf63	132
454a5a42	133	foreach my $rel (sort @rels)
b02b20b5	134	{
b02b20b5	135	my $rel_info = $source->relationship_info($rel);
637ca936	136
637ca936	137	# Ignore any rel cond that isn't a straight hash
	138	next unless ref $rel_info->{cond} eq 'HASH';
	139
de60a93d	140	my $othertable = $source->related_source($rel);
	141	my $rel_table = $othertable->name;
	142
e377d723	143	my $reverse_rels = $source->reverse_relationship_info($rel);
	144	my ($otherrelname, $otherrelationship) = each %{$reverse_rels};
	145
d1b264d3	146	# Force the order of @cond to match the order of ->add_columns
	147	my $idx;
	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}});
	150
637ca936	151	# Get the key information, mapping off the foreign/self markers
637ca936	152	my @refkeys = map {/^\w+\.(\w+)$/} @cond;
	153	my @keys = map {$rel_info->{cond}->{$_} =~ /^\w+\.(\w+)$/} @cond;
	154
e377d723	155	# determine if this relationship is a self.fk => foreign.pk (i.e. belongs_to)
e377d723	156	my $fk_constraint;
de60a93d	157
e377d723	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};
	161	}
	162	# it can not be multi
069e49b6	163	elsif ( $rel_info->{attrs}{accessor}
069e49b6	164	&& $rel_info->{attrs}{accessor} eq 'multi' ) {
e377d723	165	$fk_constraint = 0;
	166	}
	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!!?? :)
	170	else {
	171	$fk_constraint = not $source->compare_relationship_keys(\@keys, \@primary);
	172	}
de60a93d	173
e377d723	174	my $cascade;
	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"};
	179	}
	180	else {
	181	warn "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";
	183	}
	184	}
	185	elsif (defined $otherrelationship and $otherrelationship->{attrs}{$c eq 'update' ? 'cascade_copy' : 'cascade_delete'}) {
	186	$cascade->{$c} = 'CASCADE';
de60a93d	187	}
e377d723	188	}
	189
	190	if($rel_table)
	191	{
	192	# Constraints are added only if applicable
	193	next unless $fk_constraint;
	194
	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};
de60a93d	198
45f1a484	199	my $is_deferrable = $rel_info->{attrs}{is_deferrable};
2581038c	200
	201	# global parser_args add_fk_index param can be overridden on the rel def
	202	my $add_fk_index_rel = (exists $rel_info->{attrs}{add_fk_index}) ? $rel_info->{attrs}{add_fk_index} : $add_fk_index;
13de943d	203
7b5d0b84	204
	205	$created_FK_rels{$rel_table}->{$key_test} = 1;
	206	if (scalar(@keys)) {
	207	$table->add_constraint(
0d865134	208	type => 'foreign_key',
a7e65bb5	209	name => join('_', $table->name, 'fk', @keys),
0d865134	210	fields => \@keys,
	211	reference_fields => \@refkeys,
	212	reference_table => $rel_table,
555b3385	213	on_delete => uc ($cascade->{delete} \|\| ''),
555b3385	214	on_update => uc ($cascade->{update} \|\| ''),
e394339b	215	(defined $is_deferrable ? ( deferrable => $is_deferrable ) : ()),
7b5d0b84	216	);
0d865134	217
2581038c	218	if ($add_fk_index_rel) {
0e2c6809	219	my $index = $table->add_index(
	220	name => join('_', $table->name, 'idx', @keys),
	221	fields => \@keys,
	222	type => 'NORMAL',
	223	);
	224	}
	225	}
b02b20b5	226	}
b02b20b5	227	}
0e2c6809	228
880c075b	229	$source->_invoke_sqlt_deploy_hook($table);
b02b20b5	230	}
d6c79cb3	231
1d521afd	232	foreach my $moniker (sort @view_monikers)
	233	{
	234	my $source = $dbicschema->source($moniker);
	235	# Skip custom query sources
	236	next if ref($source->name);
	237
	238	# Its possible to have multiple DBIC source using same table
	239	next if $seen_tables{$source->name}++;
	240
47344132	241	my $view = $schema->add_view(
1d521afd	242	name => $source->name,
1d521afd	243	fields => [ $source->columns ],
f534e33b	244	$source->view_definition ? ( 'sql' => $source->view_definition ) : ()
1d521afd	245	);
1d521afd	246	if ($source->result_class->can('sqlt_deploy_hook')) {
47344132	247	$source->result_class->sqlt_deploy_hook($view);
1d521afd	248	}
	249	}
	250
b7e303a8	251	if ($dbicschema->can('sqlt_deploy_hook')) {
b7e303a8	252	$dbicschema->sqlt_deploy_hook($schema);
d6c79cb3	253	}
d6c79cb3	254
637ca936	255	return 1;
75d07914	256	}
b02b20b5	257
0da8b7da	258	1;
7232ce07	259
	260	=head1 NAME
	261
	262	SQL::Translator::Parser::DBIx::Class - Create a SQL::Translator schema
	263	from a DBIx::Class::Schema instance
	264
	265	=head1 SYNOPSIS
	266
f26d4b95	267	## Via DBIx::Class
	268	use MyApp::Schema;
	269	my $schema = MyApp::Schema->connect("dbi:SQLite:something.db");
	270	$schema->create_ddl_dir();
	271	## or
	272	$schema->deploy();
	273
	274	## Standalone
7232ce07	275	use MyApp::Schema;
	276	use SQL::Translator;
	277
	278	my $schema = MyApp::Schema->connect;
	279	my $trans = SQL::Translator->new (
	280	parser => 'SQL::Translator::Parser::DBIx::Class',
	281	parser_args => { package => $schema },
	282	producer => 'SQLite',
	283	) or die SQL::Translator->error;
	284	my $out = $trans->translate() or die $trans->error;
	285
	286	=head1 DESCRIPTION
	287
f26d4b95	288	This class requires L<SQL::Translator> installed to work.
f26d4b95	289
7232ce07	290	C<SQL::Translator::Parser::DBIx::Class> reads a DBIx::Class schema,
	291	interrogates the columns, and stuffs it all in an $sqlt_schema object.
	292
f26d4b95	293	It's primary use is in deploying database layouts described as a set
	294	of L<DBIx::Class> classes, to a database. To do this, see the
	295	L<DBIx::Class::Schema/deploy> method.
	296
	297	This can also be achieved by having DBIx::Class export the schema as a
	298	set of SQL files ready for import into your database, or passed to
	299	other machines that need to have your application installed but don't
	300	have SQL::Translator installed. To do this see the
	301	L<DBIx::Class::Schema/create_ddl_dir> method.
	302
7232ce07	303	=head1 SEE ALSO
7232ce07	304
f26d4b95	305	L<SQL::Translator>, L<DBIx::Class::Schema>
7232ce07	306
	307	=head1 AUTHORS
	308
	309	Jess Robinson
	310
	311	Matt S Trout
	312
	313	Ash Berlin