1 package DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator;
5 use Carp qw( carp croak );
7 use Method::Signatures::Simple;
11 require SQL::Translator::Diff;
13 require DBIx::Class::Storage; # loaded for type constraint
14 use DBIx::Class::DeploymentHandler::Types;
16 use File::Path 'mkpath';
17 use File::Spec::Functions;
19 with 'DBIx::Class::DeploymentHandler::HandlesDeploy';
22 isa => 'DBIx::Class::Schema',
25 handles => [qw( schema_version )],
29 isa => 'DBIx::Class::Storage',
34 method _build_storage {
35 my $s = $self->schema->storage;
36 $s->_determine_driver;
43 default => sub { {} },
45 has upgrade_directory => (
54 isa => 'DBIx::Class::DeploymentHandler::Databases',
56 default => sub { [qw( MySQL SQLite PostgreSQL )] },
60 isa => 'ArrayRef[Str]',
62 default => sub { [] },
71 method __ddl_consume_with_prefix($type, $versions, $prefix) {
72 my $base_dir = $self->upgrade_directory;
74 my $main = catfile( $base_dir, $type );
75 my $generic = catfile( $base_dir, '_generic' );
77 catfile( $base_dir, '_common', $prefix, join q(-), @{$versions} );
81 $dir = catfile($main, $prefix, join q(-), @{$versions})
82 } elsif (-d $generic) {
83 $dir = catfile($generic, $prefix, join q(-), @{$versions});
85 croak "neither $main or $generic exist; please write/generate some SQL";
88 opendir my($dh), $dir;
89 my %files = map { $_ => "$dir/$_" } grep { /\.sql$/ && -f "$dir/$_" } readdir $dh;
93 opendir my($dh), $common;
94 for my $filename (grep { /\.sql$/ && -f catfile($common,$_) } readdir $dh) {
95 unless ($files{$filename}) {
96 $files{$filename} = catfile($common,$filename);
102 return [@files{sort keys %files}]
105 method _ddl_schema_consume_filenames($type, $version) {
106 $self->__ddl_consume_with_prefix($type, [ $version ], 'schema')
109 method _ddl_schema_produce_filename($type, $version) {
110 my $dirname = catfile( $self->upgrade_directory, $type, 'schema', $version );
111 mkpath($dirname) unless -d $dirname;
113 return catfile( $dirname, '001-auto.sql' );
116 method _ddl_schema_up_consume_filenames($type, $versions) {
117 $self->__ddl_consume_with_prefix($type, $versions, 'up')
120 method _ddl_schema_down_consume_filenames($type, $versions) {
121 $self->__ddl_consume_with_prefix($type, $versions, 'down')
124 method _ddl_schema_up_produce_filename($type, $versions) {
125 my $dir = $self->upgrade_directory;
127 my $dirname = catfile( $dir, $type, 'up', join q(-), @{$versions});
128 mkpath($dirname) unless -d $dirname;
130 return catfile( $dirname, '001-auto.sql'
134 method _ddl_schema_down_produce_filename($type, $versions, $dir) {
135 my $dirname = catfile( $dir, $type, 'down', join q(-), @{$versions} );
136 mkpath($dirname) unless -d $dirname;
138 return catfile( $dirname, '001-auto.sql');
143 my $storage = $self->storage;
145 my $guard = $self->schema->txn_scope_guard if $self->txn_wrap;
147 my @sql = map @{$self->_read_sql_file($_)}, @{$self->_ddl_schema_consume_filenames(
148 $self->storage->sqlt_type,
149 $self->schema_version
152 foreach my $line (@sql) {
153 $storage->_query_start($line);
155 # do a dbh_do cycle here, as we need some error checking in
156 # place (even though we will ignore errors)
157 $storage->dbh_do (sub { $_[1]->do($line) });
160 carp "$_ (running '${line}')"
162 $storage->_query_end($line);
165 $guard->commit if $self->txn_wrap;
166 return join "\n", @sql;
169 sub prepare_install {
171 my $schema = $self->schema;
172 my $databases = $self->databases;
173 my $dir = $self->upgrade_directory;
174 my $sqltargs = $self->sqltargs;
175 my $version = $schema->schema_version;
177 my $sqlt = SQL::Translator->new({
179 ignore_constraint_names => 1,
180 ignore_index_names => 1,
181 parser => 'SQL::Translator::Parser::DBIx::Class',
185 my $sqlt_schema = $sqlt->translate( data => $schema )
186 or $self->throw_exception($sqlt->error);
188 foreach my $db (@$databases) {
190 $sqlt->{schema} = $sqlt_schema;
191 $sqlt->producer($db);
193 my $filename = $self->_ddl_schema_produce_filename($db, $version, $dir);
195 carp "Overwriting existing DDL file - $filename";
199 my $output = $sqlt->translate;
201 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
205 unless( open $file, q(>), $filename ) {
206 $self->throw_exception("Can't open $filename for writing ($!)");
209 print {$file} $output;
214 sub prepare_upgrade {
215 my ($self, $from_version, $to_version, $version_set) = @_;
217 $from_version ||= '1.0'; #$self->database_version;
218 $to_version ||= $self->schema_version;
220 # for updates prepared automatically (rob's stuff)
221 # one would want to explicitly set $version_set to
223 $version_set ||= [$from_version, $to_version];
225 $self->_prepare_changegrade($from_version, $to_version, $version_set, 'up');
228 sub prepare_downgrade {
229 my ($self, $from_version, $to_version, $version_set) = @_;
231 $from_version ||= $self->db_version;
232 $to_version ||= $self->schema_version;
234 # for updates prepared automatically (rob's stuff)
235 # one would want to explicitly set $version_set to
237 $version_set ||= [$from_version, $to_version];
239 $self->_prepare_changegrade($from_version, $to_version, $version_set, 'down');
242 method _prepare_changegrade($from_version, $to_version, $version_set, $direction) {
243 my $schema = $self->schema;
244 my $databases = $self->databases;
245 my $dir = $self->upgrade_directory;
246 my $sqltargs = $self->sqltargs;
248 my $schema_version = $schema->schema_version;
252 ignore_constraint_names => 1,
253 ignore_index_names => 1,
257 my $sqlt = SQL::Translator->new( $sqltargs );
259 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
260 my $sqlt_schema = $sqlt->translate( data => $schema )
261 or $self->throw_exception ($sqlt->error);
263 foreach my $db (@$databases) {
265 $sqlt->{schema} = $sqlt_schema;
266 $sqlt->producer($db);
268 my $prefilename = $self->_ddl_schema_produce_filename($db, $from_version, $dir);
269 unless(-e $prefilename) {
270 carp("No previous schema file found ($prefilename)");
273 my $diff_file_method = "_ddl_schema_${direction}_produce_filename";
274 my $diff_file = $self->$diff_file_method($db, $version_set, $dir );
276 carp("Overwriting existing $direction-diff file - $diff_file");
282 my $t = SQL::Translator->new({
288 $t->parser( $db ) # could this really throw an exception?
289 or $self->throw_exception ($t->error);
291 my $out = $t->translate( $prefilename )
292 or $self->throw_exception ($t->error);
294 $source_schema = $t->schema;
296 $source_schema->name( $prefilename )
297 unless $source_schema->name;
300 # The "new" style of producers have sane normalization and can support
301 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
302 # And we have to diff parsed SQL against parsed SQL.
303 my $dest_schema = $sqlt_schema;
305 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
306 my $t = SQL::Translator->new({
312 $t->parser( $db ) # could this really throw an exception?
313 or $self->throw_exception ($t->error);
315 my $filename = $self->_ddl_schema_produce_filename($db, $to_version, $dir);
316 my $out = $t->translate( $filename )
317 or $self->throw_exception ($t->error);
319 $dest_schema = $t->schema;
321 $dest_schema->name( $filename )
322 unless $dest_schema->name;
325 my $diff = SQL::Translator::Diff::schema_diff(
331 unless(open $file, q(>), $diff_file) {
332 $self->throw_exception("Can't write to $diff_file ($!)");
340 method _read_sql_file($file) {
343 open my $fh, '<', $file;
344 my @data = split /;\n/, join '', <$fh>;
348 $_ && # remove blank lines
349 !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/ # strip txn's
351 s/^\s+//; s/\s+$//; # trim whitespace
352 join '', grep { !/^--/ } split /\n/ # remove comments
358 sub _downgrade_single_step {
360 my @version_set = @{ shift @_ };
361 my @downgrade_files = @{$self->_ddl_schema_down_consume_filenames(
362 $self->storage->sqlt_type,
366 for my $downgrade_file (@downgrade_files) {
367 $self->_filedata($self->_read_sql_file($downgrade_file)); # I don't like this --fREW 2010-02-22
369 my $guard = $self->schema->txn_scope_guard if $self->txn_wrap;
371 $guard->commit if $self->txn_wrap;
375 sub _upgrade_single_step {
377 my @version_set = @{ shift @_ };
378 my @upgrade_files = @{$self->_ddl_schema_up_consume_filenames(
379 $self->storage->sqlt_type,
383 for my $upgrade_file (@upgrade_files) {
384 $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22
385 my $guard = $self->schema->txn_scope_guard if $self->txn_wrap;
387 $guard->commit if $self->txn_wrap;
391 method _do_upgrade { $self->_run_upgrade(qr/.*?/) }
393 method _run_upgrade($stm) {
394 my @statements = grep { $_ =~ $stm } @{$self->_filedata};
397 $self->storage->debugobj->query_start($_) if $self->storage->debug;
398 $self->_apply_statement($_);
399 $self->storage->debugobj->query_end($_) if $self->storage->debug;
403 method _apply_statement($statement) {
405 $self->storage->dbh->do($_) or carp "SQL was: $_"
408 __PACKAGE__->meta->make_immutable;
414 vim: ts=2 sw=2 expandtab