Commit | Line | Data |
c4f4d4a2 |
1 | package DBIx::Class::DeploymentHandler::Dad; |
2 | |
3 | use Moose; |
4 | use Method::Signatures::Simple; |
c4f4d4a2 |
5 | require DBIx::Class::Schema; # loaded for type constraint |
c4f4d4a2 |
6 | use Carp::Clan '^DBIx::Class::DeploymentHandler'; |
7 | |
8 | has schema => ( |
9 | isa => 'DBIx::Class::Schema', |
10 | is => 'ro', |
11 | required => 1, |
12 | handles => ['schema_version'], |
13 | ); |
14 | |
cfc9edf9 |
15 | has backup_directory => ( |
c4f4d4a2 |
16 | isa => 'Str', |
17 | is => 'ro', |
18 | predicate => 'has_backup_directory', |
19 | ); |
20 | |
cfc9edf9 |
21 | has to_version => ( |
c4f4d4a2 |
22 | is => 'ro', |
23 | lazy_build => 1, |
24 | ); |
25 | |
26 | sub _build_to_version { $_[0]->schema->schema_version } |
27 | |
c4f4d4a2 |
28 | method install { |
29 | croak 'Install not possible as versions table already exists in database' |
30 | if $self->version_storage_is_installed; |
31 | |
7d2a6974 |
32 | my $ddl = $self->deploy; |
c4f4d4a2 |
33 | |
34ac0a51 |
34 | $self->add_database_version({ |
c4f4d4a2 |
35 | version => $self->to_version, |
36 | ddl => $ddl, |
37 | }); |
38 | } |
39 | |
40 | sub upgrade { |
41 | my $self = shift; |
42 | while ( my $version_list = $self->next_version_set ) { |
7d2a6974 |
43 | my ($ddl, $upgrade_sql) = @{$self->upgrade_single_step($version_list)||[]}; |
c4f4d4a2 |
44 | |
45 | $self->add_database_version({ |
46 | version => $version_list->[-1], |
392a5ccc |
47 | ddl => $ddl, |
48 | upgrade_sql => $upgrade_sql, |
c4f4d4a2 |
49 | }); |
50 | } |
51 | } |
52 | |
7d2a6974 |
53 | sub downgrade { |
54 | my $self = shift; |
55 | while ( my $version_list = $self->previous_version_set ) { |
56 | $self->downgrade_single_step($version_list); |
c4f4d4a2 |
57 | |
7d2a6974 |
58 | # do we just delete a row here? I think so but not sure |
59 | $self->delete_database_version({ version => $version_list->[-1] }); |
60 | } |
392a5ccc |
61 | } |
62 | |
7d2a6974 |
63 | method backup { $self->storage->backup($self->backup_directory) } |
64 | |
c4f4d4a2 |
65 | __PACKAGE__->meta->make_immutable; |
66 | |
67 | 1; |
68 | |
69 | =pod |
70 | |
71 | =attr schema |
72 | |
34ac0a51 |
73 | The L<DBIx::Class::Schema> (B<required>) that is used to talk to the database |
74 | and generate the DDL. |
75 | |
c4f4d4a2 |
76 | =attr backup_directory |
77 | |
34ac0a51 |
78 | The directory that backups are stored in |
79 | |
c4f4d4a2 |
80 | =attr to_version |
81 | |
34ac0a51 |
82 | The version (defaults to schema's version) to migrate the database to |
83 | |
c4f4d4a2 |
84 | =method install |
85 | |
34ac0a51 |
86 | $dh->install |
87 | |
88 | Deploys the current schema into the database. Populates C<version_storage> with |
89 | C<version> and C<ddl>. |
90 | |
91 | B<Note>: you typically need to call C<< $dh->prepare_install >> before you call |
92 | this method. |
93 | |
94 | B<Note>: you cannot install on top of an already installed database |
95 | |
c4f4d4a2 |
96 | =method upgrade |
97 | |
34ac0a51 |
98 | $dh->upgrade |
99 | |
100 | Upgrades the database one step at a time till L</next_version_set> |
101 | returns C<undef>. Each upgrade step will add a C<version>, C<ddl>, and |
102 | C<upgrade_sql> to the version storage (if C<ddl> and/or C<upgrade_sql> are |
103 | returned from L</upgrade_single_step>. |
104 | |
105 | =method downgrade |
106 | |
107 | $dh->downgrade |
108 | |
109 | Downgrades the database one step at a time till L</previous_version_set> |
110 | returns C<undef>. Each downgrade step will delete a C<version>from the |
111 | version storage. |
112 | |
c4f4d4a2 |
113 | =method backup |
114 | |
34ac0a51 |
115 | $dh->backup |
116 | |
117 | Simply calls backup on the C<< $schema->storage >>, passing in |
118 | C<< $self->backup_directory >> as an argument. Please test yourself before |
119 | assuming it will work. |
120 | |
121 | =head1 METHODS THAT ARE REQUIRED IN SUBCLASSES |
122 | |
5228a963 |
123 | =head2 deploy |
124 | |
125 | See L<DBIx::Class::DeploymentHandler::HandlesDeploy/deploy>. |
126 | |
34ac0a51 |
127 | =head2 version_storage_is_installed |
128 | |
5228a963 |
129 | See L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/version_storage_is_installed>. |
34ac0a51 |
130 | |
5228a963 |
131 | =head2 add_database_version |
34ac0a51 |
132 | |
5228a963 |
133 | See L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/add_database_version>. |
34ac0a51 |
134 | |
5228a963 |
135 | =head2 delete_database_version |
34ac0a51 |
136 | |
5228a963 |
137 | See L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/delete_database_version>. |
34ac0a51 |
138 | |
5228a963 |
139 | =head2 next_version_set |
34ac0a51 |
140 | |
5228a963 |
141 | See L<DBIx::Class::DeploymentHandler::HandlesVersioning/next_version_set>. |
34ac0a51 |
142 | |
5228a963 |
143 | =head2 previous_version_set |
34ac0a51 |
144 | |
5228a963 |
145 | See L<DBIx::Class::DeploymentHandler::HandlesVersioning/previous_version_set>. |
34ac0a51 |
146 | |
5228a963 |
147 | =head2 upgrade_single_step |
34ac0a51 |
148 | |
5228a963 |
149 | See L<DBIx::Class::DeploymentHandler::HandlesDeploy/upgrade_single_step>. |
34ac0a51 |
150 | |
5228a963 |
151 | =head2 downgrade_single_step |
34ac0a51 |
152 | |
5228a963 |
153 | See L<DBIx::Class::DeploymentHandler::HandlesDeploy/downgrade_single_step>. |
34ac0a51 |
154 | |
5228a963 |
155 | =head1 ORTHODOX METHODS |
34ac0a51 |
156 | |
5228a963 |
157 | These methods are not actually B<required> as things will probably still work |
158 | if you don't implement them, but if you want your subclass to get along with |
159 | other subclasses (or more likely, tools made to use another subclass), you |
160 | should probably implement these too, even if they are no-ops. |
34ac0a51 |
161 | |
5228a963 |
162 | The methods are: |
34ac0a51 |
163 | |
5228a963 |
164 | =head2 database_version |
34ac0a51 |
165 | |
5228a963 |
166 | see L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/database_version> |
34ac0a51 |
167 | |
5228a963 |
168 | =head2 prepare_install |
34ac0a51 |
169 | |
5228a963 |
170 | see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_install> |
34ac0a51 |
171 | |
5228a963 |
172 | =head2 prepare_resultsource_install |
173 | |
174 | see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_resultsouce_install> |
175 | |
176 | =head2 install_resultsource |
177 | |
178 | see L<DBIx::Class::DeploymentHandler::HandlesDeploy/install_resultsource> |
179 | |
180 | =head2 prepare_upgrade |
181 | |
182 | see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_upgrade> |
183 | |
184 | =head2 prepare_downgrade |
185 | |
186 | see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_downgrade> |
34ac0a51 |
187 | |
5228a963 |
188 | =back |
34ac0a51 |
189 | |
34ac0a51 |
190 | |
c4f4d4a2 |
191 | __END__ |
192 | |
193 | vim: ts=2 sw=2 expandtab |