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 isa => 'DBIx::Class::Schema',
15 handles => [qw( ddl_filename schema_version )],
18 has upgrade_directory => (
25 has backup_directory => (
31 isa => 'DBIx::Class::Storage',
36 method _build_storage {
37 my $s = $self->schema->storage;
38 $s->_determine_driver;
43 isa => 'ArrayRef[Str]',
53 has do_diff_on_init => (
60 isa => 'DBIx::Class::ResultSet',
63 handles => [qw( is_installed db_version )],
67 # make this coerce from Str
68 isa => 'ArrayRef[Str]',
70 default => sub { [qw( MySQL SQLite PostgreSQL )] },
76 default => sub { {} },
79 method _build_version_rs {
80 $self->schema->set_us_up_the_bomb;
81 $self->schema->resultset('__VERSION')
84 method backup { $self->storage->backup($self->backup_directory) }
86 method install($new_version) {
87 carp 'Install not possible as versions table already exists in database'
88 if $self->is_installed;
90 $new_version ||= $self->schema_version;
93 $self->schema->deploy;
95 $self->version_rs->create({
96 version => $new_version,
98 # upgrade_sql => $upgrade_sql,
103 method create_upgrade_path { }
105 method ordered_schema_versions { undef }
108 my $db_version = $self->db_version;
109 my $schema_version = $self->schema_version;
111 unless ($db_version) {
113 carp 'Upgrade not possible as database is unversioned. Please call install first.';
117 if ( $db_version eq $schema_version ) {
119 carp "Upgrade not necessary\n";
123 my @version_list = $self->ordered_schema_versions ||
124 ( $db_version, $schema_version );
126 # remove all versions in list above the required version
127 while ( @version_list && ( $version_list[-1] ne $schema_version ) ) {
131 # remove all versions in list below the current version
132 while ( @version_list && ( $version_list[0] ne $db_version ) ) {
136 # check we have an appropriate list of versions
137 die if @version_list < 2;
140 while ( @version_list >= 2 ) {
141 $self->upgrade_single_step( $version_list[0], $version_list[1] );
146 method upgrade_single_step($db_version, $target_version) {
147 if ($db_version eq $target_version) {
149 carp "Upgrade not necessary\n";
153 my $upgrade_file = $self->ddl_filename(
154 $self->storage->sqlt_type,
156 $self->upgrade_directory,
160 $self->create_upgrade_path({ upgrade_file => $upgrade_file });
162 unless (-f $upgrade_file) {
164 carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
168 carp "DB version ($db_version) is lower than the schema version (".$self->schema_version."). Attempting upgrade.\n";
170 $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22
171 $self->backup if $self->do_backup;
172 $self->schema->txn_do(sub { $self->do_upgrade });
174 $self->version_rs->create({
175 version => $target_version,
177 # upgrade_sql => $upgrade_sql,
181 method create_ddl_dir($version, $preversion) {
182 my $schema = $self->schema;
183 my $databases = $self->databases;
184 my $dir = $self->upgrade_directory;
185 my $sqltargs = $self->sqltargs;
187 carp "Upgrade directory $dir does not exist, using ./\n";
191 my $schema_version = $schema->schema_version || '1.x';
192 $version ||= $schema_version;
196 ignore_constraint_names => 1,
197 ignore_index_names => 1,
201 my $sqlt = SQL::Translator->new( $sqltargs );
203 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
204 my $sqlt_schema = $sqlt->translate({ data => $schema })
205 or $self->throw_exception ($sqlt->error);
207 foreach my $db (@$databases) {
209 $sqlt->{schema} = $sqlt_schema;
210 $sqlt->producer($db);
212 my $filename = $self->ddl_filename($db, $version, $dir);
213 if (-e $filename && ($version eq $schema_version )) {
214 # if we are dumping the current version, overwrite the DDL
215 carp "Overwriting existing DDL file - $filename";
219 my $output = $sqlt->translate;
221 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
225 unless( open $file, q(>), $filename ) {
226 $self->throw_exception("Can't open $filename for writing ($!)");
229 print {$file} $output;
232 next unless $preversion;
234 require SQL::Translator::Diff;
236 my $prefilename = $self->ddl_filename($db, $preversion, $dir);
237 unless(-e $prefilename) {
238 carp("No previous schema file found ($prefilename)");
242 my $diff_file = $self->ddl_filename($db, $version, $dir, $preversion);
244 carp("Overwriting existing diff file - $diff_file");
250 my $t = SQL::Translator->new({
256 $t->parser( $db ) # could this really throw an exception?
257 or $self->throw_exception ($t->error);
259 my $out = $t->translate( $prefilename )
260 or $self->throw_exception ($t->error);
262 $source_schema = $t->schema;
264 $source_schema->name( $prefilename )
265 unless $source_schema->name;
268 # The "new" style of producers have sane normalization and can support
269 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
270 # And we have to diff parsed SQL against parsed SQL.
271 my $dest_schema = $sqlt_schema;
273 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
274 my $t = SQL::Translator->new({
280 $t->parser( $db ) # could this really throw an exception?
281 or $self->throw_exception ($t->error);
283 my $out = $t->translate( $filename )
284 or $self->throw_exception ($t->error);
286 $dest_schema = $t->schema;
288 $dest_schema->name( $filename )
289 unless $dest_schema->name;
292 my $diff = SQL::Translator::Diff::schema_diff(
297 unless(open $file, q(>), $diff_file) {
298 $self->throw_exception("Can't write to $diff_file ($!)");
306 method do_upgrade { $self->run_upgrade(qr/.*?/) }
308 method run_upgrade($stm) {
309 return unless $self->_filedata;
310 my @statements = grep { $_ =~ $stm } @{$self->_filedata};
313 $self->storage->debugobj->query_start($_) if $self->storage->debug;
314 $self->apply_statement($_);
315 $self->storage->debugobj->query_end($_) if $self->storage->debug;
319 method apply_statement($statement) {
321 $self->storage->dbh->do($_) or carp "SQL was: $_"
324 method _read_sql_file($file) {
327 open my $fh, '<', $file or carp("Can't open upgrade file, $file ($!)");
328 my @data = split /\n/, join '', <$fh>;
334 !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/m
345 vim: ts=2,sw=2,expandtab