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
11 isa => 'DBIx::Class::Schema',
14 handles => [qw{schema_version}],
17 has upgrade_directory => (
24 has backup_directory => (
30 isa => 'DBIx::Class::Storage',
35 method _build_storage { $self->schema->storage }
48 has do_diff_on_init => (
55 isa => 'DBIx::Class::ResultSet',
58 handles => [qw( is_installed db_version )],
61 method _build_version_rs { $self->schema->resultset('VersionResult') }
63 method backup { $self->storage->backup($self->backup_directory) }
65 method install($new_version) {
66 carp 'Install not possible as versions table already exists in database'
67 unless $self->is_installed;
69 $new_version ||= $self->schema_version;
72 $self->schema->deploy;
74 $self->version_rs->create({
75 version => $new_version,
77 # upgrade_sql => $upgrade_sql,
82 method create_upgrade_path { }
84 method ordered_schema_versions { }
87 my $db_version = $self->db_version;
88 my $schema_version = $self->schema_version;
90 unless ($db_version) {
91 carp 'Upgrade not possible as database is unversioned. Please call install first.';
95 if ( $db_version eq $schema_version ) {
96 carp "Upgrade not necessary\n";
100 my @version_list = $self->ordered_schema_versions ||
101 ( $db_version, $schema_version );
103 # remove all versions in list above the required version
104 while ( @version_list && ( $version_list[-1] ne $schema_version ) ) {
108 # remove all versions in list below the current version
109 while ( @version_list && ( $version_list[0] ne $db_version ) ) {
113 # check we have an appropriate list of versions
114 die if @version_list < 2;
117 while ( @version_list >= 2 ) {
118 $self->upgrade_single_step( $version_list[0], $version_list[1] );
123 method upgrade_single_step($db_version, $target_version) {
124 if ($db_version eq $target_version) {
125 carp "Upgrade not necessary\n";
129 # strangely the first time this is called can
130 # differ to subsequent times. so we call it
133 $self->storage->sqlt_type;
135 my $upgrade_file = $self->ddl_filename(
136 $self->storage->sqlt_type,
138 $self->upgrade_directory,
142 $self->create_upgrade_path({ upgrade_file => $upgrade_file });
144 unless (-f $upgrade_file) {
145 carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
149 carp "DB version ($db_version) is lower than the schema version (".$self->schema_version."). Attempting upgrade.\n";
151 # backup if necessary then apply upgrade
152 $self->_filedata($self->_read_sql_file($upgrade_file));
153 $self->backup if $self->do_backup;
154 $self->schema->txn_do(sub { $self->do_upgrade });
156 # set row in dbix_class_schema_versions table
157 $self->version_rs->create({
158 version => $target_version,
160 # upgrade_sql => $upgrade_sql,
164 method do_upgrade { $self->run_upgrade(qr/.*?/) }
166 method run_upgrade($stm) {
167 return unless $self->_filedata;
168 my @statements = grep { $_ =~ $stm } @{$self->_filedata};
171 $self->storage->debugobj->query_start($_) if $self->storage->debug;
172 $self->apply_statement($_);
173 $self->storage->debugobj->query_end($_) if $self->storage->debug;
177 method apply_statement($statement) {
178 $self->storage->dbh->do($_) or carp "SQL was: $_"
181 sub _create_db_to_schema_diff {
184 my %driver_to_db_map = (
188 my $db = $driver_to_db_map{$self->storage->dbh->{Driver}{Name}};
190 print "Sorry, this is an unsupported DB\n";
194 $self->throw_exception($self->storage->_sqlt_version_error)
195 unless $self->storage->_sqlt_version_ok;
197 my $db_tr = SQL::Translator->new({
200 parser_args => { dbh => $self->storage->dbh },
204 my $dbic_tr = SQL::Translator->new({
205 parser => 'SQL::Translator::Parser::DBIx::Class',
210 $db_tr->schema->name('db_schema');
211 $dbic_tr->schema->name('dbic_schema');
213 # is this really necessary?
214 foreach my $tr ($db_tr, $dbic_tr) {
215 my $data = $tr->data;
216 $tr->parser->($tr, $$data);
219 my $diff = SQL::Translator::Diff::schema_diff(
221 $dbic_tr->schema, $db, {
222 ignore_constraint_names => 1,
223 ignore_index_names => 1,
228 my $filename = $self->ddl_filename(
230 $self->schema_version,
231 $self->upgrade_directory,
235 open my $file, '>', $filename
236 or $self->throw_exception("Can't open $filename for writing ($!)");
240 carp "WARNING: There may be differences between your DB and your DBIC schema.\n" .
241 "Please review and if necessary run the SQL in $filename to sync your DB.\n";
244 method _read_sql_file($file) {
247 open my $fh, '<', $file or carp("Can't open upgrade file, $file ($!)");
248 my @data = split /\n/, join '', <$fh>;
254 !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/m