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|pl)$/ && -f "$dir/$_" } readdir $dh;
93 opendir my($dh), $common;
94 for my $filename (grep { /\.(?:sql|pl)$/ && -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');
141 method _run_sql_and_perl($filenames) {
142 my @files = @{$filenames};
143 my $storage = $self->storage;
145 my $guard = $self->schema->txn_scope_guard if $self->txn_wrap;
148 for my $filename (@files) {
149 if ($filename =~ /\.sql$/) {
150 my @sql = @{$self->_read_sql_file($filename)};
151 $sql .= join "\n", @sql;
153 foreach my $line (@sql) {
154 $storage->_query_start($line);
156 # do a dbh_do cycle here, as we need some error checking in
157 # place (even though we will ignore errors)
158 $storage->dbh_do (sub { $_[1]->do($line) });
161 carp "$_ (running '${line}')"
163 $storage->_query_end($line);
165 } elsif ( $filename =~ /^(.+)\.pl$/ ) {
167 my $filedata = do { local( @ARGV, $/ ) = $filename; <> };
168 # make the package name more palateable to perl
169 $package =~ s/\W/_/g;
171 no warnings 'redefine';
172 eval "package $package;\n\n$filedata";
175 if (my $fn = $package->can('run')) {
176 $fn->($self->schema);
178 carp "$filename should define a run method that takes a schema but it didn't!";
181 croak "A file got to deploy that wasn't sql or perl!";
185 $guard->commit if $self->txn_wrap;
193 return $self->_run_sql_and_perl($self->_ddl_schema_consume_filenames(
194 $self->storage->sqlt_type,
195 $self->schema_version
199 sub prepare_install {
201 my $schema = $self->schema;
202 my $databases = $self->databases;
203 my $dir = $self->upgrade_directory;
204 my $sqltargs = $self->sqltargs;
205 my $version = $schema->schema_version;
207 my $sqlt = SQL::Translator->new({
209 ignore_constraint_names => 1,
210 ignore_index_names => 1,
211 parser => 'SQL::Translator::Parser::DBIx::Class',
215 my $sqlt_schema = $sqlt->translate( data => $schema )
216 or croak($sqlt->error);
218 foreach my $db (@$databases) {
220 $sqlt->{schema} = $sqlt_schema;
221 $sqlt->producer($db);
223 my $filename = $self->_ddl_schema_produce_filename($db, $version, $dir);
225 carp "Overwriting existing DDL file - $filename";
229 my $output = $sqlt->translate;
231 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
234 open my $file, q(>), $filename;
235 print {$file} $output;
240 sub prepare_upgrade {
241 my ($self, $from_version, $to_version, $version_set) = @_;
242 # for updates prepared automatically (rob's stuff)
243 # one would want to explicitly set $version_set to
245 $self->_prepare_changegrade($from_version, $to_version, $version_set, 'up');
248 sub prepare_downgrade {
249 my ($self, $from_version, $to_version, $version_set) = @_;
251 # for updates prepared automatically (rob's stuff)
252 # one would want to explicitly set $version_set to
254 $self->_prepare_changegrade($from_version, $to_version, $version_set, 'down');
257 method _prepare_changegrade($from_version, $to_version, $version_set, $direction) {
258 my $schema = $self->schema;
259 my $databases = $self->databases;
260 my $dir = $self->upgrade_directory;
261 my $sqltargs = $self->sqltargs;
263 my $schema_version = $schema->schema_version;
267 ignore_constraint_names => 1,
268 ignore_index_names => 1,
272 my $sqlt = SQL::Translator->new( $sqltargs );
274 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
275 my $sqlt_schema = $sqlt->translate( data => $schema )
276 or croak($sqlt->error);
278 foreach my $db (@$databases) {
280 $sqlt->{schema} = $sqlt_schema;
281 $sqlt->producer($db);
283 my $prefilename = $self->_ddl_schema_produce_filename($db, $from_version, $dir);
284 unless(-e $prefilename) {
285 carp("No previous schema file found ($prefilename)");
288 my $diff_file_method = "_ddl_schema_${direction}_produce_filename";
289 my $diff_file = $self->$diff_file_method($db, $version_set, $dir );
291 carp("Overwriting existing $direction-diff file - $diff_file");
297 my $t = SQL::Translator->new({
303 $t->parser( $db ) # could this really throw an exception?
306 my $out = $t->translate( $prefilename )
309 $source_schema = $t->schema;
311 $source_schema->name( $prefilename )
312 unless $source_schema->name;
315 # The "new" style of producers have sane normalization and can support
316 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
317 # And we have to diff parsed SQL against parsed SQL.
318 my $dest_schema = $sqlt_schema;
320 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
321 my $t = SQL::Translator->new({
327 $t->parser( $db ) # could this really throw an exception?
330 my $filename = $self->_ddl_schema_produce_filename($db, $to_version, $dir);
331 my $out = $t->translate( $filename )
334 $dest_schema = $t->schema;
336 $dest_schema->name( $filename )
337 unless $dest_schema->name;
340 my $diff = SQL::Translator::Diff::schema_diff(
345 open my $file, q(>), $diff_file;
351 method _read_sql_file($file) {
354 open my $fh, '<', $file;
355 my @data = split /;\n/, join '', <$fh>;
359 $_ && # remove blank lines
360 !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/ # strip txn's
362 s/^\s+//; s/\s+$//; # trim whitespace
363 join '', grep { !/^--/ } split /\n/ # remove comments
369 sub downgrade_single_step {
371 my $version_set = shift @_;
373 my $sql = $self->_run_sql_and_perl($self->_ddl_schema_down_consume_filenames(
374 $self->storage->sqlt_type,
381 sub upgrade_single_step {
383 my $version_set = shift @_;
385 my $sql = $self->_run_sql_and_perl($self->_ddl_schema_up_consume_filenames(
386 $self->storage->sqlt_type,
392 __PACKAGE__->meta->make_immutable;
398 vim: ts=2 sw=2 expandtab