Commit | Line | Data |
b974984a |
1 | package DBIx::Class::DeploymentHandler; |
2 | |
3 | use Moose; |
4 | use Method::Signatures::Simple; |
12fdd461 |
5 | require DBIx::Class::Schema; # loaded for type constraint |
6 | require DBIx::Class::Storage; # loaded for type constraint |
7 | require DBIx::Class::ResultSet; # loaded for type constraint |
e1f67607 |
8 | use Carp::Clan '^DBIx::Class::DeploymentHandler'; |
b974984a |
9 | |
10 | has schema => ( |
61847972 |
11 | isa => 'DBIx::Class::Schema', |
12 | is => 'ro', |
13 | required => 1, |
4ea147c6 |
14 | handles => [qw( ddl_filename schema_version )], |
b974984a |
15 | ); |
16 | |
17 | has upgrade_directory => ( |
61847972 |
18 | isa => 'Str', |
19 | is => 'ro', |
20 | required => 1, |
4ea147c6 |
21 | default => 'sql', |
b974984a |
22 | ); |
23 | |
24 | has backup_directory => ( |
61847972 |
25 | isa => 'Str', |
26 | is => 'ro', |
b974984a |
27 | ); |
28 | |
29 | has storage => ( |
61847972 |
30 | isa => 'DBIx::Class::Storage', |
31 | is => 'ro', |
32 | lazy_build => 1, |
b974984a |
33 | ); |
34 | |
7eec7eb7 |
35 | method _build_storage { |
61847972 |
36 | my $s = $self->schema->storage; |
37 | $s->_determine_driver; |
38 | $s |
7eec7eb7 |
39 | } |
12fdd461 |
40 | |
b974984a |
41 | has _filedata => ( |
4ea147c6 |
42 | isa => 'ArrayRef[Str]', |
61847972 |
43 | is => 'rw', |
b974984a |
44 | ); |
45 | |
46 | has do_backup => ( |
61847972 |
47 | isa => 'Bool', |
48 | is => 'ro', |
49 | default => undef, |
b974984a |
50 | ); |
51 | |
52 | has do_diff_on_init => ( |
61847972 |
53 | isa => 'Bool', |
54 | is => 'ro', |
55 | default => undef, |
b974984a |
56 | ); |
57 | |
12fdd461 |
58 | has version_rs => ( |
61847972 |
59 | isa => 'DBIx::Class::ResultSet', |
60 | is => 'ro', |
61 | lazy_build => 1, |
62 | handles => [qw( is_installed db_version )], |
12fdd461 |
63 | ); |
64 | |
30749dbf |
65 | method _build_version_rs { |
66 | $self->schema->set_us_up_the_bomb; |
67 | $self->schema->resultset('__VERSION') |
68 | } |
12fdd461 |
69 | |
70 | method backup { $self->storage->backup($self->backup_directory) } |
b974984a |
71 | |
72 | method install($new_version) { |
12fdd461 |
73 | carp 'Install not possible as versions table already exists in database' |
ceef4ff5 |
74 | if $self->is_installed; |
b974984a |
75 | |
12fdd461 |
76 | $new_version ||= $self->schema_version; |
b974984a |
77 | |
78 | if ($new_version) { |
12fdd461 |
79 | $self->schema->deploy; |
80 | |
81 | $self->version_rs->create({ |
61847972 |
82 | version => $new_version, |
83 | # ddl => $ddl, |
84 | # upgrade_sql => $upgrade_sql, |
12fdd461 |
85 | }); |
b974984a |
86 | } |
87 | } |
88 | |
12fdd461 |
89 | method create_upgrade_path { } |
b974984a |
90 | |
8636376a |
91 | method ordered_schema_versions { undef } |
b974984a |
92 | |
93 | method upgrade { |
12fdd461 |
94 | my $db_version = $self->db_version; |
95 | my $schema_version = $self->schema_version; |
b974984a |
96 | |
b974984a |
97 | unless ($db_version) { |
61847972 |
98 | # croak? |
99 | carp 'Upgrade not possible as database is unversioned. Please call install first.'; |
100 | return; |
b974984a |
101 | } |
102 | |
12fdd461 |
103 | if ( $db_version eq $schema_version ) { |
61847972 |
104 | # croak? |
105 | carp "Upgrade not necessary\n"; |
106 | return; |
b974984a |
107 | } |
108 | |
12fdd461 |
109 | my @version_list = $self->ordered_schema_versions || |
110 | ( $db_version, $schema_version ); |
b974984a |
111 | |
112 | # remove all versions in list above the required version |
12fdd461 |
113 | while ( @version_list && ( $version_list[-1] ne $schema_version ) ) { |
61847972 |
114 | pop @version_list; |
b974984a |
115 | } |
116 | |
117 | # remove all versions in list below the current version |
12fdd461 |
118 | while ( @version_list && ( $version_list[0] ne $db_version ) ) { |
61847972 |
119 | shift @version_list; |
b974984a |
120 | } |
121 | |
122 | # check we have an appropriate list of versions |
12fdd461 |
123 | die if @version_list < 2; |
b974984a |
124 | |
125 | # do sets of upgrade |
12fdd461 |
126 | while ( @version_list >= 2 ) { |
61847972 |
127 | $self->upgrade_single_step( $version_list[0], $version_list[1] ); |
128 | shift @version_list; |
b974984a |
129 | } |
130 | } |
131 | |
132 | method upgrade_single_step($db_version, $target_version) { |
b974984a |
133 | if ($db_version eq $target_version) { |
e1f67607 |
134 | # croak? |
b974984a |
135 | carp "Upgrade not necessary\n"; |
136 | return; |
137 | } |
138 | |
b974984a |
139 | my $upgrade_file = $self->ddl_filename( |
12fdd461 |
140 | $self->storage->sqlt_type, |
141 | $target_version, |
142 | $self->upgrade_directory, |
143 | $db_version, |
144 | ); |
b974984a |
145 | |
146 | $self->create_upgrade_path({ upgrade_file => $upgrade_file }); |
147 | |
148 | unless (-f $upgrade_file) { |
e1f67607 |
149 | # croak? |
b974984a |
150 | carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n"; |
151 | return; |
152 | } |
153 | |
154 | carp "DB version ($db_version) is lower than the schema version (".$self->schema_version."). Attempting upgrade.\n"; |
155 | |
e1f67607 |
156 | $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22 |
12fdd461 |
157 | $self->backup if $self->do_backup; |
158 | $self->schema->txn_do(sub { $self->do_upgrade }); |
b974984a |
159 | |
12fdd461 |
160 | $self->version_rs->create({ |
61847972 |
161 | version => $target_version, |
162 | # ddl => $ddl, |
163 | # upgrade_sql => $upgrade_sql, |
12fdd461 |
164 | }); |
b974984a |
165 | } |
166 | |
8164e4d0 |
167 | method create_ddl_dir($databases, $version, $dir, $preversion, $sqltargs) { |
168 | my $schema = $self->schema; |
169 | if(!$dir || !-d $dir) { |
170 | carp "No directory given, using ./\n"; |
171 | $dir = "./"; |
172 | } |
173 | $databases ||= ['MySQL', 'SQLite', 'PostgreSQL']; |
174 | $databases = [ $databases ] if(ref($databases) ne 'ARRAY'); |
175 | |
176 | my $schema_version = $schema->schema_version || '1.x'; |
177 | $version ||= $schema_version; |
178 | |
179 | $sqltargs = { |
180 | add_drop_table => 1, |
181 | ignore_constraint_names => 1, |
182 | ignore_index_names => 1, |
183 | %{$sqltargs || {}} |
184 | }; |
185 | |
186 | unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) { |
187 | $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') ); |
188 | } |
189 | |
190 | my $sqlt = SQL::Translator->new( $sqltargs ); |
191 | |
192 | $sqlt->parser('SQL::Translator::Parser::DBIx::Class'); |
193 | my $sqlt_schema = $sqlt->translate({ data => $schema }) |
194 | or $self->throw_exception ($sqlt->error); |
195 | |
196 | foreach my $db (@$databases) { |
197 | $sqlt->reset(); |
198 | $sqlt->{schema} = $sqlt_schema; |
199 | $sqlt->producer($db); |
200 | |
201 | my $file; |
202 | my $filename = $schema->ddl_filename($db, $version, $dir); |
203 | if (-e $filename && ($version eq $schema_version )) { |
204 | # if we are dumping the current version, overwrite the DDL |
205 | carp "Overwriting existing DDL file - $filename"; |
206 | unlink($filename); |
207 | } |
208 | |
209 | my $output = $sqlt->translate; |
210 | if(!$output) { |
211 | carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")"); |
212 | next; |
213 | } |
214 | if(!open($file, ">$filename")) { |
215 | $self->throw_exception("Can't open $filename for writing ($!)"); |
216 | next; |
217 | } |
218 | print $file $output; |
219 | close($file); |
220 | |
221 | next unless ($preversion); |
222 | |
223 | require SQL::Translator::Diff; |
224 | |
225 | my $prefilename = $schema->ddl_filename($db, $preversion, $dir); |
226 | if(!-e $prefilename) { |
227 | carp("No previous schema file found ($prefilename)"); |
228 | next; |
229 | } |
230 | |
231 | my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion); |
232 | if(-e $difffile) { |
233 | carp("Overwriting existing diff file - $difffile"); |
234 | unlink($difffile); |
235 | } |
236 | |
237 | my $source_schema; |
238 | { |
239 | my $t = SQL::Translator->new($sqltargs); |
240 | $t->debug( 0 ); |
241 | $t->trace( 0 ); |
242 | |
243 | $t->parser( $db ) |
244 | or $self->throw_exception ($t->error); |
245 | |
246 | my $out = $t->translate( $prefilename ) |
247 | or $self->throw_exception ($t->error); |
248 | |
249 | $source_schema = $t->schema; |
250 | |
251 | $source_schema->name( $prefilename ) |
252 | unless ( $source_schema->name ); |
253 | } |
254 | |
255 | # The "new" style of producers have sane normalization and can support |
256 | # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't |
257 | # And we have to diff parsed SQL against parsed SQL. |
258 | my $dest_schema = $sqlt_schema; |
259 | |
260 | unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) { |
261 | my $t = SQL::Translator->new($sqltargs); |
262 | $t->debug( 0 ); |
263 | $t->trace( 0 ); |
264 | |
265 | $t->parser( $db ) |
266 | or $self->throw_exception ($t->error); |
267 | |
268 | my $out = $t->translate( $filename ) |
269 | or $self->throw_exception ($t->error); |
270 | |
271 | $dest_schema = $t->schema; |
272 | |
273 | $dest_schema->name( $filename ) |
274 | unless $dest_schema->name; |
275 | } |
276 | |
277 | my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db, |
278 | $dest_schema, $db, |
279 | $sqltargs |
280 | ); |
281 | if(!open $file, ">$difffile") { |
282 | $self->throw_exception("Can't write to $difffile ($!)"); |
283 | next; |
284 | } |
285 | print $file $diff; |
286 | close($file); |
287 | } |
288 | } |
289 | |
12fdd461 |
290 | method do_upgrade { $self->run_upgrade(qr/.*?/) } |
b974984a |
291 | |
292 | method run_upgrade($stm) { |
12fdd461 |
293 | return unless $self->_filedata; |
294 | my @statements = grep { $_ =~ $stm } @{$self->_filedata}; |
b974984a |
295 | |
12fdd461 |
296 | for (@statements) { |
297 | $self->storage->debugobj->query_start($_) if $self->storage->debug; |
298 | $self->apply_statement($_); |
299 | $self->storage->debugobj->query_end($_) if $self->storage->debug; |
300 | } |
b974984a |
301 | } |
302 | |
303 | method apply_statement($statement) { |
e1f67607 |
304 | # croak? |
12fdd461 |
305 | $self->storage->dbh->do($_) or carp "SQL was: $_" |
b974984a |
306 | } |
307 | |
8cf0010a |
308 | method _read_sql_file($file) { |
309 | return unless $file; |
b974984a |
310 | |
311 | open my $fh, '<', $file or carp("Can't open upgrade file, $file ($!)"); |
312 | my @data = split /\n/, join '', <$fh>; |
313 | close $fh; |
314 | |
315 | @data = grep { |
8cf0010a |
316 | $_ && |
317 | !/^--/ && |
318 | !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/m |
b974984a |
319 | } split /;/, |
8cf0010a |
320 | join '', @data; |
b974984a |
321 | |
322 | return \@data; |
323 | } |
324 | |
b974984a |
325 | 1; |
61847972 |
326 | |
327 | __END__ |
328 | |
329 | vim: ts=2,sw=2,expandtab |