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]',
64 method __ddl_consume_with_prefix($type, $versions, $prefix) {
65 my $base_dir = $self->upgrade_directory;
67 my $main = File::Spec->catfile( $base_dir, $type );
68 my $generic = File::Spec->catfile( $base_dir, '_generic' );
69 my $common = File::Spec->catfile( $base_dir, '_common', $prefix, join q(-), @{$versions} );
73 $dir = File::Spec->catfile($main, $prefix, join q(-), @{$versions})
74 } elsif (-d $generic) {
75 $dir = File::Spec->catfile($main, $prefix, join q(-), @{$versions})
80 opendir my($dh), $dir;
81 my %files = map { $_ => "$dir/$_" } grep { /\.sql$/ && -f "$dir/$_" } readdir($dh);
85 opendir my($dh), $common;
86 for my $filename (grep { /\.sql$/ && -f "$common/$_" } readdir($dh)) {
87 unless ($files{$filename}) {
88 $files{$filename} = "$common/$_";
94 return [@files{sort keys %files}]
97 method _ddl_schema_consume_filenames($type, $version) {
98 $self->__ddl_consume_with_prefix($type, [ $version ], 'schema')
101 method _ddl_schema_produce_filename($type, $version) {
102 my $base_dir = $self->upgrade_directory;
103 my $dirname = File::Spec->catfile(
104 $base_dir, $type, 'schema', $version
106 File::Path::mkpath($dirname) unless -d $dirname;
108 return File::Spec->catfile(
109 $dirname, '001-auto.sql'
113 method _ddl_schema_up_consume_filenames($type, $versions) {
114 $self->__ddl_consume_with_prefix($type, $versions, 'up')
117 method _ddl_schema_down_consume_filenames($type, $versions) {
118 $self->__ddl_consume_with_prefix($type, $versions, 'down')
121 method _ddl_schema_up_produce_filename($type, $versions) {
122 my $dir = $self->upgrade_directory;
124 my $dirname = File::Spec->catfile(
125 $dir, $type, 'up', join( q(-), @{$versions} )
127 File::Path::mkpath($dirname) unless -d $dirname;
129 return File::Spec->catfile(
130 $dirname, '001-auto.sql'
134 method _ddl_schema_down_produce_filename($type, $versions, $dir) {
135 my $dirname = File::Spec->catfile(
136 $dir, $type, 'down', join( q(-), @{$versions} )
138 File::Path::mkpath($dirname) unless -d $dirname;
140 return File::Spec->catfile(
141 $dirname, '001-auto.sql'
147 my $storage = $self->storage;
149 my $guard = $self->schema->txn_scope_guard if $self->txn_wrap;
152 map @{$self->_read_sql_file($_)}, @{$self->_ddl_schema_consume_filenames(
153 $self->storage->sqlt_type,
154 $self->schema_version
157 $storage->_query_start($line);
159 # do a dbh_do cycle here, as we need some error checking in
160 # place (even though we will ignore errors)
161 $storage->dbh_do (sub { $_[1]->do($line) });
164 carp "$_ (running '${line}')"
166 $storage->_query_end($line);
169 $guard->commit if $self->txn_wrap;
172 sub prepare_install {
174 my $schema = $self->schema;
175 my $databases = $self->databases;
176 my $dir = $self->upgrade_directory;
177 my $sqltargs = $self->sqltargs;
178 my $version = $schema->schema_version;
180 my $sqlt = SQL::Translator->new({
182 ignore_constraint_names => 1,
183 ignore_index_names => 1,
184 parser => 'SQL::Translator::Parser::DBIx::Class',
188 my $sqlt_schema = $sqlt->translate({ data => $schema })
189 or $self->throw_exception($sqlt->error);
191 foreach my $db (@$databases) {
193 $sqlt->{schema} = $sqlt_schema;
194 $sqlt->producer($db);
196 my $filename = $self->_ddl_schema_produce_filename($db, $version, $dir);
198 carp "Overwriting existing DDL file - $filename";
202 my $output = $sqlt->translate;
204 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
208 unless( open $file, q(>), $filename ) {
209 $self->throw_exception("Can't open $filename for writing ($!)");
212 print {$file} $output;
217 sub prepare_upgrade {
218 my ($self, $from_version, $to_version, $version_set) = @_;
220 $from_version ||= $self->db_version;
221 $to_version ||= $self->schema_version;
223 # for updates prepared automatically (rob's stuff)
224 # one would want to explicitly set $version_set to
226 $version_set ||= [$from_version, $to_version];
228 $self->_prepare_changegrade($from_version, $to_version, $version_set, 'up');
231 sub prepare_downgrade {
232 my ($self, $from_version, $to_version, $version_set) = @_;
234 $from_version ||= $self->db_version;
235 $to_version ||= $self->schema_version;
237 # for updates prepared automatically (rob's stuff)
238 # one would want to explicitly set $version_set to
240 $version_set ||= [$from_version, $to_version];
242 $self->_prepare_changegrade($from_version, $to_version, $version_set, 'down');
245 method _prepare_changegrade($from_version, $to_version, $version_set, $direction) {
246 my $schema = $self->schema;
247 my $databases = $self->databases;
248 my $dir = $self->upgrade_directory;
249 my $sqltargs = $self->sqltargs;
251 my $schema_version = $schema->schema_version;
255 ignore_constraint_names => 1,
256 ignore_index_names => 1,
260 my $sqlt = SQL::Translator->new( $sqltargs );
262 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
263 my $sqlt_schema = $sqlt->translate({ data => $schema })
264 or $self->throw_exception ($sqlt->error);
266 foreach my $db (@$databases) {
268 $sqlt->{schema} = $sqlt_schema;
269 $sqlt->producer($db);
271 my $prefilename = $self->_ddl_schema_produce_filename($db, $from_version, $dir);
272 unless(-e $prefilename) {
273 carp("No previous schema file found ($prefilename)");
276 my $diff_file_method = "_ddl_schema_${direction}_produce_filename";
277 my $diff_file = $self->$diff_file_method($db, $version_set, $dir );
279 carp("Overwriting existing $direction-diff file - $diff_file");
285 my $t = SQL::Translator->new({
291 $t->parser( $db ) # could this really throw an exception?
292 or $self->throw_exception ($t->error);
294 my $out = $t->translate( $prefilename )
295 or $self->throw_exception ($t->error);
297 $source_schema = $t->schema;
299 $source_schema->name( $prefilename )
300 unless $source_schema->name;
303 # The "new" style of producers have sane normalization and can support
304 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
305 # And we have to diff parsed SQL against parsed SQL.
306 my $dest_schema = $sqlt_schema;
308 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
309 my $t = SQL::Translator->new({
315 $t->parser( $db ) # could this really throw an exception?
316 or $self->throw_exception ($t->error);
318 my $filename = $self->_ddl_schema_produce_filename($db, $to_version, $dir);
319 my $out = $t->translate( $filename )
320 or $self->throw_exception ($t->error);
322 $dest_schema = $t->schema;
324 $dest_schema->name( $filename )
325 unless $dest_schema->name;
328 my $diff = SQL::Translator::Diff::schema_diff(
334 unless(open $file, q(>), $diff_file) {
335 $self->throw_exception("Can't write to $diff_file ($!)");
343 method _read_sql_file($file) {
346 open my $fh, '<', $file or carp("Can't open sql file, $file ($!)");
347 my @data = split /;\n/, join '', <$fh>;
351 $_ && # remove blank lines
352 !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/ # strip txn's
354 s/^\s+//; s/\s+$//; # trim whitespace
355 join '', grep { !/^--/ } split /\n/ # remove comments
361 # these are exactly the same for now
362 sub _downgrade_single_step {
364 my @version_set = @{ shift @_ };
365 my @upgrade_files = @{$self->_ddl_schema_up_consume_filenames(
366 $self->storage->sqlt_type,
370 for my $upgrade_file (@upgrade_files) {
371 unless (-f $upgrade_file) {
373 carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
377 $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22
379 my $guard = $self->schema->txn_scope_guard if $self->txn_wrap;
381 $guard->commit if $self->txn_wrap;
385 sub _upgrade_single_step {
387 my @version_set = @{ shift @_ };
388 my @upgrade_files = @{$self->_ddl_schema_up_consume_filenames(
389 $self->storage->sqlt_type,
393 for my $upgrade_file (@upgrade_files) {
394 unless (-f $upgrade_file) {
396 carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
400 $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22
401 my $guard = $self->schema->txn_scope_guard if $self->txn_wrap;
403 $guard->commit if $self->txn_wrap;
407 method _do_upgrade { $self->_run_upgrade(qr/.*?/) }
409 method _run_upgrade($stm) {
410 return unless $self->_filedata;
411 my @statements = grep { $_ =~ $stm } @{$self->_filedata};
414 $self->storage->debugobj->query_start($_) if $self->storage->debug;
415 $self->_apply_statement($_);
416 $self->storage->debugobj->query_end($_) if $self->storage->debug;
420 method _apply_statement($statement) {
422 $self->storage->dbh->do($_) or carp "SQL was: $_"
429 vim: ts=2 sw=2 expandtab