1 package DBIx::Class::DeploymentHandler::SqltDeployMethod;
3 use Method::Signatures::Simple;
8 isa => 'DBIx::Class::Storage',
13 method _build_storage {
14 my $s = $self->schema->storage;
15 $s->_determine_driver;
19 has backup_directory => (
33 default => sub { {} },
35 has upgrade_directory => (
43 isa => 'DBIx::Class::ResultSet',
46 handles => [qw( is_installed db_version )],
49 method _build_version_rs {
50 $self->schema->set_us_up_the_bomb;
51 $self->schema->resultset('__VERSION')
56 isa => 'DBIx::Class::DeploymentHandler::Databases',
58 default => sub { [qw( MySQL SQLite PostgreSQL )] },
62 isa => 'DBIx::Class::Schema',
65 handles => [qw( ddl_filename schema_version )],
69 isa => 'ArrayRef[Str]',
73 method deployment_statements {
74 my $dir = $self->upgrade_directory;
75 my $schema = $self->schema;
76 my $type = $self->storage->sqlt_type;
77 my $sqltargs = $self->sqltargs;
78 my $version = $self->schema_version || '1.x';
80 my $filename = $self->ddl_filename($type, $version, $dir);
83 open $file, q(<), $filename
84 or carp "Can't open $filename ($!)";
87 return join '', @rows;
90 # sources needs to be a parser arg, but for simplicty allow at top level
92 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
93 if exists $sqltargs->{sources};
95 my $tr = SQL::Translator->new(
96 producer => "SQL::Translator::Producer::${type}",
98 parser => 'SQL::Translator::Parser::DBIx::Class',
105 @ret = $tr->translate;
108 $ret[0] = $tr->translate;
111 $schema->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
112 unless (@ret && defined $ret[0]);
114 return $wa ? @ret : $ret[0];
118 my $schema = $self->schema;
120 my $sqltargs = $self->sqltargs;
121 my $dir = $self->upgrade_directory;
122 my $storage = $self->storage;
126 return if(!$line || $line =~ /^--|^BEGIN TRANSACTION|^COMMIT|^\s+$/);
127 $storage->_query_start($line);
129 # do a dbh_do cycle here, as we need some error checking in
130 # place (even though we will ignore errors)
131 $storage->dbh_do (sub { $_[1]->do($line) });
134 carp "$_ (running '${line}')"
136 $storage->_query_end($line);
138 my @statements = $self->deployment_statements();
139 if (@statements > 1) {
140 foreach my $statement (@statements) {
141 $deploy->( $statement );
144 elsif (@statements == 1) {
145 foreach my $line ( split(";\n", $statements[0])) {
151 method create_install_ddl {
152 my $schema = $self->schema;
153 my $databases = $self->databases;
154 my $dir = $self->upgrade_directory;
155 my $sqltargs = $self->sqltargs;
157 carp "Upgrade directory $dir does not exist, using ./\n";
161 my $version = $schema->schema_version || '1.x';
162 my $schema_version = $schema->schema_version || '1.x';
163 $version ||= $schema_version;
167 ignore_constraint_names => 1,
168 ignore_index_names => 1,
172 my $sqlt = SQL::Translator->new( $sqltargs );
174 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
175 my $sqlt_schema = $sqlt->translate({ data => $schema })
176 or $self->throw_exception ($sqlt->error);
178 foreach my $db (@$databases) {
180 $sqlt->{schema} = $sqlt_schema;
181 $sqlt->producer($db);
183 my $filename = $self->ddl_filename($db, $version, $dir);
184 if (-e $filename && ($version eq $schema_version )) {
185 # if we are dumping the current version, overwrite the DDL
186 carp "Overwriting existing DDL file - $filename";
190 my $output = $sqlt->translate;
192 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
196 unless( open $file, q(>), $filename ) {
197 $self->throw_exception("Can't open $filename for writing ($!)");
200 print {$file} $output;
205 method create_update_ddl($version, $preversion) {
206 my $schema = $self->schema;
207 my $databases = $self->databases;
208 my $dir = $self->upgrade_directory;
209 my $sqltargs = $self->sqltargs;
212 carp "Upgrade directory $dir does not exist, using ./\n";
216 my $schema_version = $schema->schema_version || '1.x';
217 $version ||= $schema_version;
221 ignore_constraint_names => 1,
222 ignore_index_names => 1,
226 my $sqlt = SQL::Translator->new( $sqltargs );
228 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
229 my $sqlt_schema = $sqlt->translate({ data => $schema })
230 or $self->throw_exception ($sqlt->error);
232 foreach my $db (@$databases) {
234 $sqlt->{schema} = $sqlt_schema;
235 $sqlt->producer($db);
237 my $prefilename = $self->ddl_filename($db, $preversion, $dir);
238 unless(-e $prefilename) {
239 carp("No previous schema file found ($prefilename)");
243 my $diff_file = $self->ddl_filename($db, $version, $dir, $preversion);
245 carp("Overwriting existing diff file - $diff_file");
251 my $t = SQL::Translator->new({
257 $t->parser( $db ) # could this really throw an exception?
258 or $self->throw_exception ($t->error);
260 my $out = $t->translate( $prefilename )
261 or $self->throw_exception ($t->error);
263 $source_schema = $t->schema;
265 $source_schema->name( $prefilename )
266 unless $source_schema->name;
269 # The "new" style of producers have sane normalization and can support
270 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
271 # And we have to diff parsed SQL against parsed SQL.
272 my $dest_schema = $sqlt_schema;
274 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
275 my $t = SQL::Translator->new({
281 $t->parser( $db ) # could this really throw an exception?
282 or $self->throw_exception ($t->error);
284 my $filename = $self->ddl_filename($db, $version, $dir);
285 my $out = $t->translate( $filename )
286 or $self->throw_exception ($t->error);
288 $dest_schema = $t->schema;
290 $dest_schema->name( $filename )
291 unless $dest_schema->name;
294 my $diff = SQL::Translator::Diff::schema_diff(
300 unless(open $file, q(>), $diff_file) {
301 $self->throw_exception("Can't write to $diff_file ($!)");
309 method create_ddl_dir($version, $preversion) {
310 $self->create_install_ddl;
311 $self->create_update_ddl($version, $preversion) if $preversion;
314 method _read_sql_file($file) {
317 open my $fh, '<', $file or carp("Can't open upgrade file, $file ($!)");
318 my @data = split /\n/, join '', <$fh>;
324 !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/m
331 method create_upgrade_path { }
333 method upgrade_single_step($db_version, $target_version) {
334 if ($db_version eq $target_version) {
336 carp "Upgrade not necessary\n";
340 my $upgrade_file = $self->ddl_filename(
341 $self->storage->sqlt_type,
343 $self->upgrade_directory,
347 $self->create_upgrade_path({ upgrade_file => $upgrade_file });
349 unless (-f $upgrade_file) {
351 carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
355 carp "DB version ($db_version) is lower than the schema version (".$self->schema_version."). Attempting upgrade.\n";
357 $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22
358 $self->backup if $self->do_backup;
359 $self->schema->txn_do(sub { $self->do_upgrade });
361 $self->version_rs->create({
362 version => $target_version,
364 # upgrade_sql => $upgrade_sql,
368 method do_upgrade { $self->run_upgrade(qr/.*?/) }
370 method run_upgrade($stm) {
371 return unless $self->_filedata;
372 my @statements = grep { $_ =~ $stm } @{$self->_filedata};
375 $self->storage->debugobj->query_start($_) if $self->storage->debug;
376 $self->apply_statement($_);
377 $self->storage->debugobj->query_end($_) if $self->storage->debug;
381 method apply_statement($statement) {
383 $self->storage->dbh->do($_) or carp "SQL was: $_"
386 method backup { $self->storage->backup($self->backup_directory) }
388 __PACKAGE__->meta->make_immutable;
394 vim: ts=2 sw=2 expandtab