1 package DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator;
3 use Method::Signatures::Simple;
6 require SQL::Translator::Diff;
7 require DBIx::Class::Storage; # loaded for type constraint
9 with 'DBIx::Class::DeploymentHandler::HandlesDeploy';
13 isa => 'DBIx::Class::Storage',
18 method _build_storage {
19 my $s = $self->schema->storage;
20 $s->_determine_driver;
27 default => sub { {} },
29 has upgrade_directory => (
38 isa => 'DBIx::Class::DeploymentHandler::Databases',
40 default => sub { [qw( MySQL SQLite PostgreSQL )] },
44 isa => 'DBIx::Class::Schema',
47 handles => [qw( schema_version )],
51 isa => 'ArrayRef[Str]',
55 method _ddl_filename($type, $versions, $dir) {
56 my $filename = ref $self->schema;
57 $filename =~ s/::/-/g;
59 $filename = File::Spec->catfile(
60 $dir, "$filename-" . join( q(-), @{$versions} ) . "-$type.sql"
66 method _deployment_statements {
67 my $dir = $self->upgrade_directory;
68 my $schema = $self->schema;
69 my $type = $self->storage->sqlt_type;
70 my $sqltargs = $self->sqltargs;
71 my $version = $self->schema_version || '1.x';
73 my $filename = $self->_ddl_filename($type, [ $version ], $dir);
76 open $file, q(<), $filename
77 or carp "Can't open $filename ($!)";
80 return join '', @rows;
83 # sources needs to be a parser arg, but for simplicty allow at top level
85 $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
86 if exists $sqltargs->{sources};
88 my $tr = SQL::Translator->new(
89 producer => "SQL::Translator::Producer::${type}",
91 parser => 'SQL::Translator::Parser::DBIx::Class',
98 @ret = $tr->translate;
101 $ret[0] = $tr->translate;
104 $schema->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
105 unless (@ret && defined $ret[0]);
107 return $wa ? @ret : $ret[0];
112 my $storage = $self->storage;
116 return if(!$line || $line =~ /^--|^BEGIN TRANSACTION|^COMMIT|^\s+$/);
117 $storage->_query_start($line);
119 # do a dbh_do cycle here, as we need some error checking in
120 # place (even though we will ignore errors)
121 $storage->dbh_do (sub { $_[1]->do($line) });
124 carp "$_ (running '${line}')"
126 $storage->_query_end($line);
128 my @statements = $self->_deployment_statements();
129 if (@statements > 1) {
130 foreach my $statement (@statements) {
131 $deploy->( $statement );
134 elsif (@statements == 1) {
135 foreach my $line ( split(";\n", $statements[0])) {
141 sub prepare_install {
143 my $schema = $self->schema;
144 my $databases = $self->databases;
145 my $dir = $self->upgrade_directory;
146 my $sqltargs = $self->sqltargs;
148 carp "Upgrade directory $dir does not exist, using ./\n";
152 my $version = $schema->schema_version || '1.x';
153 my $schema_version = $schema->schema_version || '1.x';
154 $version ||= $schema_version;
158 ignore_constraint_names => 1,
159 ignore_index_names => 1,
163 my $sqlt = SQL::Translator->new( $sqltargs );
165 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
166 my $sqlt_schema = $sqlt->translate({ data => $schema })
167 or $self->throw_exception ($sqlt->error);
169 foreach my $db (@$databases) {
171 $sqlt->{schema} = $sqlt_schema;
172 $sqlt->producer($db);
174 my $filename = $self->_ddl_filename($db, [ $version ], $dir);
175 if (-e $filename && ($version eq $schema_version )) {
176 # if we are dumping the current version, overwrite the DDL
177 carp "Overwriting existing DDL file - $filename";
181 my $output = $sqlt->translate;
183 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
187 unless( open $file, q(>), $filename ) {
188 $self->throw_exception("Can't open $filename for writing ($!)");
191 print {$file} $output;
197 my ($self, $version, $preversion) = @_;
200 # $from_version ||= $db_version
201 # $to_version ||= $schema_version
202 # $version_set ||= [$from_version, $to_version];
204 # for updates prepared automatically (rob's stuff)
205 # one would want to explicitly set $version_set to
207 my $schema = $self->schema;
208 my $databases = $self->databases;
209 my $dir = $self->upgrade_directory;
210 my $sqltargs = $self->sqltargs;
213 carp "Upgrade directory $dir does not exist, using ./\n";
217 my $schema_version = $schema->schema_version || '1.x';
218 $version ||= $schema_version;
222 ignore_constraint_names => 1,
223 ignore_index_names => 1,
227 my $sqlt = SQL::Translator->new( $sqltargs );
229 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
230 my $sqlt_schema = $sqlt->translate({ data => $schema })
231 or $self->throw_exception ($sqlt->error);
233 foreach my $db (@$databases) {
235 $sqlt->{schema} = $sqlt_schema;
236 $sqlt->producer($db);
238 my $prefilename = $self->_ddl_filename($db, [ $preversion ], $dir);
239 unless(-e $prefilename) {
240 carp("No previous schema file found ($prefilename)");
244 my $diff_file = $self->_ddl_filename($db, [ $preversion, $version ], $dir );
246 carp("Overwriting existing diff file - $diff_file");
252 my $t = SQL::Translator->new({
258 $t->parser( $db ) # could this really throw an exception?
259 or $self->throw_exception ($t->error);
261 my $out = $t->translate( $prefilename )
262 or $self->throw_exception ($t->error);
264 $source_schema = $t->schema;
266 $source_schema->name( $prefilename )
267 unless $source_schema->name;
270 # The "new" style of producers have sane normalization and can support
271 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
272 # And we have to diff parsed SQL against parsed SQL.
273 my $dest_schema = $sqlt_schema;
275 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
276 my $t = SQL::Translator->new({
282 $t->parser( $db ) # could this really throw an exception?
283 or $self->throw_exception ($t->error);
285 my $filename = $self->_ddl_filename($db, [ $version ], $dir);
286 my $out = $t->translate( $filename )
287 or $self->throw_exception ($t->error);
289 $dest_schema = $t->schema;
291 $dest_schema->name( $filename )
292 unless $dest_schema->name;
295 my $diff = SQL::Translator::Diff::schema_diff(
301 unless(open $file, q(>), $diff_file) {
302 $self->throw_exception("Can't write to $diff_file ($!)");
310 method _read_sql_file($file) {
313 open my $fh, '<', $file or carp("Can't open upgrade file, $file ($!)");
314 my @data = split /\n/, join '', <$fh>;
320 !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/m
327 sub _upgrade_single_step {
329 my @version_set = @{ shift @_ };
330 my $upgrade_file = $self->_ddl_filename(
331 $self->storage->sqlt_type,
333 $self->upgrade_directory,
336 unless (-f $upgrade_file) {
338 carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
342 $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22
343 $self->schema->txn_do(sub { $self->_do_upgrade });
346 method _do_upgrade { $self->_run_upgrade(qr/.*?/) }
348 method _run_upgrade($stm) {
349 return unless $self->_filedata;
350 my @statements = grep { $_ =~ $stm } @{$self->_filedata};
353 $self->storage->debugobj->query_start($_) if $self->storage->debug;
354 $self->_apply_statement($_);
355 $self->storage->debugobj->query_end($_) if $self->storage->debug;
359 method _apply_statement($statement) {
361 $self->storage->dbh->do($_) or carp "SQL was: $_"
364 __PACKAGE__->meta->make_immutable;
370 vim: ts=2 sw=2 expandtab