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',
28 sub _build_to_version { $_[0]->schema_version }
30 has schema_version => (
36 sub _build_schema_version { $_[0]->schema->schema_version }
39 croak 'Install not possible as versions table already exists in database'
40 if $self->version_storage_is_installed;
42 my $ddl = $self->deploy;
44 $self->add_database_version({
45 version => $self->to_version,
52 while ( my $version_list = $self->next_version_set ) {
53 my ($ddl, $upgrade_sql) = @{
54 $self->upgrade_single_step({ version_set => $version_list })
57 $self->add_database_version({
58 version => $version_list->[-1],
60 upgrade_sql => $upgrade_sql,
67 while ( my $version_list = $self->previous_version_set ) {
68 $self->downgrade_single_step({ version_set => $version_list });
70 # do we just delete a row here? I think so but not sure
71 $self->delete_database_version({ version => $version_list->[-1] });
75 method backup { $self->storage->backup($self->backup_directory) }
77 __PACKAGE__->meta->make_immutable;
81 # vim: ts=2 sw=2 expandtab
89 The L<DBIx::Class::Schema> (B<required>) that is used to talk to the database
94 The version that the schema is currently at. Defaults to
95 C<< $self->schema->schema_version >>.
97 =attr backup_directory
99 The directory where backups are stored
103 The version (defaults to schema's version) to migrate the database to
109 Deploys the current schema into the database. Populates C<version_storage> with
110 C<version> and C<ddl>.
112 B<Note>: you typically need to call C<< $dh->prepare_deploy >> before you call
115 B<Note>: you cannot install on top of an already installed database
121 Upgrades the database one step at a time till L</next_version_set>
122 returns C<undef>. Each upgrade step will add a C<version>, C<ddl>, and
123 C<upgrade_sql> to the version storage (if C<ddl> and/or C<upgrade_sql> are
124 returned from L</upgrade_single_step>.
130 Downgrades the database one step at a time till L</previous_version_set>
131 returns C<undef>. Each downgrade step will delete a C<version> from the
138 Simply calls backup on the C<< $schema->storage >>, passing in
139 C<< $self->backup_directory >> as an argument. Please test yourself before
140 assuming it will work.
142 =head1 METHODS THAT ARE REQUIRED IN SUBCLASSES
146 See L<DBIx::Class::DeploymentHandler::HandlesDeploy/deploy>.
148 =head2 version_storage_is_installed
150 See L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/version_storage_is_installed>.
152 =head2 add_database_version
154 See L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/add_database_version>.
156 =head2 delete_database_version
158 See L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/delete_database_version>.
160 =head2 next_version_set
162 See L<DBIx::Class::DeploymentHandler::HandlesVersioning/next_version_set>.
164 =head2 previous_version_set
166 See L<DBIx::Class::DeploymentHandler::HandlesVersioning/previous_version_set>.
168 =head2 upgrade_single_step
170 See L<DBIx::Class::DeploymentHandler::HandlesDeploy/upgrade_single_step>.
172 =head2 downgrade_single_step
174 See L<DBIx::Class::DeploymentHandler::HandlesDeploy/downgrade_single_step>.
176 =head1 ORTHODOX METHODS
178 These methods are not actually B<required> as things will probably still work
179 if you don't implement them, but if you want your subclass to get along with
180 other subclasses (or more likely, tools made to use another subclass), you
181 should probably implement these too, even if they are no-ops.
183 =head2 database_version
185 see L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/database_version>
187 =head2 prepare_deploy
189 see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_deploy>
191 =head2 prepare_resultsource_install
193 see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_resultsource_install>
195 =head2 install_resultsource
197 see L<DBIx::Class::DeploymentHandler::HandlesDeploy/install_resultsource>
199 =head2 prepare_upgrade
201 see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_upgrade>
203 =head2 prepare_downgrade
205 see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_downgrade>
209 All of the methods mentioned in L</METHODS THAT ARE REQUIRED IN SUBCLASSES> and
210 L</ORTHODOX METHODS> can be implemented in any fashion you choose. In the
211 spirit of code reuse I have used roles to implement them in my two subclasses,
212 L<DBIx::Class::DeploymentHandler> and
213 L<DBIx::Class::DeploymentHandler::Deprecated>, but you are free to implement
214 them entirely in a subclass if you so choose to.
216 For in-depth documentation on how methods are supposed to work, see the roles
217 L<DBIx::Class::DeploymentHandler::HandlesDeploy>,
218 L<DBIx::Class::DeploymentHandler::HandlesVersioning>, and
219 L<DBIx::Class::DeploymentHandler::HandlesVersionStorage>.