1 package DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator;
3 use Method::Signatures::Simple;
6 require SQL::Translator::Diff;
7 require DBIx::Class::Storage; # loaded for type constraint
11 with 'DBIx::Class::DeploymentHandler::HandlesDeploy';
16 isa => 'DBIx::Class::Schema',
19 handles => [qw( schema_version )],
23 isa => 'DBIx::Class::Storage',
28 method _build_storage {
29 my $s = $self->schema->storage;
30 $s->_determine_driver;
37 default => sub { {} },
39 has upgrade_directory => (
48 isa => 'DBIx::Class::DeploymentHandler::Databases',
50 default => sub { [qw( MySQL SQLite PostgreSQL )] },
54 isa => 'ArrayRef[Str]',
58 method __ddl_consume_with_prefix($type, $versions, $prefix) {
59 my $base_dir = $self->upgrade_directory;
61 my $main = File::Spec->catfile( $base_dir, $type );
62 my $generic = File::Spec->catfile( $base_dir, '_generic' );
63 my $common = File::Spec->catfile( $base_dir, '_common', $prefix, join q(-), @{$versions} );
67 $dir = File::Spec->catfile($main, $prefix, join q(-), @{$versions})
68 } elsif (-d $generic) {
69 $dir = File::Spec->catfile($main, $prefix, join q(-), @{$versions})
74 opendir my($dh), $dir;
75 my %files = map { $_ => "$dir/$_" } grep { /\.sql$/ && -f "$dir/$_" } readdir($dh);
79 opendir my($dh), $common;
80 for my $filename (grep { /\.sql$/ && -f "$common/$_" } readdir($dh)) {
81 unless ($files{$filename}) {
82 $files{$filename} = "$common/$_";
88 return [@files{sort keys %files}]
91 method _ddl_schema_consume_filenames($type, $version) {
92 $self->__ddl_consume_with_prefix($type, [ $version ], 'schema')
95 method _ddl_schema_produce_filename($type, $version) {
96 my $base_dir = $self->upgrade_directory;
97 my $dirname = File::Spec->catfile(
98 $base_dir, $type, 'schema', $version
100 File::Path::mkpath($dirname) unless -d $dirname;
102 return File::Spec->catfile(
103 $dirname, '001-auto.sql'
107 method _ddl_schema_up_consume_filenames($type, $versions) {
108 $self->__ddl_consume_with_prefix($type, $versions, 'up')
111 method _ddl_schema_down_consume_filenames($type, $versions) {
112 $self->__ddl_consume_with_prefix($type, $versions, 'down')
115 method _ddl_schema_up_produce_filename($type, $versions) {
116 my $dir = $self->upgrade_directory;
118 my $dirname = File::Spec->catfile(
119 $dir, $type, 'up', join( q(-), @{$versions} )
121 File::Path::mkpath($dirname) unless -d $dirname;
123 return File::Spec->catfile(
124 $dirname, '001-auto.sql'
128 method _ddl_schema_down_produce_filename($type, $versions, $dir) {
129 my $dirname = File::Spec->catfile(
130 $dir, $type, 'down', join( q(-), @{$versions} )
132 File::Path::mkpath($dirname) unless -d $dirname;
134 return File::Spec->catfile(
135 $dirname, '001-auto.sql'
139 method _deployment_statements {
140 my $dir = $self->upgrade_directory;
141 my $schema = $self->schema;
142 my $type = $self->storage->sqlt_type;
143 my $sqltargs = $self->sqltargs;
144 my $version = $self->schema_version;
146 my @filenames = @{$self->_ddl_schema_consume_filenames($type, $version)};
148 for my $filename (@filenames) {
151 open $file, q(<), $filename
152 or carp "Can't open $filename ($!)";
155 return join '', @rows;
159 # sources needs to be a parser arg, but for simplicty allow at top level
161 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
162 if exists $sqltargs->{sources};
164 my $tr = SQL::Translator->new(
165 producer => "SQL::Translator::Producer::${type}",
167 parser => 'SQL::Translator::Parser::DBIx::Class',
171 my $ret = $tr->translate;
173 $schema->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
181 my $storage = $self->storage;
183 #< frew> k, also, we filter out comments and transaction stuff and blank lines
184 #< frew> is that really necesary?
185 #< frew> and what if I want to run my upgrade in a txn? seems like something you'd
186 # always want to do really
187 #< ribasushi> again - some stuff chokes
188 #< frew> ok, so I see filtering out -- and \s*
189 #< frew> but I think the txn filtering should be optional and default to NOT filter it
191 #< ribasushi> then you have a problem
193 #< ribasushi> someone runs a deploy in txn_do
194 #< ribasushi> the inner begin will blow up
195 #< frew> because it's a nested TXN?
196 #< ribasushi> (you an't begin twice on most dbs)
198 #< ribasushi> on sqlite - for sure
199 #< frew> so...read the docs and set txn_filter to true?
200 #< ribasushi> more like wrap deploy in a txn
201 #< frew> I like that better
202 #< ribasushi> and make sure the ddl has no literal txns in them
204 #< ribasushi> this way you have stuff under control
205 #< frew> so we have txn_wrap default to true
206 #< frew> and if people wanna do that by hand they can
207 my $sql = $self->_deployment_statements();
208 foreach my $line ( split(";\n", $sql)) {
209 next if !$line || $line =~ /^--|^BEGIN TRANSACTION|^COMMIT|^\s+$/;
210 $storage->_query_start($line);
212 # do a dbh_do cycle here, as we need some error checking in
213 # place (even though we will ignore errors)
214 $storage->dbh_do (sub { $_[1]->do($line) });
217 carp "$_ (running '${line}')"
219 $storage->_query_end($line);
223 sub prepare_install {
225 my $schema = $self->schema;
226 my $databases = $self->databases;
227 my $dir = $self->upgrade_directory;
228 my $sqltargs = $self->sqltargs;
229 my $version = $schema->schema_version;
232 carp "Upgrade directory $dir does not exist, using ./\n";
237 my $sqlt = SQL::Translator->new({
239 ignore_constraint_names => 1,
240 ignore_index_names => 1,
241 parser => 'SQL::Translator::Parser::DBIx::Class',
245 my $sqlt_schema = $sqlt->translate({ data => $schema })
246 or $self->throw_exception ($sqlt->error);
248 foreach my $db (@$databases) {
250 $sqlt->{schema} = $sqlt_schema;
251 $sqlt->producer($db);
253 my $filename = $self->_ddl_schema_produce_filename($db, $version, $dir);
255 carp "Overwriting existing DDL file - $filename";
259 my $output = $sqlt->translate;
261 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
265 unless( open $file, q(>), $filename ) {
266 $self->throw_exception("Can't open $filename for writing ($!)");
269 print {$file} $output;
274 sub prepare_upgrade {
275 my ($self, $from_version, $to_version, $version_set) = @_;
277 $from_version ||= $self->db_version;
278 $to_version ||= $self->schema_version;
280 # for updates prepared automatically (rob's stuff)
281 # one would want to explicitly set $version_set to
283 $version_set ||= [$from_version, $to_version];
285 $self->_prepare_changegrade($from_version, $to_version, $version_set, 'up');
288 sub prepare_downgrade {
289 my ($self, $from_version, $to_version, $version_set) = @_;
291 $from_version ||= $self->db_version;
292 $to_version ||= $self->schema_version;
294 # for updates prepared automatically (rob's stuff)
295 # one would want to explicitly set $version_set to
297 $version_set ||= [$from_version, $to_version];
299 $self->_prepare_changegrade($from_version, $to_version, $version_set, 'down');
302 method _prepare_changegrade($from_version, $to_version, $version_set, $direction) {
303 my $schema = $self->schema;
304 my $databases = $self->databases;
305 my $dir = $self->upgrade_directory;
306 my $sqltargs = $self->sqltargs;
308 my $schema_version = $schema->schema_version;
312 ignore_constraint_names => 1,
313 ignore_index_names => 1,
317 my $sqlt = SQL::Translator->new( $sqltargs );
319 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
320 my $sqlt_schema = $sqlt->translate({ data => $schema })
321 or $self->throw_exception ($sqlt->error);
323 foreach my $db (@$databases) {
325 $sqlt->{schema} = $sqlt_schema;
326 $sqlt->producer($db);
328 my $prefilename = $self->_ddl_schema_produce_filename($db, $from_version, $dir);
329 unless(-e $prefilename) {
330 carp("No previous schema file found ($prefilename)");
333 my $diff_file_method = "_ddl_schema_${direction}_produce_filename";
334 my $diff_file = $self->$diff_file_method($db, $version_set, $dir );
336 carp("Overwriting existing $direction-diff file - $diff_file");
342 my $t = SQL::Translator->new({
348 $t->parser( $db ) # could this really throw an exception?
349 or $self->throw_exception ($t->error);
351 my $out = $t->translate( $prefilename )
352 or $self->throw_exception ($t->error);
354 $source_schema = $t->schema;
356 $source_schema->name( $prefilename )
357 unless $source_schema->name;
360 # The "new" style of producers have sane normalization and can support
361 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
362 # And we have to diff parsed SQL against parsed SQL.
363 my $dest_schema = $sqlt_schema;
365 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
366 my $t = SQL::Translator->new({
372 $t->parser( $db ) # could this really throw an exception?
373 or $self->throw_exception ($t->error);
375 my $filename = $self->_ddl_schema_produce_filename($db, $to_version, $dir);
376 my $out = $t->translate( $filename )
377 or $self->throw_exception ($t->error);
379 $dest_schema = $t->schema;
381 $dest_schema->name( $filename )
382 unless $dest_schema->name;
385 my $diff = SQL::Translator::Diff::schema_diff(
391 unless(open $file, q(>), $diff_file) {
392 $self->throw_exception("Can't write to $diff_file ($!)");
400 method _read_sql_file($file) {
403 open my $fh, '<', $file or carp("Can't open upgrade file, $file ($!)");
404 my @data = split /\n/, join '', <$fh>;
410 !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/m
417 # these are exactly the same for now
418 sub _downgrade_single_step {
420 my @version_set = @{ shift @_ };
421 my @upgrade_files = @{$self->_ddl_schema_up_consume_filenames(
422 $self->storage->sqlt_type,
426 for my $upgrade_file (@upgrade_files) {
427 unless (-f $upgrade_file) {
429 carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
433 $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22
434 $self->schema->txn_do(sub { $self->_do_upgrade });
438 sub _upgrade_single_step {
440 my @version_set = @{ shift @_ };
441 my @upgrade_files = @{$self->_ddl_schema_up_consume_filenames(
442 $self->storage->sqlt_type,
446 for my $upgrade_file (@upgrade_files) {
447 unless (-f $upgrade_file) {
449 carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
453 $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22
454 $self->schema->txn_do(sub { $self->_do_upgrade });
458 method _do_upgrade { $self->_run_upgrade(qr/.*?/) }
460 method _run_upgrade($stm) {
461 return unless $self->_filedata;
462 my @statements = grep { $_ =~ $stm } @{$self->_filedata};
465 $self->storage->debugobj->query_start($_) if $self->storage->debug;
466 $self->_apply_statement($_);
467 $self->storage->debugobj->query_end($_) if $self->storage->debug;
471 method _apply_statement($statement) {
473 $self->storage->dbh->do($_) or carp "SQL was: $_"
480 vim: ts=2 sw=2 expandtab