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_in_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_in_filenames($type, $version) {
92 $self->__ddl_in_with_prefix($type, [ $version ], 'schema')
95 method _ddl_schema_out_filename($type, $version, $dir) {
96 my $dirname = File::Spec->catfile(
97 $dir, $type, 'schema', $version
99 File::Path::mkpath($dirname) unless -d $dirname;
101 return File::Spec->catfile(
102 $dirname, '001-auto.sql'
106 method _ddl_schema_up_in_filenames($type, $versions, $dir) {
107 $self->__ddl_in_with_prefix($type, $versions, 'up')
110 method _ddl_schema_down_in_filenames($type, $versions, $dir) {
111 $self->__ddl_in_with_prefix($type, $versions, 'down')
114 method _ddl_schema_up_out_filename($type, $versions, $dir) {
115 my $dirname = File::Spec->catfile(
116 $dir, $type, 'up', join( q(-), @{$versions} )
118 File::Path::mkpath($dirname) unless -d $dirname;
120 return File::Spec->catfile(
121 $dirname, '001-auto.sql'
125 method _ddl_schema_down_out_filename($type, $versions, $dir) {
126 my $dirname = File::Spec->catfile(
127 $dir, $type, 'down', join( q(-), @{$versions} )
129 File::Path::mkpath($dirname) unless -d $dirname;
131 return File::Spec->catfile(
132 $dirname, '001-auto.sql'
136 method _deployment_statements {
137 my $dir = $self->upgrade_directory;
138 my $schema = $self->schema;
139 my $type = $self->storage->sqlt_type;
140 my $sqltargs = $self->sqltargs;
141 my $version = $self->schema_version;
143 my @filenames = @{$self->_ddl_schema_in_filenames($type, $version)};
145 for my $filename (@filenames) {
148 open $file, q(<), $filename
149 or carp "Can't open $filename ($!)";
152 return join '', @rows;
156 # sources needs to be a parser arg, but for simplicty allow at top level
158 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
159 if exists $sqltargs->{sources};
161 my $tr = SQL::Translator->new(
162 producer => "SQL::Translator::Producer::${type}",
164 parser => 'SQL::Translator::Parser::DBIx::Class',
168 #< frew> now note that deploy in the same file calls deployment_statements
170 #< frew> ALWAYS in array context
171 #< ribasushi> right, that's the only way
172 #< ribasushi> but create_ddl_dir
173 #< ribasushi> calls in scalar
174 #< ribasushi> because this is how you get stuff writable to a file
175 #< ribasushi> in list you get individual statements for dbh->do
178 #< frew> so for *me* I need it *always* in scalar
179 #< frew> because I *only* use it to generate the file
180 #< ribasushi> correct
184 @ret = $tr->translate;
187 $ret[0] = $tr->translate;
190 $schema->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
191 unless (@ret && defined $ret[0]);
193 return $wa ? @ret : $ret[0];
198 my $storage = $self->storage;
202 #< frew> k, also, we filter out comments and transaction stuff and blank lines
203 #< frew> is that really necesary?
204 #< frew> and what if I want to run my upgrade in a txn? seems like something you'd
205 # always want to do really
206 #< ribasushi> again - some stuff chokes
207 #< frew> ok, so I see filtering out -- and \s*
208 #< frew> but I think the txn filtering should be optional and default to NOT filter it
210 #< ribasushi> then you have a problem
212 #< ribasushi> someone runs a deploy in txn_do
213 #< ribasushi> the inner begin will blow up
214 #< frew> because it's a nested TXN?
215 #< ribasushi> (you an't begin twice on most dbs)
217 #< ribasushi> on sqlite - for sure
218 #< frew> so...read the docs and set txn_filter to true?
219 #< ribasushi> more like wrap deploy in a txn
220 #< frew> I like that better
221 #< ribasushi> and make sure the ddl has no literal txns in them
223 #< ribasushi> this way you have stuff under control
224 #< frew> so we have txn_wrap default to true
225 #< frew> and if people wanna do that by hand they can
227 return if(!$line || $line =~ /^--|^BEGIN TRANSACTION|^COMMIT|^\s+$/);
228 $storage->_query_start($line);
230 # do a dbh_do cycle here, as we need some error checking in
231 # place (even though we will ignore errors)
232 $storage->dbh_do (sub { $_[1]->do($line) });
235 carp "$_ (running '${line}')"
237 $storage->_query_end($line);
239 my @statements = $self->_deployment_statements();
240 if (@statements > 1) {
241 foreach my $statement (@statements) {
242 $deploy->( $statement );
245 elsif (@statements == 1) {
246 foreach my $line ( split(";\n", $statements[0])) {
252 sub prepare_install {
254 my $schema = $self->schema;
255 my $databases = $self->databases;
256 my $dir = $self->upgrade_directory;
257 my $sqltargs = $self->sqltargs;
258 my $version = $schema->schema_version;
261 carp "Upgrade directory $dir does not exist, using ./\n";
266 my $sqlt = SQL::Translator->new({
268 ignore_constraint_names => 1,
269 ignore_index_names => 1,
270 parser => 'SQL::Translator::Parser::DBIx::Class',
274 my $sqlt_schema = $sqlt->translate({ data => $schema })
275 or $self->throw_exception ($sqlt->error);
277 foreach my $db (@$databases) {
279 $sqlt->{schema} = $sqlt_schema;
280 $sqlt->producer($db);
282 my $filename = $self->_ddl_schema_out_filename($db, $version, $dir);
284 carp "Overwriting existing DDL file - $filename";
288 my $output = $sqlt->translate;
290 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
294 unless( open $file, q(>), $filename ) {
295 $self->throw_exception("Can't open $filename for writing ($!)");
298 print {$file} $output;
303 sub prepare_upgrade {
304 my ($self, $from_version, $to_version, $version_set) = @_;
306 $from_version ||= $self->db_version;
307 $to_version ||= $self->schema_version;
309 # for updates prepared automatically (rob's stuff)
310 # one would want to explicitly set $version_set to
312 $version_set ||= [$from_version, $to_version];
313 my $schema = $self->schema;
314 my $databases = $self->databases;
315 my $dir = $self->upgrade_directory;
316 my $sqltargs = $self->sqltargs;
319 carp "Upgrade directory $dir does not exist, using ./\n";
323 my $schema_version = $schema->schema_version;
327 ignore_constraint_names => 1,
328 ignore_index_names => 1,
332 my $sqlt = SQL::Translator->new( $sqltargs );
334 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
335 my $sqlt_schema = $sqlt->translate({ data => $schema })
336 or $self->throw_exception ($sqlt->error);
338 foreach my $db (@$databases) {
340 $sqlt->{schema} = $sqlt_schema;
341 $sqlt->producer($db);
343 my $prefilename = $self->_ddl_schema_out_filename($db, $from_version, $dir);
344 unless(-e $prefilename) {
345 carp("No previous schema file found ($prefilename)");
349 my $diff_file = $self->_ddl_schema_up_out_filename($db, $version_set, $dir );
351 carp("Overwriting existing up-diff file - $diff_file");
357 my $t = SQL::Translator->new({
363 $t->parser( $db ) # could this really throw an exception?
364 or $self->throw_exception ($t->error);
366 my $out = $t->translate( $prefilename )
367 or $self->throw_exception ($t->error);
369 $source_schema = $t->schema;
371 $source_schema->name( $prefilename )
372 unless $source_schema->name;
375 # The "new" style of producers have sane normalization and can support
376 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
377 # And we have to diff parsed SQL against parsed SQL.
378 my $dest_schema = $sqlt_schema;
380 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
381 my $t = SQL::Translator->new({
387 $t->parser( $db ) # could this really throw an exception?
388 or $self->throw_exception ($t->error);
390 my $filename = $self->_ddl_schema_out_filename($db, $to_version, $dir);
391 my $out = $t->translate( $filename )
392 or $self->throw_exception ($t->error);
394 $dest_schema = $t->schema;
396 $dest_schema->name( $filename )
397 unless $dest_schema->name;
400 my $diff = SQL::Translator::Diff::schema_diff(
406 unless(open $file, q(>), $diff_file) {
407 $self->throw_exception("Can't write to $diff_file ($!)");
415 method _read_sql_file($file) {
418 open my $fh, '<', $file or carp("Can't open upgrade file, $file ($!)");
419 my @data = split /\n/, join '', <$fh>;
425 !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/m
432 sub _upgrade_single_step {
434 my @version_set = @{ shift @_ };
435 my @upgrade_files = @{$self->_ddl_schema_up_in_filenames(
436 $self->storage->sqlt_type,
440 for my $upgrade_file (@upgrade_files) {
441 unless (-f $upgrade_file) {
443 carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
447 $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22
448 $self->schema->txn_do(sub { $self->_do_upgrade });
452 method _do_upgrade { $self->_run_upgrade(qr/.*?/) }
454 method _run_upgrade($stm) {
455 return unless $self->_filedata;
456 my @statements = grep { $_ =~ $stm } @{$self->_filedata};
459 $self->storage->debugobj->query_start($_) if $self->storage->debug;
460 $self->_apply_statement($_);
461 $self->storage->debugobj->query_end($_) if $self->storage->debug;
465 method _apply_statement($statement) {
467 $self->storage->dbh->do($_) or carp "SQL was: $_"
474 vim: ts=2 sw=2 expandtab