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
10 with 'DBIx::Class::DeploymentHandler::HandlesDeploy';
15 isa => 'DBIx::Class::Schema',
18 handles => [qw( schema_version )],
22 isa => 'DBIx::Class::Storage',
27 method _build_storage {
28 my $s = $self->schema->storage;
29 $s->_determine_driver;
36 default => sub { {} },
38 has upgrade_directory => (
47 isa => 'DBIx::Class::DeploymentHandler::Databases',
49 default => sub { [qw( MySQL SQLite PostgreSQL )] },
53 isa => 'ArrayRef[Str]',
57 method _ddl_schema_in_filenames($type, $version, $dir) {
58 my $filename = ref $self->schema;
59 $filename =~ s/::/-/g;
63 if (-d "$dir/$type") {
64 my $dirname = File::Spec->catfile(
65 $dir, $type, 'schema', $version, '001-auto.sql'
67 opendir my $dh, $dirname;
68 %files = map { $_ => "$dirname/$_" } grep { -f "$dirname/$_" } readdir($dh);
71 } elsif (-d "$dir/_generic") {
72 $filename = File::Spec->catfile(
73 $dir, '_generic', 'schema', $version, '001-auto.sql'
76 $filename = File::Spec->catfile(
77 $dir, '_common', 'schema', $version, '001-auto.sql'
84 method _ddl_schema_out_filename($type, $version, $dir) {
85 my $filename = ref $self->schema;
86 $filename =~ s/::/-/g;
88 $filename = File::Spec->catfile(
89 $dir, $type, 'schema', $version, '001-auto.sql'
96 method _ddl_schema_diff_in_filenames($type, $versions, $dir) {
97 my $filename = ref $self->schema;
98 $filename =~ s/::/-/g;
100 $filename = File::Spec->catfile(
101 $dir, $type, 'diff', join( q(-), @{$versions} ), '001-auto.sql'
104 return [ $filename ];
107 method _ddl_schema_diff_out_filename($type, $versions, $dir) {
108 my $filename = ref $self->schema;
109 $filename =~ s/::/-/g;
111 $filename = File::Spec->catfile(
112 $dir, $type, 'diff', join( q(-), @{$versions} ), '001-auto.sql'
118 method _deployment_statements {
119 my $dir = $self->upgrade_directory;
120 my $schema = $self->schema;
121 my $type = $self->storage->sqlt_type;
122 my $sqltargs = $self->sqltargs;
123 my $version = $self->schema_version;
125 my @filenames = @{$self->_ddl_schema_in_filenames($type, $version, $dir)};
127 for my $filename (@filenames) {
130 open $file, q(<), $filename
131 or carp "Can't open $filename ($!)";
134 return join '', @rows;
138 # sources needs to be a parser arg, but for simplicty allow at top level
140 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
141 if exists $sqltargs->{sources};
143 my $tr = SQL::Translator->new(
144 producer => "SQL::Translator::Producer::${type}",
146 parser => 'SQL::Translator::Parser::DBIx::Class',
153 @ret = $tr->translate;
156 $ret[0] = $tr->translate;
159 $schema->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
160 unless (@ret && defined $ret[0]);
162 return $wa ? @ret : $ret[0];
167 my $storage = $self->storage;
171 return if(!$line || $line =~ /^--|^BEGIN TRANSACTION|^COMMIT|^\s+$/);
172 $storage->_query_start($line);
174 # do a dbh_do cycle here, as we need some error checking in
175 # place (even though we will ignore errors)
176 $storage->dbh_do (sub { $_[1]->do($line) });
179 carp "$_ (running '${line}')"
181 $storage->_query_end($line);
183 my @statements = $self->_deployment_statements();
184 if (@statements > 1) {
185 foreach my $statement (@statements) {
186 $deploy->( $statement );
189 elsif (@statements == 1) {
190 foreach my $line ( split(";\n", $statements[0])) {
196 sub prepare_install {
198 my $schema = $self->schema;
199 my $databases = $self->databases;
200 my $dir = $self->upgrade_directory;
201 my $sqltargs = $self->sqltargs;
202 my $version = $schema->schema_version;
205 carp "Upgrade directory $dir does not exist, using ./\n";
210 my $sqlt = SQL::Translator->new({
212 ignore_constraint_names => 1,
213 ignore_index_names => 1,
214 parser => 'SQL::Translator::Parser::DBIx::Class',
218 my $sqlt_schema = $sqlt->translate({ data => $schema })
219 or $self->throw_exception ($sqlt->error);
221 foreach my $db (@$databases) {
223 $sqlt->{schema} = $sqlt_schema;
224 $sqlt->producer($db);
226 my $filename = $self->_ddl_schema_out_filename($db, $version, $dir);
228 carp "Overwriting existing DDL file - $filename";
232 my $output = $sqlt->translate;
234 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
238 unless( open $file, q(>), $filename ) {
239 $self->throw_exception("Can't open $filename for writing ($!)");
242 print {$file} $output;
248 my ($self, $from_version, $to_version, $version_set) = @_;
250 $from_version ||= $self->db_version;
251 $to_version ||= $self->schema_version;
253 # for updates prepared automatically (rob's stuff)
254 # one would want to explicitly set $version_set to
256 $version_set ||= [$from_version, $to_version];
257 my $schema = $self->schema;
258 my $databases = $self->databases;
259 my $dir = $self->upgrade_directory;
260 my $sqltargs = $self->sqltargs;
263 carp "Upgrade directory $dir does not exist, using ./\n";
267 my $schema_version = $schema->schema_version;
271 ignore_constraint_names => 1,
272 ignore_index_names => 1,
276 my $sqlt = SQL::Translator->new( $sqltargs );
278 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
279 my $sqlt_schema = $sqlt->translate({ data => $schema })
280 or $self->throw_exception ($sqlt->error);
282 foreach my $db (@$databases) {
284 $sqlt->{schema} = $sqlt_schema;
285 $sqlt->producer($db);
287 my $prefilename = $self->_ddl_schema_out_filename($db, $from_version, $dir);
288 unless(-e $prefilename) {
289 carp("No previous schema file found ($prefilename)");
293 my $diff_file = $self->_ddl_schema_diff_out_filename($db, $version_set, $dir );
295 carp("Overwriting existing diff file - $diff_file");
301 my $t = SQL::Translator->new({
307 $t->parser( $db ) # could this really throw an exception?
308 or $self->throw_exception ($t->error);
310 my $out = $t->translate( $prefilename )
311 or $self->throw_exception ($t->error);
313 $source_schema = $t->schema;
315 $source_schema->name( $prefilename )
316 unless $source_schema->name;
319 # The "new" style of producers have sane normalization and can support
320 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
321 # And we have to diff parsed SQL against parsed SQL.
322 my $dest_schema = $sqlt_schema;
324 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
325 my $t = SQL::Translator->new({
331 $t->parser( $db ) # could this really throw an exception?
332 or $self->throw_exception ($t->error);
334 my $filename = $self->_ddl_schema_out_filename($db, $to_version, $dir);
335 my $out = $t->translate( $filename )
336 or $self->throw_exception ($t->error);
338 $dest_schema = $t->schema;
340 $dest_schema->name( $filename )
341 unless $dest_schema->name;
344 my $diff = SQL::Translator::Diff::schema_diff(
350 unless(open $file, q(>), $diff_file) {
351 $self->throw_exception("Can't write to $diff_file ($!)");
359 method _read_sql_file($file) {
362 open my $fh, '<', $file or carp("Can't open upgrade file, $file ($!)");
363 my @data = split /\n/, join '', <$fh>;
369 !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/m
376 sub _upgrade_single_step {
378 my @version_set = @{ shift @_ };
379 my @upgrade_files = @{$self->_ddl_schema_diff_in_filenames(
380 $self->storage->sqlt_type,
382 $self->upgrade_directory,
385 for my $upgrade_file (@upgrade_files) {
386 unless (-f $upgrade_file) {
388 carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
392 $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22
393 $self->schema->txn_do(sub { $self->_do_upgrade });
397 method _do_upgrade { $self->_run_upgrade(qr/.*?/) }
399 method _run_upgrade($stm) {
400 return unless $self->_filedata;
401 my @statements = grep { $_ =~ $stm } @{$self->_filedata};
404 $self->storage->debugobj->query_start($_) if $self->storage->debug;
405 $self->_apply_statement($_);
406 $self->storage->debugobj->query_end($_) if $self->storage->debug;
410 method _apply_statement($statement) {
412 $self->storage->dbh->do($_) or carp "SQL was: $_"
419 vim: ts=2 sw=2 expandtab