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';
11 isa => 'DBIx::Class::Schema',
14 handles => [qw( schema_version )],
17 has upgrade_directory => (
21 default => 'upgrades',
24 has backup_directory => (
30 isa => 'DBIx::Class::Storage',
35 method _build_storage {
36 my $s = $self->schema->storage;
37 $s->_determine_driver;
52 has do_diff_on_init => (
59 isa => 'DBIx::Class::ResultSet',
62 handles => [qw( is_installed db_version )],
65 method _build_version_rs { $self->schema->resultset('VersionResult') }
67 method backup { $self->storage->backup($self->backup_directory) }
69 method create_ddl_dir { $self->storage->create_ddl_dir( $self->schema, @_ ) }
71 method install($new_version) {
72 carp 'Install not possible as versions table already exists in database'
73 if $self->is_installed;
75 $new_version ||= $self->schema_version;
78 $self->schema->deploy;
80 $self->version_rs->create({
81 version => $new_version,
83 # upgrade_sql => $upgrade_sql,
88 method create_upgrade_path { }
90 method ordered_schema_versions { }
93 my $db_version = $self->db_version;
94 my $schema_version = $self->schema_version;
96 unless ($db_version) {
98 carp 'Upgrade not possible as database is unversioned. Please call install first.';
102 if ( $db_version eq $schema_version ) {
104 carp "Upgrade not necessary\n";
108 my @version_list = $self->ordered_schema_versions ||
109 ( $db_version, $schema_version );
111 # remove all versions in list above the required version
112 while ( @version_list && ( $version_list[-1] ne $schema_version ) ) {
116 # remove all versions in list below the current version
117 while ( @version_list && ( $version_list[0] ne $db_version ) ) {
121 # check we have an appropriate list of versions
122 die if @version_list < 2;
125 while ( @version_list >= 2 ) {
126 $self->upgrade_single_step( $version_list[0], $version_list[1] );
131 method upgrade_single_step($db_version, $target_version) {
132 if ($db_version eq $target_version) {
134 carp "Upgrade not necessary\n";
138 my $upgrade_file = $self->ddl_filename(
139 $self->storage->sqlt_type,
141 $self->upgrade_directory,
145 $self->create_upgrade_path({ upgrade_file => $upgrade_file });
147 unless (-f $upgrade_file) {
149 carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
153 carp "DB version ($db_version) is lower than the schema version (".$self->schema_version."). Attempting upgrade.\n";
155 $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22
156 $self->backup if $self->do_backup;
157 $self->schema->txn_do(sub { $self->do_upgrade });
159 $self->version_rs->create({
160 version => $target_version,
162 # upgrade_sql => $upgrade_sql,
166 method do_upgrade { $self->run_upgrade(qr/.*?/) }
168 method run_upgrade($stm) {
169 return unless $self->_filedata;
170 my @statements = grep { $_ =~ $stm } @{$self->_filedata};
173 $self->storage->debugobj->query_start($_) if $self->storage->debug;
174 $self->apply_statement($_);
175 $self->storage->debugobj->query_end($_) if $self->storage->debug;
179 method apply_statement($statement) {
181 $self->storage->dbh->do($_) or carp "SQL was: $_"
184 method _read_sql_file($file) {
187 open my $fh, '<', $file or carp("Can't open upgrade file, $file ($!)");
188 my @data = split /\n/, join '', <$fh>;
194 !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/m
205 vim: ts=2,sw=2,expandtab