1 package DBIx::Class::DeploymentHandler::Dad;
3 # ABSTRACT: Parent class for DeploymentHandlers
6 use Method::Signatures::Simple;
7 require DBIx::Class::Schema; # loaded for type constraint
8 use Carp::Clan '^DBIx::Class::DeploymentHandler';
11 isa => 'DBIx::Class::Schema',
16 has backup_directory => (
19 predicate => 'has_backup_directory',
27 sub _build_to_version { $_[0]->schema_version }
29 has schema_version => (
34 sub _build_schema_version { $_[0]->schema->schema_version }
37 croak 'Install not possible as versions table already exists in database'
38 if $self->version_storage_is_installed;
40 my $ddl = $self->deploy;
42 $self->add_database_version({
43 version => $self->to_version,
50 while ( my $version_list = $self->next_version_set ) {
51 my ($ddl, $upgrade_sql) = @{$self->upgrade_single_step($version_list)||[]};
53 $self->add_database_version({
54 version => $version_list->[-1],
56 upgrade_sql => $upgrade_sql,
63 while ( my $version_list = $self->previous_version_set ) {
64 $self->downgrade_single_step($version_list);
66 # do we just delete a row here? I think so but not sure
67 $self->delete_database_version({ version => $version_list->[-1] });
71 method backup { $self->storage->backup($self->backup_directory) }
73 __PACKAGE__->meta->make_immutable;
77 # vim: ts=2 sw=2 expandtab
85 The L<DBIx::Class::Schema> (B<required>) that is used to talk to the database
90 The version that the schema is currently at. Defaults to
91 C<< $self->schema->schema_version >>.
93 =attr backup_directory
95 The directory where backups are stored
99 The version (defaults to schema's version) to migrate the database to
105 Deploys the current schema into the database. Populates C<version_storage> with
106 C<version> and C<ddl>.
108 B<Note>: you typically need to call C<< $dh->prepare_deploy >> before you call
111 B<Note>: you cannot install on top of an already installed database
117 Upgrades the database one step at a time till L</next_version_set>
118 returns C<undef>. Each upgrade step will add a C<version>, C<ddl>, and
119 C<upgrade_sql> to the version storage (if C<ddl> and/or C<upgrade_sql> are
120 returned from L</upgrade_single_step>.
126 Downgrades the database one step at a time till L</previous_version_set>
127 returns C<undef>. Each downgrade step will delete a C<version> from the
134 Simply calls backup on the C<< $schema->storage >>, passing in
135 C<< $self->backup_directory >> as an argument. Please test yourself before
136 assuming it will work.
138 =head1 METHODS THAT ARE REQUIRED IN SUBCLASSES
142 See L<DBIx::Class::DeploymentHandler::HandlesDeploy/deploy>.
144 =head2 version_storage_is_installed
146 See L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/version_storage_is_installed>.
148 =head2 add_database_version
150 See L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/add_database_version>.
152 =head2 delete_database_version
154 See L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/delete_database_version>.
156 =head2 next_version_set
158 See L<DBIx::Class::DeploymentHandler::HandlesVersioning/next_version_set>.
160 =head2 previous_version_set
162 See L<DBIx::Class::DeploymentHandler::HandlesVersioning/previous_version_set>.
164 =head2 upgrade_single_step
166 See L<DBIx::Class::DeploymentHandler::HandlesDeploy/upgrade_single_step>.
168 =head2 downgrade_single_step
170 See L<DBIx::Class::DeploymentHandler::HandlesDeploy/downgrade_single_step>.
172 =head1 ORTHODOX METHODS
174 These methods are not actually B<required> as things will probably still work
175 if you don't implement them, but if you want your subclass to get along with
176 other subclasses (or more likely, tools made to use another subclass), you
177 should probably implement these too, even if they are no-ops.
179 =head2 database_version
181 see L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/database_version>
183 =head2 prepare_deploy
185 see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_deploy>
187 =head2 prepare_resultsource_install
189 see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_resultsource_install>
191 =head2 install_resultsource
193 see L<DBIx::Class::DeploymentHandler::HandlesDeploy/install_resultsource>
195 =head2 prepare_upgrade
197 see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_upgrade>
199 =head2 prepare_downgrade
201 see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_downgrade>
205 All of the methods mentioned in L</METHODS THAT ARE REQUIRED IN SUBCLASSES> and
206 L</ORTHODOX METHODS> can be implemented in any fashion you choose. In the
207 spirit of code reuse I have used roles to implement them in my two subclasses,
208 L<DBIx::Class::DeploymentHandler> and
209 L<DBIx::Class::DeploymentHandler::Deprecated>, but you are free to implement
210 them entirely in a subclass if you so choose to.
212 For in-depth documentation on how methods are supposed to work, see the roles
213 L<DBIx::Class::DeploymentHandler::HandlesDeploy>,
214 L<DBIx::Class::DeploymentHandler::HandlesVersioning>, and
215 L<DBIx::Class::DeploymentHandler::HandlesVersionStorage>.