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
12 isa => 'DBIx::Class::Storage',
17 method _build_storage {
18 my $s = $self->schema->storage;
19 $s->_determine_driver;
23 has backup_directory => (
37 default => sub { {} },
39 has upgrade_directory => (
47 isa => 'DBIx::Class::ResultSet',
50 handles => [qw( is_installed db_version )],
53 method _build_version_rs {
54 $self->schema->set_us_up_the_bomb;
55 $self->schema->resultset('__VERSION')
60 isa => 'DBIx::Class::DeploymentHandler::Databases',
62 default => sub { [qw( MySQL SQLite PostgreSQL )] },
66 isa => 'DBIx::Class::Schema',
69 handles => [qw( schema_version )],
73 isa => 'ArrayRef[Str]',
77 method _ddl_filename($type, $versions, $dir) {
78 my $filename = ref $self->schema;
79 $filename =~ s/::/-/g;
81 $filename = File::Spec->catfile(
82 $dir, "$filename-" . join( q(-), @{$versions} ) . "-$type.sql"
88 method _deployment_statements {
89 my $dir = $self->upgrade_directory;
90 my $schema = $self->schema;
91 my $type = $self->storage->sqlt_type;
92 my $sqltargs = $self->sqltargs;
93 my $version = $self->schema_version || '1.x';
95 my $filename = $self->_ddl_filename($type, [ $version ], $dir);
98 open $file, q(<), $filename
99 or carp "Can't open $filename ($!)";
102 return join '', @rows;
105 # sources needs to be a parser arg, but for simplicty allow at top level
107 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
108 if exists $sqltargs->{sources};
110 my $tr = SQL::Translator->new(
111 producer => "SQL::Translator::Producer::${type}",
113 parser => 'SQL::Translator::Parser::DBIx::Class',
120 @ret = $tr->translate;
123 $ret[0] = $tr->translate;
126 $schema->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
127 unless (@ret && defined $ret[0]);
129 return $wa ? @ret : $ret[0];
133 my $storage = $self->storage;
137 return if(!$line || $line =~ /^--|^BEGIN TRANSACTION|^COMMIT|^\s+$/);
138 $storage->_query_start($line);
140 # do a dbh_do cycle here, as we need some error checking in
141 # place (even though we will ignore errors)
142 $storage->dbh_do (sub { $_[1]->do($line) });
145 carp "$_ (running '${line}')"
147 $storage->_query_end($line);
149 my @statements = $self->_deployment_statements();
150 if (@statements > 1) {
151 foreach my $statement (@statements) {
152 $deploy->( $statement );
155 elsif (@statements == 1) {
156 foreach my $line ( split(";\n", $statements[0])) {
162 method prepare_install {
163 my $schema = $self->schema;
164 my $databases = $self->databases;
165 my $dir = $self->upgrade_directory;
166 my $sqltargs = $self->sqltargs;
168 carp "Upgrade directory $dir does not exist, using ./\n";
172 my $version = $schema->schema_version || '1.x';
173 my $schema_version = $schema->schema_version || '1.x';
174 $version ||= $schema_version;
178 ignore_constraint_names => 1,
179 ignore_index_names => 1,
183 my $sqlt = SQL::Translator->new( $sqltargs );
185 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
186 my $sqlt_schema = $sqlt->translate({ data => $schema })
187 or $self->throw_exception ($sqlt->error);
189 foreach my $db (@$databases) {
191 $sqlt->{schema} = $sqlt_schema;
192 $sqlt->producer($db);
194 my $filename = $self->_ddl_filename($db, [ $version ], $dir);
195 if (-e $filename && ($version eq $schema_version )) {
196 # if we are dumping the current version, overwrite the DDL
197 carp "Overwriting existing DDL file - $filename";
201 my $output = $sqlt->translate;
203 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
207 unless( open $file, q(>), $filename ) {
208 $self->throw_exception("Can't open $filename for writing ($!)");
211 print {$file} $output;
216 method prepare_update($version, $preversion) {
217 my $schema = $self->schema;
218 my $databases = $self->databases;
219 my $dir = $self->upgrade_directory;
220 my $sqltargs = $self->sqltargs;
223 carp "Upgrade directory $dir does not exist, using ./\n";
227 my $schema_version = $schema->schema_version || '1.x';
228 $version ||= $schema_version;
232 ignore_constraint_names => 1,
233 ignore_index_names => 1,
237 my $sqlt = SQL::Translator->new( $sqltargs );
239 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
240 my $sqlt_schema = $sqlt->translate({ data => $schema })
241 or $self->throw_exception ($sqlt->error);
243 foreach my $db (@$databases) {
245 $sqlt->{schema} = $sqlt_schema;
246 $sqlt->producer($db);
248 my $prefilename = $self->_ddl_filename($db, [ $preversion ], $dir);
249 unless(-e $prefilename) {
250 carp("No previous schema file found ($prefilename)");
254 my $diff_file = $self->_ddl_filename($db, [ $preversion, $version ], $dir );
256 carp("Overwriting existing diff file - $diff_file");
262 my $t = SQL::Translator->new({
268 $t->parser( $db ) # could this really throw an exception?
269 or $self->throw_exception ($t->error);
271 my $out = $t->translate( $prefilename )
272 or $self->throw_exception ($t->error);
274 $source_schema = $t->schema;
276 $source_schema->name( $prefilename )
277 unless $source_schema->name;
280 # The "new" style of producers have sane normalization and can support
281 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
282 # And we have to diff parsed SQL against parsed SQL.
283 my $dest_schema = $sqlt_schema;
285 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
286 my $t = SQL::Translator->new({
292 $t->parser( $db ) # could this really throw an exception?
293 or $self->throw_exception ($t->error);
295 my $filename = $self->_ddl_filename($db, [ $version ], $dir);
296 my $out = $t->translate( $filename )
297 or $self->throw_exception ($t->error);
299 $dest_schema = $t->schema;
301 $dest_schema->name( $filename )
302 unless $dest_schema->name;
305 my $diff = SQL::Translator::Diff::schema_diff(
311 unless(open $file, q(>), $diff_file) {
312 $self->throw_exception("Can't write to $diff_file ($!)");
320 method _read_sql_file($file) {
323 open my $fh, '<', $file or carp("Can't open upgrade file, $file ($!)");
324 my @data = split /\n/, join '', <$fh>;
330 !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/m
337 method _upgrade_single_step {
338 my @version_set = @{ shift @_ };
339 my $db_version = $self->db_version;
340 my $upgrade_file = $self->_ddl_filename(
341 $self->storage->sqlt_type,
343 $self->upgrade_directory,
346 unless (-f $upgrade_file) {
348 carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
352 carp "DB version ($db_version) is lower than the schema version (".$self->schema_version."). Attempting upgrade.\n";
354 $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22
355 $self->backup if $self->do_backup;
356 $self->schema->txn_do(sub { $self->_do_upgrade });
358 $self->version_rs->create({
359 version => $version_set[-1],
361 # upgrade_sql => $upgrade_sql,
365 method _do_upgrade { $self->_run_upgrade(qr/.*?/) }
367 method _run_upgrade($stm) {
368 return unless $self->_filedata;
369 my @statements = grep { $_ =~ $stm } @{$self->_filedata};
372 $self->storage->debugobj->query_start($_) if $self->storage->debug;
373 $self->_apply_statement($_);
374 $self->storage->debugobj->query_end($_) if $self->storage->debug;
378 method _apply_statement($statement) {
380 $self->storage->dbh->do($_) or carp "SQL was: $_"
383 method backup { $self->storage->backup($self->backup_directory) }
385 __PACKAGE__->meta->make_immutable;
391 vim: ts=2 sw=2 expandtab