-package # hide from PAUSE
- SQL::Translator::Parser::DBIx::Class;
+package SQL::Translator::Parser::DBIx::Class;
# AUTHOR: Jess Robinson
use strict;
use warnings;
-use vars qw($DEBUG @EXPORT_OK);
+use vars qw($DEBUG $VERSION @EXPORT_OK);
+$VERSION = '1.10';
$DEBUG = 0 unless defined $DEBUG;
use Exporter;
-use Data::Dumper;
-use Digest::SHA1 qw( sha1_hex );
use SQL::Translator::Utils qw(debug normalize_name);
use base qw(Exporter);
# -------------------------------------------------------------------
# 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.
# -------------------------------------------------------------------
my $schema = $tr->schema;
my $table_no = 0;
- $schema->name( ref($dbicschema) . " v" . ($dbicschema->VERSION || '1.x'))
+ $schema->name( ref($dbicschema) . " v" . ($dbicschema->schema_version || '1.x'))
unless ($schema->name);
my %seen_tables;
}
- foreach my $moniker (sort @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);
+ }
+ }
+
+ 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 @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)) {
+ if (!$source->_compare_relationship_keys($unique_constraints{$uniq}, \@primary)) {
$table->add_constraint(
type => 'unique',
- name => _create_unique_symbol($uniq),
+ 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 $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 @cond = keys(%{$rel_info->{cond}});
my @refkeys = map {/^\w+\.(\w+)$/} @cond;
-
- # Force the order of the referenced fields to be the same as
- # ->add_columns method.
- my $idx;
- my %other_columns_idx = map {$_ => ++$idx } $othertable->columns;
- @refkeys = sort { $other_columns_idx{$a} cmp $other_columns_idx{$b} } @refkeys;
-
my @keys = map {$rel_info->{cond}->{$_} =~ /^\w+\.(\w+)$/} @cond;
- if($rel_table)
- {
- my $reverse_rels = $source->reverse_relationship_info($rel);
- my ($otherrelname, $otherrelationship) = each %{$reverse_rels};
+ # determine if this relationship is a self.fk => foreign.pk (i.e. belongs_to)
+ my $fk_constraint;
- my $on_delete = '';
- my $on_update = '';
+ #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);
+ }
- if (defined $otherrelationship) {
- $on_delete = $otherrelationship->{'attrs'}->{cascade_delete} ? 'CASCADE' : '';
- $on_update = $otherrelationship->{'attrs'}->{cascade_copy} ? 'CASCADE' : '';
+ 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';
}
+ }
- my $is_deferrable = $rel_info->{attrs}{is_deferrable};
+ 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;
- #Decide if this is a foreign key based on whether the self
- #items are our primary columns.
-
- # If the sets are different, then we assume it's a foreign key from
- # us to another table.
- # OR: If is_foreign_key_constraint attr is explicity set (or set to false) on the relation
- next if ( exists $created_FK_rels{$rel_table}->{$key_test} );
- if ( exists $rel_info->{attrs}{is_foreign_key_constraint}) {
- # not is this attr set to 0 but definitely if set to 1
- next unless ($rel_info->{attrs}{is_foreign_key_constraint});
- } else {
- # not if might have
- # next if ($rel_info->{attrs}{accessor} eq 'single' && exists $rel_info->{attrs}{join_type} && uc($rel_info->{attrs}{join_type}) eq 'LEFT');
- # not sure about this one
- next if $source->compare_relationship_keys(\@keys, \@primary);
- }
$created_FK_rels{$rel_table}->{$key_test} = 1;
if (scalar(@keys)) {
$table->add_constraint(
type => 'foreign_key',
- name => _create_unique_symbol($table->name
- . '_fk_'
- . join('_', @keys)),
+ name => join('_', $table->name, 'fk', @keys),
fields => \@keys,
reference_fields => \@refkeys,
reference_table => $rel_table,
- on_delete => $on_delete,
- on_update => $on_update,
+ on_delete => uc ($cascade->{delete} || ''),
+ on_update => uc ($cascade->{update} || ''),
(defined $is_deferrable ? ( deferrable => $is_deferrable ) : ()),
);
- my $index = $table->add_index(
- name => _create_unique_symbol(join('_', @keys)),
- fields => \@keys,
- type => 'NORMAL',
- );
- }
+ 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($table);
+ $source->result_class->sqlt_deploy_hook($view);
}
+
+ $source->_invoke_sqlt_deploy_hook($view);
}
if ($dbicschema->can('sqlt_deploy_hook')) {
return 1;
}
-# TODO - is there a reasonable way to pass configuration?
-# Default of 64 comes from mysql's limit.
-our $MAX_SYMBOL_LENGTH ||= 64;
-our $COLLISION_TAG_LENGTH ||= 8;
+1;
-# -------------------------------------------------------------------
-# $resolved_name = _create_unique_symbol($desired_name)
-#
-# If desired_name is really long, it will be truncated in a way that
-# has a high probability of leaving it unique.
-# -------------------------------------------------------------------
-sub _create_unique_symbol {
- my $desired_name = shift;
- return $desired_name if length $desired_name <= $MAX_SYMBOL_LENGTH;
+=head1 NAME
- my $truncated_name = substr $desired_name, 0, $MAX_SYMBOL_LENGTH - $COLLISION_TAG_LENGTH - 1;
+SQL::Translator::Parser::DBIx::Class - Create a SQL::Translator schema
+from a DBIx::Class::Schema instance
- # Hex isn't the most space-efficient, but it skirts around allowed
- # charset issues
- my $digest = sha1_hex($desired_name);
- my $collision_tag = substr $digest, 0, $COLLISION_TAG_LENGTH;
+=head1 SYNOPSIS
- return $truncated_name
- . '_'
- . $collision_tag;
-}
+ ## Via DBIx::Class
+ use MyApp::Schema;
+ my $schema = MyApp::Schema->connect("dbi:SQLite:something.db");
+ $schema->create_ddl_dir();
+ ## or
+ $schema->deploy();
-1;
+ ## 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
+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
projects / dbsrgits/DBIx-Class.git / blobdiff