use warnings;
use Data::Dumper;
+use Carp::Clan qw/^SQL::Translator/;
use SQL::Translator::Schema::Constants;
-
-use base 'Class::Accessor::Fast';
-
-# Input/option accessors
-__PACKAGE__->mk_accessors(qw/
- ignore_index_names ignore_constraint_names ignore_view_sql
- ignore_proc_sql output_db source_schema source_db target_schema target_db
- case_insensitive no_batch_alters ignore_missing_methods producer_options
-/);
+use Sub::Quote qw(quote_sub);
+use Moo;
+
+has ignore_index_names => (
+ is => 'rw',
+);
+has ignore_constraint_names => (
+ is => 'rw',
+);
+has ignore_view_sql => (
+ is => 'rw',
+);
+has ignore_proc_sql => (
+ is => 'rw',
+);
+has output_db => (
+ is => 'rw',
+);
+has source_schema => (
+ is => 'rw',
+);
+has target_schema => (
+ is => 'rw',
+);
+has case_insensitive => (
+ is => 'rw',
+);
+has no_batch_alters => (
+ is => 'rw',
+);
+has ignore_missing_methods => (
+ is => 'rw',
+);
+has producer_args => (
+ is => 'rw',
+ lazy => 1,
+ default => quote_sub '{}',
+);
+has tables_to_drop => (
+ is => 'rw',
+ lazy => 1,
+ default => quote_sub '[]',
+);
+has tables_to_create => (
+ is => 'rw',
+ lazy => 1,
+ default => quote_sub '[]',
+);
+has table_diff_hash => (
+ is => 'rw',
+ lazy => 1,
+ default => quote_sub '{}',
+);
my @diff_arrays = qw/
tables_to_drop
table_renamed_from
/;
-__PACKAGE__->mk_accessors(@diff_arrays, 'table_diff_hash');
-
sub schema_diff {
# use Data::Dumper;
## we are getting instructions on how to turn the source into the target
## _db is the name of the producer/db it came out of/into
## results are formatted to the source preferences
- my ($source_schema, $source_db, $target_schema, $target_db, $options) = @_;
+ my ($source_schema, $source_db, $target_schema, $output_db, $options) = @_;
$options ||= {};
my $obj = SQL::Translator::Diff->new( {
%$options,
source_schema => $source_schema,
- source_db => $source_db,
target_schema => $target_schema,
- target_db => $target_db
+ output_db => $output_db
} );
$obj->compute_differences->produce_diff_sql;
}
-sub new {
- my ($class, $values) = @_;
- $values->{$_} ||= [] foreach @diff_arrays;
- $values->{table_diff_hash} = {};
+sub BUILD {
+ my ($self, $args) = @_;
+ if ($args->{producer_options}) {
+ carp 'producer_options is deprecated. Please use producer_args';
+ $self->producer_args({
+ %{$args->{producer_options}},
+ %{$self->producer_args}
+ });
+ }
- $values->{producer_options} ||= {};
- $values->{output_db} ||= $values->{source_db};
- return $class->SUPER::new($values);
+ if (! $self->output_db) {
+ $self->output_db($args->{source_db})
+ }
}
sub compute_differences {
$self->table_diff_hash->{$tar_table_name}{table_renamed_from} = [ [$src_table, $tar_table] ];
} else {
delete $tar_table->extra->{renamed_from};
- warn qq#Renamed table can't find old table "$old_name" for renamed table\n#;
+ carp qq#Renamed table can't find old table "$old_name" for renamed table\n#;
}
} else {
$src_table = $source_schema->get_table( $tar_table_name, $self->case_insensitive );
unless ( $src_table ) {
## table is new
- ## add table(s) later.
+ ## add table(s) later.
push @{$self->tables_to_create}, $tar_table;
next;
}
table_renamed_from => 'rename_table',
);
my @diffs;
-
- if (!$self->no_batch_alters &&
- (my $batch_alter = $producer_class->can('batch_alter_table')) )
+
+ if (!$self->no_batch_alters &&
+ (my $batch_alter = $producer_class->can('batch_alter_table')) )
{
# Good - Producer supports batch altering of tables.
foreach my $table ( sort keys %{$self->table_diff_hash} ) {
push @diffs, $batch_alter->($tar_table,
{ map {
$func_map{$_} => $self->table_diff_hash->{$table}{$_}
- } keys %func_map
- },
- $self->producer_options
+ } keys %func_map
+ },
+ $self->producer_args
);
}
} else {
push @diffs, map( {
if (@{ $flattened_diffs{$_} || [] }) {
my $meth = $producer_class->can($_);
-
- $meth ? map {
- my $sql = $meth->( (ref $_ eq 'ARRAY' ? @$_ : $_), $self->producer_options );
- $sql ? ("$sql;") : ();
+
+ $meth ? map {
+ map { $_ ? "$_" : () } $meth->( (ref $_ eq 'ARRAY' ? @$_ : $_), $self->producer_args );
} @{ $flattened_diffs{$_} }
: $self->ignore_missing_methods
? "-- $producer_class cant $_"
}
if (my @tables = @{ $self->tables_to_create } ) {
- my $translator = new SQL::Translator(
+ my $translator = SQL::Translator->new(
producer_type => $self->output_db,
add_drop_table => 0,
no_comments => 1,
# TODO: sort out options
- %{ $self->producer_options }
+ %{ $self->producer_args }
);
+ $translator->producer_args->{no_transaction} = 1;
my $schema = $translator->schema;
$schema->add_table($_) for @tables;
- unshift @diffs,
+ unshift @diffs,
# Remove begin/commit here, since we wrap everything in one.
- grep { $_ !~ /^(?:COMMIT|START(?: TRANSACTION)?|BEGIN(?: TRANSACTION)?);/ } $producer_class->can('produce')->($translator);
+ grep { $_ !~ /^(?:COMMIT|START(?: TRANSACTION)?|BEGIN(?: TRANSACTION)?)/ } $producer_class->can('produce')->($translator);
}
if (my @tables_to_drop = @{ $self->{tables_to_drop} || []} ) {
my $meth = $producer_class->can('drop_table');
-
- push @diffs, $meth ? map( { $meth->($_, $self->producer_options) } @tables_to_drop )
+
+ push @diffs, $meth ? ( map { $meth->($_, $self->producer_args) } @tables_to_drop)
: $self->ignore_missing_methods
? "-- $producer_class cant drop_table"
: die "$producer_class cant drop_table";
}
if (@diffs) {
- unshift @diffs, "BEGIN;\n";
- push @diffs, "\nCOMMIT;\n";
+ unshift @diffs, "BEGIN";
+ push @diffs, "\nCOMMIT";
} else {
- @diffs = ("-- No differences found\n\n");
+ @diffs = ("-- No differences found");
}
if ( @diffs ) {
- if ( $self->target_db !~ /^(?:MySQL|SQLite)$/ ) {
- unshift(@diffs, "-- Target database @{[$self->target_db]} is untested/unsupported!!!");
+ if ( $self->output_db !~ /^(?:MySQL|SQLite|PostgreSQL)$/ ) {
+ unshift(@diffs, "-- Output database @{[$self->output_db]} is untested/unsupported!!!");
}
- return join( "\n", "-- Convert schema '$src_name' to '$tar_name':\n", @diffs);
+
+ my @return =
+ map { $_ ? ( $_ =~ /;\s*\z/xms ? $_ : "$_;\n\n" ) : "\n" }
+ ("-- Convert schema '$src_name' to '$tar_name':", @diffs);
+
+ return wantarray ? @return : join('', @return);
}
return undef;
sub diff_table_fields {
my ($self, $src_table, $tar_table) = @_;
- # List of ones ew've renamed from so we dont drop them
+ # List of ones we've renamed from so we don't drop them
my %renamed_source_fields;
for my $tar_table_field ( $tar_table->get_fields ) {
if (my $old_name = $tar_table_field->extra->{renamed_from}) {
my $src_table_field = $src_table->get_field( $old_name, $self->case_insensitive );
unless ($src_table_field) {
- warn qq#Renamed column can't find old column "@{[$src_table->name]}.$old_name" for renamed column\n#;
+ carp qq#Renamed column can't find old column "@{[$src_table->name]}.$old_name" for renamed column\n#;
delete $tar_table_field->extra->{renamed_from};
} else {
push @{$self->table_diff_hash->{$tar_table}{fields_to_rename} }, [ $src_table_field, $tar_table_field ];
next;
}
- # field exists, something changed. This is a bit complex. Parsers can
+ # field exists, something changed. This is a bit complex. Parsers can
# normalize types, but only some of them do, so compare the normalized and
# parsed types for each field to each other
if ( !$tar_table_field->equals($src_table_field, $self->case_insensitive) &&
- !$tar_table_field->equals($src_table_field->parsed_field, $self->case_insensitive) &&
- !$tar_table_field->parsed_field->equals($src_table_field, $self->case_insensitive) &&
+ !$tar_table_field->equals($src_table_field->parsed_field, $self->case_insensitive) &&
+ !$tar_table_field->parsed_field->equals($src_table_field, $self->case_insensitive) &&
!$tar_table_field->parsed_field->equals($src_table_field->parsed_field, $self->case_insensitive) ) {
# Some producers might need src field to diff against
sub diff_table_options {
my ($self, $src_table, $tar_table) = @_;
+ my $cmp = sub {
+ my ($a_name, undef, $b_name, undef) = ( %$a, %$b );
+ $a_name cmp $b_name;
+ };
+ # Need to sort the options so we don't get spurious diffs.
+ my (@src_opts, @tar_opts);
+ @src_opts = sort $cmp $src_table->options;
+ @tar_opts = sort $cmp $tar_table->options;
+
# If there's a difference, just re-set all the options
push @{ $self->table_diff_hash->{$tar_table}{table_options} }, $tar_table
- unless $src_table->_compare_objects( scalar $src_table->options, scalar $tar_table->options );
+ unless $src_table->_compare_objects( \@src_opts, \@tar_opts );
+}
+
+# support producer_options as an alias for producer_args for legacy code.
+sub producer_options {
+ my $self = shift;
+
+ return $self->producer_args( @_ );
}
1;
=head1 NAME
-SQL::Translator::Diff
+SQL::Translator::Diff - determine differences between two schemas
=head1 DESCRIPTION
-Takes two input SQL::Translator::Schemas (or SQL files) and produces ALTER
-statments to make them the same
+Takes two input SQL::Translator::Schemas (or SQL files) and produces ALTER
+statements to make them the same
=head1 SNYOPSIS
If the diff would need a method that is missing from the producer, just emit a
comment showing the method is missing, rather than dieing with an error
+=item B<producer_args>
+
+Hash of extra arguments passed to L<SQL::Translator/new> and the below
+L</PRODUCER FUNCTIONS>.
+
=back
=head1 PRODUCER FUNCTIONS
The following producer functions should be implemented for completeness. If
-any of them are needed for a given diff, but not found, an error will be
+any of them are needed for a given diff, but not found, an error will be
thrown.
=over
-=item * C<alter_create_constraint($con)>
+=item * C<alter_create_constraint($con, $args)>
-=item * C<alter_drop_constraint($con)>
+=item * C<alter_drop_constraint($con, $args)>
-=item * C<alter_create_index($idx)>
+=item * C<alter_create_index($idx, $args)>
-=item * C<alter_drop_index($idx)>
+=item * C<alter_drop_index($idx, $args)>
-=item * C<add_field($fld)>
+=item * C<add_field($fld, $args)>
-=item * C<alter_field($old_fld, $new_fld)>
+=item * C<alter_field($old_fld, $new_fld, $args)>
-=item * C<rename_field($old_fld, $new_fld)>
+=item * C<rename_field($old_fld, $new_fld, $args)>
-=item * C<drop_field($fld)>
+=item * C<drop_field($fld, $args)>
-=item * C<alter_table($table)>
+=item * C<alter_table($table, $args)>
-=item * C<drop_table($table)>
+=item * C<drop_table($table, $args)>
-=item * C<rename_table($old_table, $new_table)> (optional)
+=item * C<rename_table($old_table, $new_table, $args)> (optional)
-=item * C<batch_alter_table($table, $hash)> (optional)
+=item * C<batch_alter_table($table, $hash, $args)> (optional)
-If the producer supports C<batch_alter_table>, it will be called with the
+If the producer supports C<batch_alter_table>, it will be called with the
table to alter and a hash, the keys of which will be the method names listed
-above; values will be arrays of fields or constraints to operate on. In the
-case of the field functions that take two arguments this will appear as a hash.
+above; values will be arrays of fields or constraints to operate on. In the
+case of the field functions that take two arguments this will appear as an
+array reference.
I.e. the hash might look something like the following:
C<preprocess_schema> is called by the Diff code to allow the producer to
normalize any data it needs to first. For example, the MySQL producer uses
-this method to ensure that FK contraint names are unique.
+this method to ensure that FK constraint names are unique.
Basicaly any changes that need to be made to produce the SQL file for the
schema should be done here, so that a diff between a parsed SQL file and (say)
a parsed DBIx::Class::Schema object will be sane.
-(As an aside, DBIx::Class, for instance, uses the presence of a
+(As an aside, DBIx::Class, for instance, uses the presence of a
C<preprocess_schema> function on the producer to know that it can diff between
the previous SQL file and its own internal representation. Without this method
-on th producer it will diff the two SQL files which is slower, but known to
+on th producer it will diff the two SQL files which is slower, but known to
work better on old-style producers.)
=back
projects / dbsrgits/SQL-Translator.git / blobdiff