1 package DBIx::Class::DeploymentHandler::Dad;
3 # ABSTRACT: Parent class for DeploymentHandlers
6 require DBIx::Class::Schema; # loaded for type constraint
7 use Carp::Clan '^DBIx::Class::DeploymentHandler';
8 use DBIx::Class::DeploymentHandler::Logger;
9 use DBIx::Class::DeploymentHandler::Types;
10 use Log::Contextual ':log', -package_logger =>
11 DBIx::Class::DeploymentHandler::Logger->new({
12 env_prefix => 'DBICDH'
20 has backup_directory => (
23 predicate => 'has_backup_directory',
32 sub _build_to_version { $_[0]->schema_version }
34 has schema_version => (
36 isa => 'StrSchemaVersion',
40 sub _build_schema_version { $_[0]->schema->schema_version }
45 my $version = (shift @_ || {})->{version} || $self->to_version;
46 log_info { "installing version $version" };
47 croak 'Install not possible as versions table already exists in database'
48 if $self->version_storage_is_installed;
51 my $ddl = $self->deploy({ version=> $version });
53 $self->add_database_version({
61 log_info { 'upgrading' };
65 while ( my $version_list = $self->next_version_set ) {
67 my ($ddl, $upgrade_sql) = @{
68 $self->upgrade_single_step({ version_set => $version_list })
71 $self->add_database_version({
72 version => $version_list->[-1],
74 upgrade_sql => $upgrade_sql,
79 log_warn { 'no need to run upgrade' } unless $ran_once;
83 log_info { 'downgrading' };
87 while ( my $version_list = $self->previous_version_set ) {
89 $self->downgrade_single_step({ version_set => $version_list });
91 # do we just delete a row here? I think so but not sure
92 $self->delete_database_version({ version => $version_list->[0] });
95 log_warn { 'no version to run downgrade' } unless $ran_once;
100 log_info { 'backing up' };
101 $self->schema->storage->backup($self->backup_directory)
104 __PACKAGE__->meta->make_immutable;
108 # vim: ts=2 sw=2 expandtab
116 The L<DBIx::Class::Schema> (B<required>) that is used to talk to the database
117 and generate the DDL.
121 The version that the schema is currently at. Defaults to
122 C<< $self->schema->schema_version >>.
124 =attr backup_directory
126 The directory where backups are stored
130 The version (defaults to schema's version) to migrate the database to
138 $dh->install({ version => 1 })
140 Deploys the requested version into the database Version defaults to
141 L</schema_version>. Populates C<version_storage> with C<version> and C<ddl>.
143 B<Note>: you typically need to call C<< $dh->prepare_deploy >> before you call
146 B<Note>: you cannot install on top of an already installed database
152 Upgrades the database one step at a time till L</next_version_set>
153 returns C<undef>. Each upgrade step will add a C<version>, C<ddl>, and
154 C<upgrade_sql> to the version storage (if C<ddl> and/or C<upgrade_sql> are
155 returned from L</upgrade_single_step>.
161 Downgrades the database one step at a time till L</previous_version_set>
162 returns C<undef>. Each downgrade step will delete a C<version> from the
169 Simply calls backup on the C<< $schema->storage >>, passing in
170 C<< $self->backup_directory >> as an argument. Please test yourself before
171 assuming it will work.
173 =head1 METHODS THAT ARE REQUIRED IN SUBCLASSES
177 See L<DBIx::Class::DeploymentHandler::HandlesDeploy/deploy>.
179 =head2 version_storage_is_installed
181 See L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/version_storage_is_installed>.
183 =head2 add_database_version
185 See L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/add_database_version>.
187 =head2 delete_database_version
189 See L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/delete_database_version>.
191 =head2 next_version_set
193 See L<DBIx::Class::DeploymentHandler::HandlesVersioning/next_version_set>.
195 =head2 previous_version_set
197 See L<DBIx::Class::DeploymentHandler::HandlesVersioning/previous_version_set>.
199 =head2 upgrade_single_step
201 See L<DBIx::Class::DeploymentHandler::HandlesDeploy/upgrade_single_step>.
203 =head2 downgrade_single_step
205 See L<DBIx::Class::DeploymentHandler::HandlesDeploy/downgrade_single_step>.
209 See L<DBIx::Class::DeploymentHandler::HandlesDeploy/txn_do>.
211 =head1 ORTHODOX METHODS
213 These methods are not actually B<required> as things will probably still work
214 if you don't implement them, but if you want your subclass to get along with
215 other subclasses (or more likely, tools made to use another subclass), you
216 should probably implement these too, even if they are no-ops.
218 =head2 database_version
220 see L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/database_version>
222 =head2 prepare_deploy
224 see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_deploy>
226 =head2 prepare_resultsource_install
228 see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_resultsource_install>
230 =head2 install_resultsource
232 see L<DBIx::Class::DeploymentHandler::HandlesDeploy/install_resultsource>
234 =head2 prepare_upgrade
236 see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_upgrade>
238 =head2 prepare_downgrade
240 see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_downgrade>
244 All of the methods mentioned in L</METHODS THAT ARE REQUIRED IN SUBCLASSES> and
245 L</ORTHODOX METHODS> can be implemented in any fashion you choose. In the
246 spirit of code reuse I have used roles to implement them in my two subclasses,
247 L<DBIx::Class::DeploymentHandler> and
248 L<DBIx::Class::DeploymentHandler::Deprecated>, but you are free to implement
249 them entirely in a subclass if you so choose to.
251 For in-depth documentation on how methods are supposed to work, see the roles
252 L<DBIx::Class::DeploymentHandler::HandlesDeploy>,
253 L<DBIx::Class::DeploymentHandler::HandlesVersioning>, and
254 L<DBIx::Class::DeploymentHandler::HandlesVersionStorage>.