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'
16 isa => 'DBIx::Class::Schema',
21 has backup_directory => (
24 predicate => 'has_backup_directory',
33 sub _build_to_version { $_[0]->schema_version }
35 has schema_version => (
37 isa => 'StrSchemaVersion',
41 sub _build_schema_version { $_[0]->schema->schema_version }
46 my $version = (shift @_ || {})->{version} || $self->to_version;
47 log_info { "installing version $version" };
48 croak 'Install not possible as versions table already exists in database'
49 if $self->version_storage_is_installed;
52 my $ddl = $self->deploy({ version=> $version });
54 $self->add_database_version({
55 version => $self->to_version,
62 log_info { 'upgrading' };
66 while ( my $version_list = $self->next_version_set ) {
68 my ($ddl, $upgrade_sql) = @{
69 $self->upgrade_single_step({ version_set => $version_list })
72 $self->add_database_version({
73 version => $version_list->[-1],
75 upgrade_sql => $upgrade_sql,
80 log_warn { 'no need to run upgrade' } unless $ran_once;
84 log_info { 'downgrading' };
88 while ( my $version_list = $self->previous_version_set ) {
90 $self->downgrade_single_step({ version_set => $version_list });
92 # do we just delete a row here? I think so but not sure
93 $self->delete_database_version({ version => $version_list->[0] });
96 log_warn { 'no version to run downgrade' } unless $ran_once;
101 log_info { 'backing up' };
102 $self->schema->storage->backup($self->backup_directory)
105 __PACKAGE__->meta->make_immutable;
109 # vim: ts=2 sw=2 expandtab
117 The L<DBIx::Class::Schema> (B<required>) that is used to talk to the database
118 and generate the DDL.
122 The version that the schema is currently at. Defaults to
123 C<< $self->schema->schema_version >>.
125 =attr backup_directory
127 The directory where backups are stored
131 The version (defaults to schema's version) to migrate the database to
139 $dh->install({ version => 1 })
141 Deploys the requested version into the database Version defaults to
142 L</schema_version>. Populates C<version_storage> with C<version> and C<ddl>.
144 B<Note>: you typically need to call C<< $dh->prepare_deploy >> before you call
147 B<Note>: you cannot install on top of an already installed database
153 Upgrades the database one step at a time till L</next_version_set>
154 returns C<undef>. Each upgrade step will add a C<version>, C<ddl>, and
155 C<upgrade_sql> to the version storage (if C<ddl> and/or C<upgrade_sql> are
156 returned from L</upgrade_single_step>.
162 Downgrades the database one step at a time till L</previous_version_set>
163 returns C<undef>. Each downgrade step will delete a C<version> from the
170 Simply calls backup on the C<< $schema->storage >>, passing in
171 C<< $self->backup_directory >> as an argument. Please test yourself before
172 assuming it will work.
174 =head1 METHODS THAT ARE REQUIRED IN SUBCLASSES
178 See L<DBIx::Class::DeploymentHandler::HandlesDeploy/deploy>.
180 =head2 version_storage_is_installed
182 See L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/version_storage_is_installed>.
184 =head2 add_database_version
186 See L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/add_database_version>.
188 =head2 delete_database_version
190 See L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/delete_database_version>.
192 =head2 next_version_set
194 See L<DBIx::Class::DeploymentHandler::HandlesVersioning/next_version_set>.
196 =head2 previous_version_set
198 See L<DBIx::Class::DeploymentHandler::HandlesVersioning/previous_version_set>.
200 =head2 upgrade_single_step
202 See L<DBIx::Class::DeploymentHandler::HandlesDeploy/upgrade_single_step>.
204 =head2 downgrade_single_step
206 See L<DBIx::Class::DeploymentHandler::HandlesDeploy/downgrade_single_step>.
210 See L<DBIx::Class::DeploymentHandler::HandlesDeploy/txn_do>.
212 =head1 ORTHODOX METHODS
214 These methods are not actually B<required> as things will probably still work
215 if you don't implement them, but if you want your subclass to get along with
216 other subclasses (or more likely, tools made to use another subclass), you
217 should probably implement these too, even if they are no-ops.
219 =head2 database_version
221 see L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/database_version>
223 =head2 prepare_deploy
225 see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_deploy>
227 =head2 prepare_resultsource_install
229 see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_resultsource_install>
231 =head2 install_resultsource
233 see L<DBIx::Class::DeploymentHandler::HandlesDeploy/install_resultsource>
235 =head2 prepare_upgrade
237 see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_upgrade>
239 =head2 prepare_downgrade
241 see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_downgrade>
245 All of the methods mentioned in L</METHODS THAT ARE REQUIRED IN SUBCLASSES> and
246 L</ORTHODOX METHODS> can be implemented in any fashion you choose. In the
247 spirit of code reuse I have used roles to implement them in my two subclasses,
248 L<DBIx::Class::DeploymentHandler> and
249 L<DBIx::Class::DeploymentHandler::Deprecated>, but you are free to implement
250 them entirely in a subclass if you so choose to.
252 For in-depth documentation on how methods are supposed to work, see the roles
253 L<DBIx::Class::DeploymentHandler::HandlesDeploy>,
254 L<DBIx::Class::DeploymentHandler::HandlesVersioning>, and
255 L<DBIx::Class::DeploymentHandler::HandlesVersionStorage>.