1 package DBIx::Class::DeploymentHandler;
4 use Method::Signatures::Simple;
5 require DBIx::Class::Schema; # loaded for type constraint
6 require DBIx::Class::Storage; # loaded for type constraint
7 require DBIx::Class::ResultSet; # loaded for type constraint
8 use Carp::Clan '^DBIx::Class::DeploymentHandler';
13 use Moose::Util::TypeConstraints;
14 subtype 'DBIx::Class::DeploymentHandler::Databases'
15 => as 'ArrayRef[Str]';
17 coerce 'DBIx::Class::DeploymentHandler::Databases'
20 no Moose::Util::TypeConstraints;
24 isa => 'DBIx::Class::Schema',
27 handles => [qw( ddl_filename schema_version )],
30 has upgrade_directory => (
37 has backup_directory => (
43 isa => 'DBIx::Class::Storage',
48 method _build_storage {
49 my $s = $self->schema->storage;
50 $s->_determine_driver;
55 isa => 'ArrayRef[Str]',
65 has do_diff_on_init => (
72 isa => 'DBIx::Class::ResultSet',
75 handles => [qw( is_installed db_version )],
80 isa => 'DBIx::Class::DeploymentHandler::Databases',
82 default => sub { [qw( MySQL SQLite PostgreSQL )] },
88 default => sub { {} },
91 method deployment_statements {
92 my $dir = $self->upgrade_directory;
93 my $schema = $self->schema;
94 my $type = $self->storage->sqlt_type;
95 my $sqltargs = $self->sqltargs;
96 my $version = $self->schema_version || '1.x';
98 my $filename = $self->ddl_filename($type, $version, $dir);
101 open $file, q(<), $filename
102 or carp "Can't open $filename ($!)";
105 return join '', @rows;
108 # sources needs to be a parser arg, but for simplicty allow at top level
110 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
111 if exists $sqltargs->{sources};
113 my $tr = SQL::Translator->new(
114 producer => "SQL::Translator::Producer::${type}",
116 parser => 'SQL::Translator::Parser::DBIx::Class',
123 @ret = $tr->translate;
126 $ret[0] = $tr->translate;
129 $schema->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
130 unless (@ret && defined $ret[0]);
132 return $wa ? @ret : $ret[0];
136 my $schema = $self->schema;
138 my $sqltargs = $self->sqltargs;
139 my $dir = $self->upgrade_directory;
140 my $storage = $self->storage;
144 return if(!$line || $line =~ /^--|^BEGIN TRANSACTION|^COMMIT|^\s+$/);
145 $storage->_query_start($line);
147 # do a dbh_do cycle here, as we need some error checking in
148 # place (even though we will ignore errors)
149 $storage->dbh_do (sub { $_[1]->do($line) });
152 carp "$_ (running '${line}')"
154 $storage->_query_end($line);
156 my @statements = $self->deployment_statements();
157 if (@statements > 1) {
158 foreach my $statement (@statements) {
159 $deploy->( $statement );
162 elsif (@statements == 1) {
163 foreach my $line ( split(";\n", $statements[0])) {
169 method _build_version_rs {
170 $self->schema->set_us_up_the_bomb;
171 $self->schema->resultset('__VERSION')
174 method backup { $self->storage->backup($self->backup_directory) }
176 method install($new_version) {
177 carp 'Install not possible as versions table already exists in database'
178 if $self->is_installed;
180 $new_version ||= $self->schema_version;
185 $self->version_rs->create({
186 version => $new_version,
188 # upgrade_sql => $upgrade_sql,
193 method create_upgrade_path { }
195 method ordered_schema_versions { undef }
198 my $db_version = $self->db_version;
199 my $schema_version = $self->schema_version;
201 unless ($db_version) {
203 carp 'Upgrade not possible as database is unversioned. Please call install first.';
207 if ( $db_version eq $schema_version ) {
209 carp "Upgrade not necessary\n";
213 my @version_list = $self->ordered_schema_versions ||
214 ( $db_version, $schema_version );
216 # remove all versions in list above the required version
217 while ( @version_list && ( $version_list[-1] ne $schema_version ) ) {
221 # remove all versions in list below the current version
222 while ( @version_list && ( $version_list[0] ne $db_version ) ) {
226 # check we have an appropriate list of versions
227 die if @version_list < 2;
230 while ( @version_list >= 2 ) {
231 $self->upgrade_single_step( $version_list[0], $version_list[1] );
236 method upgrade_single_step($db_version, $target_version) {
237 if ($db_version eq $target_version) {
239 carp "Upgrade not necessary\n";
243 my $upgrade_file = $self->ddl_filename(
244 $self->storage->sqlt_type,
246 $self->upgrade_directory,
250 $self->create_upgrade_path({ upgrade_file => $upgrade_file });
252 unless (-f $upgrade_file) {
254 carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
258 carp "DB version ($db_version) is lower than the schema version (".$self->schema_version."). Attempting upgrade.\n";
260 $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22
261 $self->backup if $self->do_backup;
262 $self->schema->txn_do(sub { $self->do_upgrade });
264 $self->version_rs->create({
265 version => $target_version,
267 # upgrade_sql => $upgrade_sql,
271 method create_ddl_dir($version, $preversion) {
272 my $schema = $self->schema;
273 my $databases = $self->databases;
274 my $dir = $self->upgrade_directory;
275 my $sqltargs = $self->sqltargs;
277 carp "Upgrade directory $dir does not exist, using ./\n";
281 my $schema_version = $schema->schema_version || '1.x';
282 $version ||= $schema_version;
286 ignore_constraint_names => 1,
287 ignore_index_names => 1,
291 my $sqlt = SQL::Translator->new( $sqltargs );
293 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
294 my $sqlt_schema = $sqlt->translate({ data => $schema })
295 or $self->throw_exception ($sqlt->error);
297 foreach my $db (@$databases) {
299 $sqlt->{schema} = $sqlt_schema;
300 $sqlt->producer($db);
302 my $filename = $self->ddl_filename($db, $version, $dir);
303 if (-e $filename && ($version eq $schema_version )) {
304 # if we are dumping the current version, overwrite the DDL
305 carp "Overwriting existing DDL file - $filename";
309 my $output = $sqlt->translate;
311 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
315 unless( open $file, q(>), $filename ) {
316 $self->throw_exception("Can't open $filename for writing ($!)");
319 print {$file} $output;
322 next unless $preversion;
324 require SQL::Translator::Diff;
326 my $prefilename = $self->ddl_filename($db, $preversion, $dir);
327 unless(-e $prefilename) {
328 carp("No previous schema file found ($prefilename)");
332 my $diff_file = $self->ddl_filename($db, $version, $dir, $preversion);
334 carp("Overwriting existing diff file - $diff_file");
340 my $t = SQL::Translator->new({
346 $t->parser( $db ) # could this really throw an exception?
347 or $self->throw_exception ($t->error);
349 my $out = $t->translate( $prefilename )
350 or $self->throw_exception ($t->error);
352 $source_schema = $t->schema;
354 $source_schema->name( $prefilename )
355 unless $source_schema->name;
358 # The "new" style of producers have sane normalization and can support
359 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
360 # And we have to diff parsed SQL against parsed SQL.
361 my $dest_schema = $sqlt_schema;
363 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
364 my $t = SQL::Translator->new({
370 $t->parser( $db ) # could this really throw an exception?
371 or $self->throw_exception ($t->error);
373 my $out = $t->translate( $filename )
374 or $self->throw_exception ($t->error);
376 $dest_schema = $t->schema;
378 $dest_schema->name( $filename )
379 unless $dest_schema->name;
382 my $diff = SQL::Translator::Diff::schema_diff(
387 unless(open $file, q(>), $diff_file) {
388 $self->throw_exception("Can't write to $diff_file ($!)");
396 method do_upgrade { $self->run_upgrade(qr/.*?/) }
398 method run_upgrade($stm) {
399 return unless $self->_filedata;
400 my @statements = grep { $_ =~ $stm } @{$self->_filedata};
403 $self->storage->debugobj->query_start($_) if $self->storage->debug;
404 $self->apply_statement($_);
405 $self->storage->debugobj->query_end($_) if $self->storage->debug;
409 method apply_statement($statement) {
411 $self->storage->dbh->do($_) or carp "SQL was: $_"
414 method _read_sql_file($file) {
417 open my $fh, '<', $file or carp("Can't open upgrade file, $file ($!)");
418 my @data = split /\n/, join '', <$fh>;
424 !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/m
435 vim: ts=2,sw=2,expandtab