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';
12 use Moose::Util::TypeConstraints;
13 subtype 'DBIx::Class::DeploymentHandler::Databases'
14 => as 'ArrayRef[Str]';
16 coerce 'DBIx::Class::DeploymentHandler::Databases'
19 no Moose::Util::TypeConstraints;
23 isa => 'DBIx::Class::Schema',
26 handles => [qw( ddl_filename schema_version )],
29 has upgrade_directory => (
36 has backup_directory => (
42 isa => 'DBIx::Class::Storage',
47 method _build_storage {
48 my $s = $self->schema->storage;
49 $s->_determine_driver;
54 isa => 'ArrayRef[Str]',
64 has do_diff_on_init => (
71 isa => 'DBIx::Class::ResultSet',
74 handles => [qw( is_installed db_version )],
79 isa => 'DBIx::Class::DeploymentHandler::Databases',
81 default => sub { [qw( MySQL SQLite PostgreSQL )] },
87 default => sub { {} },
90 sub deployment_statements {
91 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
92 $type ||= $self->storage->sqlt_type;
93 $version ||= $schema->schema_version || '1.x';
95 my $filename = $schema->ddl_filename($type, $version, $dir);
99 open($file, "<$filename")
100 or $self->throw_exception("Can't open $filename ($!)");
103 return join('', @rows);
106 # sources needs to be a parser arg, but for simplicty allow at top level
108 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
109 if exists $sqltargs->{sources};
111 my $tr = SQL::Translator->new(
112 producer => "SQL::Translator::Producer::${type}",
114 parser => 'SQL::Translator::Parser::DBIx::Class',
121 @ret = $tr->translate;
124 $ret[0] = $tr->translate;
127 $schema->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
128 unless (@ret && defined $ret[0]);
130 return $wa ? @ret : $ret[0];
134 my $schema = $self->schema;
136 my $sqltargs = $self->sqltargs;
137 my $dir = $self->upgrade_directory;
138 my $storage = $self->storage;
142 return if($line =~ /^--/);
144 # next if($line =~ /^DROP/m);
145 return if($line =~ /^BEGIN TRANSACTION/m);
146 return if($line =~ /^COMMIT/m);
147 return if $line =~ /^\s+$/; # skip whitespace only
148 $storage->_query_start($line);
150 # do a dbh_do cycle here, as we need some error checking in
151 # place (even though we will ignore errors)
152 $storage->dbh_do (sub { $_[1]->do($line) });
155 carp qq{$@ (running "${line}")}
157 $storage->_query_end($line);
159 my @statements = $self->deployment_statements($schema, $type, undef, $dir, { %{ $sqltargs || {} }, no_comments => 1 } );
160 if (@statements > 1) {
161 foreach my $statement (@statements) {
162 $deploy->( $statement );
165 elsif (@statements == 1) {
166 foreach my $line ( split(";\n", $statements[0])) {
172 method _build_version_rs {
173 $self->schema->set_us_up_the_bomb;
174 $self->schema->resultset('__VERSION')
177 method backup { $self->storage->backup($self->backup_directory) }
179 method install($new_version) {
180 carp 'Install not possible as versions table already exists in database'
181 if $self->is_installed;
183 $new_version ||= $self->schema_version;
188 $self->version_rs->create({
189 version => $new_version,
191 # upgrade_sql => $upgrade_sql,
196 method create_upgrade_path { }
198 method ordered_schema_versions { undef }
201 my $db_version = $self->db_version;
202 my $schema_version = $self->schema_version;
204 unless ($db_version) {
206 carp 'Upgrade not possible as database is unversioned. Please call install first.';
210 if ( $db_version eq $schema_version ) {
212 carp "Upgrade not necessary\n";
216 my @version_list = $self->ordered_schema_versions ||
217 ( $db_version, $schema_version );
219 # remove all versions in list above the required version
220 while ( @version_list && ( $version_list[-1] ne $schema_version ) ) {
224 # remove all versions in list below the current version
225 while ( @version_list && ( $version_list[0] ne $db_version ) ) {
229 # check we have an appropriate list of versions
230 die if @version_list < 2;
233 while ( @version_list >= 2 ) {
234 $self->upgrade_single_step( $version_list[0], $version_list[1] );
239 method upgrade_single_step($db_version, $target_version) {
240 if ($db_version eq $target_version) {
242 carp "Upgrade not necessary\n";
246 my $upgrade_file = $self->ddl_filename(
247 $self->storage->sqlt_type,
249 $self->upgrade_directory,
253 $self->create_upgrade_path({ upgrade_file => $upgrade_file });
255 unless (-f $upgrade_file) {
257 carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
261 carp "DB version ($db_version) is lower than the schema version (".$self->schema_version."). Attempting upgrade.\n";
263 $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22
264 $self->backup if $self->do_backup;
265 $self->schema->txn_do(sub { $self->do_upgrade });
267 $self->version_rs->create({
268 version => $target_version,
270 # upgrade_sql => $upgrade_sql,
274 method create_ddl_dir($version, $preversion) {
275 my $schema = $self->schema;
276 my $databases = $self->databases;
277 my $dir = $self->upgrade_directory;
278 my $sqltargs = $self->sqltargs;
280 carp "Upgrade directory $dir does not exist, using ./\n";
284 my $schema_version = $schema->schema_version || '1.x';
285 $version ||= $schema_version;
289 ignore_constraint_names => 1,
290 ignore_index_names => 1,
294 my $sqlt = SQL::Translator->new( $sqltargs );
296 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
297 my $sqlt_schema = $sqlt->translate({ data => $schema })
298 or $self->throw_exception ($sqlt->error);
300 foreach my $db (@$databases) {
302 $sqlt->{schema} = $sqlt_schema;
303 $sqlt->producer($db);
305 my $filename = $self->ddl_filename($db, $version, $dir);
306 if (-e $filename && ($version eq $schema_version )) {
307 # if we are dumping the current version, overwrite the DDL
308 carp "Overwriting existing DDL file - $filename";
312 my $output = $sqlt->translate;
314 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
318 unless( open $file, q(>), $filename ) {
319 $self->throw_exception("Can't open $filename for writing ($!)");
322 print {$file} $output;
325 next unless $preversion;
327 require SQL::Translator::Diff;
329 my $prefilename = $self->ddl_filename($db, $preversion, $dir);
330 unless(-e $prefilename) {
331 carp("No previous schema file found ($prefilename)");
335 my $diff_file = $self->ddl_filename($db, $version, $dir, $preversion);
337 carp("Overwriting existing diff file - $diff_file");
343 my $t = SQL::Translator->new({
349 $t->parser( $db ) # could this really throw an exception?
350 or $self->throw_exception ($t->error);
352 my $out = $t->translate( $prefilename )
353 or $self->throw_exception ($t->error);
355 $source_schema = $t->schema;
357 $source_schema->name( $prefilename )
358 unless $source_schema->name;
361 # The "new" style of producers have sane normalization and can support
362 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
363 # And we have to diff parsed SQL against parsed SQL.
364 my $dest_schema = $sqlt_schema;
366 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
367 my $t = SQL::Translator->new({
373 $t->parser( $db ) # could this really throw an exception?
374 or $self->throw_exception ($t->error);
376 my $out = $t->translate( $filename )
377 or $self->throw_exception ($t->error);
379 $dest_schema = $t->schema;
381 $dest_schema->name( $filename )
382 unless $dest_schema->name;
385 my $diff = SQL::Translator::Diff::schema_diff(
390 unless(open $file, q(>), $diff_file) {
391 $self->throw_exception("Can't write to $diff_file ($!)");
399 method do_upgrade { $self->run_upgrade(qr/.*?/) }
401 method run_upgrade($stm) {
402 return unless $self->_filedata;
403 my @statements = grep { $_ =~ $stm } @{$self->_filedata};
406 $self->storage->debugobj->query_start($_) if $self->storage->debug;
407 $self->apply_statement($_);
408 $self->storage->debugobj->query_end($_) if $self->storage->debug;
412 method apply_statement($statement) {
414 $self->storage->dbh->do($_) or carp "SQL was: $_"
417 method _read_sql_file($file) {
420 open my $fh, '<', $file or carp("Can't open upgrade file, $file ($!)");
421 my @data = split /\n/, join '', <$fh>;
427 !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/m
438 vim: ts=2,sw=2,expandtab