1 package DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator;
4 # ABSTRACT: Manage your SQL and Perl migrations in nicely laid out directories
7 use Carp qw( carp croak );
9 use Method::Signatures::Simple;
13 require SQL::Translator::Diff;
15 require DBIx::Class::Storage; # loaded for type constraint
16 use DBIx::Class::DeploymentHandler::Types;
18 use File::Path 'mkpath';
19 use File::Spec::Functions;
21 with 'DBIx::Class::DeploymentHandler::HandlesDeploy';
24 isa => 'DBIx::Class::Schema',
30 isa => 'DBIx::Class::Storage',
35 method _build_storage {
36 my $s = $self->schema->storage;
37 $s->_determine_driver;
41 has sql_translator_args => (
44 default => sub { {} },
46 has upgrade_directory => (
55 isa => 'DBIx::Class::DeploymentHandler::Databases',
57 default => sub { [qw( MySQL SQLite PostgreSQL )] },
66 has schema_version => (
71 method _build_schema_version { $self->schema->schema_version }
73 method __ddl_consume_with_prefix($type, $versions, $prefix) {
74 my $base_dir = $self->upgrade_directory;
76 my $main = catfile( $base_dir, $type );
77 my $generic = catfile( $base_dir, '_generic' );
79 catfile( $base_dir, '_common', $prefix, join q(-), @{$versions} );
83 $dir = catfile($main, $prefix, join q(-), @{$versions})
84 } elsif (-d $generic) {
85 $dir = catfile($generic, $prefix, join q(-), @{$versions});
87 croak "neither $main or $generic exist; please write/generate some SQL";
90 opendir my($dh), $dir;
91 my %files = map { $_ => "$dir/$_" } grep { /\.(?:sql|pl)$/ && -f "$dir/$_" } readdir $dh;
95 opendir my($dh), $common;
96 for my $filename (grep { /\.(?:sql|pl)$/ && -f catfile($common,$_) } readdir $dh) {
97 unless ($files{$filename}) {
98 $files{$filename} = catfile($common,$filename);
104 return [@files{sort keys %files}]
107 method _ddl_preinstall_consume_filenames($type, $version) {
108 $self->__ddl_consume_with_prefix($type, [ $version ], 'preinstall')
111 method _ddl_schema_consume_filenames($type, $version) {
112 $self->__ddl_consume_with_prefix($type, [ $version ], 'schema')
115 method _ddl_schema_produce_filename($type, $version) {
116 my $dirname = catfile( $self->upgrade_directory, $type, 'schema', $version );
117 mkpath($dirname) unless -d $dirname;
119 return catfile( $dirname, '001-auto.sql' );
122 method _ddl_schema_up_consume_filenames($type, $versions) {
123 $self->__ddl_consume_with_prefix($type, $versions, 'up')
126 method _ddl_schema_down_consume_filenames($type, $versions) {
127 $self->__ddl_consume_with_prefix($type, $versions, 'down')
130 method _ddl_schema_up_produce_filename($type, $versions) {
131 my $dir = $self->upgrade_directory;
133 my $dirname = catfile( $dir, $type, 'up', join q(-), @{$versions});
134 mkpath($dirname) unless -d $dirname;
136 return catfile( $dirname, '001-auto.sql'
140 method _ddl_schema_down_produce_filename($type, $versions, $dir) {
141 my $dirname = catfile( $dir, $type, 'down', join q(-), @{$versions} );
142 mkpath($dirname) unless -d $dirname;
144 return catfile( $dirname, '001-auto.sql');
147 method _run_sql_and_perl($filenames) {
148 my @files = @{$filenames};
149 my $storage = $self->storage;
152 my $guard = $self->schema->txn_scope_guard if $self->txn_wrap;
155 for my $filename (@files) {
156 if ($filename =~ /\.sql$/) {
157 my @sql = @{$self->_read_sql_file($filename)};
158 $sql .= join "\n", @sql;
160 foreach my $line (@sql) {
161 $storage->_query_start($line);
163 # do a dbh_do cycle here, as we need some error checking in
164 # place (even though we will ignore errors)
165 $storage->dbh_do (sub { $_[1]->do($line) });
168 carp "$_ (running '${line}')"
170 $storage->_query_end($line);
172 } elsif ( $filename =~ /^(.+)\.pl$/ ) {
174 my $filedata = do { local( @ARGV, $/ ) = $filename; <> };
175 # make the package name more palateable to perl
176 $package =~ s/\W/_/g;
178 no warnings 'redefine';
179 eval "package $package;\n\n$filedata";
182 if (my $fn = $package->can('run')) {
183 $fn->($self->schema);
185 carp "$filename should define a run method that takes a schema but it didn't!";
188 croak "A file ($filename) got to deploy that wasn't sql or perl!";
192 $guard->commit if $self->txn_wrap;
199 my $version = shift || $self->schema_version;
201 return $self->_run_sql_and_perl($self->_ddl_schema_consume_filenames(
202 $self->storage->sqlt_type,
207 sub preinstall_scripts {
209 my $version = shift || $self->schema_version;
211 my @files = @{$self->_ddl_preinstall_consume_filenames(
212 $self->storage->sqlt_type,
216 for my $filename (@files) {
217 # We ignore sql for now (till I figure out what to do with it)
218 if ( $filename =~ /^(.+)\.pl$/ ) {
220 my $filedata = do { local( @ARGV, $/ ) = $filename; <> };
221 # make the package name more palateable to perl
222 $package =~ s/\W/_/g;
224 no warnings 'redefine';
225 eval "package $package;\n\n$filedata";
227 if (my $fn = $package->can('run')) {
230 carp "$filename should define a run sub but it didn't!";
233 croak "A file ($filename) got to preinstall_scripts that wasn't sql or perl!";
238 sub _prepare_install {
240 my $sqltargs = { %{$self->sql_translator_args}, %{shift @_} };
242 my $schema = $self->schema;
243 my $databases = $self->databases;
244 my $dir = $self->upgrade_directory;
245 my $version = $self->schema_version;
247 my $sqlt = SQL::Translator->new({
249 ignore_constraint_names => 1,
250 ignore_index_names => 1,
251 parser => 'SQL::Translator::Parser::DBIx::Class',
255 my $sqlt_schema = $sqlt->translate( data => $schema )
256 or croak($sqlt->error);
258 foreach my $db (@$databases) {
260 $sqlt->{schema} = $sqlt_schema;
261 $sqlt->producer($db);
263 my $filename = $self->$to_file($db, $version, $dir);
265 carp "Overwriting existing DDL file - $filename";
269 my $output = $sqlt->translate;
271 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
274 open my $file, q(>), $filename;
275 print {$file} $output;
280 sub _resultsource_install_filename {
281 my ($self, $source_name) = @_;
283 my ($self, $type, $version) = @_;
284 my $dirname = catfile( $self->upgrade_directory, $type, 'schema', $version );
285 mkpath($dirname) unless -d $dirname;
287 return catfile( $dirname, "001-auto-$source_name.sql" );
291 sub install_resultsource {
292 my ($self, $source, $version) = @_;
294 my $rs_install_file =
295 $self->_resultsource_install_filename($source->source_name);
298 $self->$rs_install_file(
299 $self->storage->sqlt_type,
303 $self->_run_sql_and_perl($files);
306 sub prepare_resultsource_install {
310 my $filename = $self->_resultsource_install_filename($source->source_name);
311 $self->_prepare_install({
312 parser_args => { sources => [$source->source_name], }
318 $self->_prepare_install({}, '_ddl_schema_produce_filename');
321 sub prepare_upgrade {
322 my ($self, $from_version, $to_version, $version_set) = @_;
323 $self->_prepare_changegrade($from_version, $to_version, $version_set, 'up');
326 sub prepare_downgrade {
327 my ($self, $from_version, $to_version, $version_set) = @_;
329 $self->_prepare_changegrade($from_version, $to_version, $version_set, 'down');
332 method _prepare_changegrade($from_version, $to_version, $version_set, $direction) {
333 my $schema = $self->schema;
334 my $databases = $self->databases;
335 my $dir = $self->upgrade_directory;
336 my $sqltargs = $self->sql_translator_args;
338 my $schema_version = $self->schema_version;
342 ignore_constraint_names => 1,
343 ignore_index_names => 1,
347 my $sqlt = SQL::Translator->new( $sqltargs );
349 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
350 my $sqlt_schema = $sqlt->translate( data => $schema )
351 or croak($sqlt->error);
353 foreach my $db (@$databases) {
355 $sqlt->{schema} = $sqlt_schema;
356 $sqlt->producer($db);
358 my $prefilename = $self->_ddl_schema_produce_filename($db, $from_version, $dir);
359 unless(-e $prefilename) {
360 carp("No previous schema file found ($prefilename)");
363 my $diff_file_method = "_ddl_schema_${direction}_produce_filename";
364 my $diff_file = $self->$diff_file_method($db, $version_set, $dir );
366 carp("Overwriting existing $direction-diff file - $diff_file");
372 my $t = SQL::Translator->new({
378 $t->parser( $db ) # could this really throw an exception?
381 my $out = $t->translate( $prefilename )
384 $source_schema = $t->schema;
386 $source_schema->name( $prefilename )
387 unless $source_schema->name;
390 # The "new" style of producers have sane normalization and can support
391 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
392 # And we have to diff parsed SQL against parsed SQL.
393 my $dest_schema = $sqlt_schema;
395 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
396 my $t = SQL::Translator->new({
402 $t->parser( $db ) # could this really throw an exception?
405 my $filename = $self->_ddl_schema_produce_filename($db, $to_version, $dir);
406 my $out = $t->translate( $filename )
409 $dest_schema = $t->schema;
411 $dest_schema->name( $filename )
412 unless $dest_schema->name;
415 my $diff = SQL::Translator::Diff::schema_diff(
420 open my $file, q(>), $diff_file;
426 method _read_sql_file($file) {
429 open my $fh, '<', $file;
430 my @data = split /;\n/, join '', <$fh>;
434 $_ && # remove blank lines
435 !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/ # strip txn's
437 s/^\s+//; s/\s+$//; # trim whitespace
438 join '', grep { !/^--/ } split /\n/ # remove comments
444 sub downgrade_single_step {
446 my $version_set = shift @_;
448 my $sql = $self->_run_sql_and_perl($self->_ddl_schema_down_consume_filenames(
449 $self->storage->sqlt_type,
456 sub upgrade_single_step {
458 my $version_set = shift @_;
460 my $sql = $self->_run_sql_and_perl($self->_ddl_schema_up_consume_filenames(
461 $self->storage->sqlt_type,
467 __PACKAGE__->meta->make_immutable;
471 # vim: ts=2 sw=2 expandtab
477 This class is the meat of L<DBIx::Class::DeploymentHandler>. It takes care of
478 generating sql files representing schemata as well as sql files to move from
479 one version of a schema to the rest. One of the hallmark features of this
480 class is that it allows for multiple sql files for deploy and upgrade, allowing
481 developers to fine tune deployment. In addition it also allows for perl files
482 to be run at any stage of the process.
484 For basic usage see L<DBIx::Class::DeploymentHandler::HandlesDeploy>. What's
485 documented here is extra fun stuff or private methods.
487 =head1 DIRECTORY LAYOUT
489 Arguably this is the best feature of L<DBIx::Class::DeploymentHandler>. It's
490 heavily based upon L<DBIx::Migration::Directories>, but has some extensions and
491 modifications, so even if you are familiar with it, please read this. I feel
492 like the best way to describe the layout is with the following example:
510 | | `- 002-remove-customers.pl
513 | `- 002-generate-customers.pl
524 | `- 002-create-stored-procedures.sql
536 So basically, the code
540 on an C<SQLite> database that would simply run
541 C<$sql_migration_dir/SQLite/schema/1/001-auto.sql>. Next,
543 $dm->upgrade_single_step([1,2])
545 would run C<$sql_migration_dir/SQLite/up/1-2/001-auto.sql> followed by
546 C<$sql_migration_dir/_common/up/1-2/002-generate-customers.pl>.
548 Now, a C<.pl> file doesn't have to be in the C<_common> directory, but most of
549 the time it probably should be, since perl scripts will mostly be database
552 C<_generic> exists for when you for some reason are sure that your SQL is
553 generic enough to run on all databases. Good luck with that one.
557 A perl script for this tool is very simple. It merely needs to contain a
558 sub called C<run> that takes a L<DBIx::Class::Schema> as it's only argument.
559 A very basic perl script might look like:
569 $schema->resultset('Users')->create({
577 The L<DBIx::Class::Schema> (B<required>) that is used to talk to the database
578 and generate the DDL.
582 The L<DBIx::Class::Storage> that is I<actually> used to talk to the database
583 and generate the DDL. This is automatically created with L</_build_storage>.
585 =attr sql_translator_args
587 The arguments that get passed to L<SQL::Translator> when it's used.
589 =attr upgrade_directory
591 The directory (default C<'sql'>) that upgrades are stored in
595 The types of databases (default C<< [qw( MySQL SQLite PostgreSQL )] >>) to
600 Set to true (which is the default) to wrap all upgrades and deploys in a single
605 The version the schema on your harddrive is at. Defaults to
606 C<< $self->schema->schema_version >>.
608 =method __ddl_consume_with_prefix
610 $dm->__ddl_consume_with_prefix( 'SQLite', [qw( 1.00 1.01 )], 'up' )
612 This is the meat of the multi-file upgrade/deploy stuff. It returns a list of
613 files in the order that they should be run for a generic "type" of upgrade.
614 You should not be calling this in user code.
616 =method _ddl_schema_consume_filenames
618 $dm->__ddl_schema_consume_filenames( 'SQLite', [qw( 1.00 )] )
620 Just a curried L</__ddl_consume_with_prefix>. Get's a list of files for an
623 =method _ddl_schema_produce_filename
625 $dm->__ddl_schema_produce_filename( 'SQLite', [qw( 1.00 )] )
627 Returns a single file in which an initial schema will be stored.
629 =method _ddl_schema_up_consume_filenames
631 $dm->_ddl_schema_up_consume_filenames( 'SQLite', [qw( 1.00 )] )
633 Just a curried L</__ddl_consume_with_prefix>. Get's a list of files for an
636 =method _ddl_schema_down_consume_filenames
638 $dm->_ddl_schema_down_consume_filenames( 'SQLite', [qw( 1.00 )] )
640 Just a curried L</__ddl_consume_with_prefix>. Get's a list of files for a
643 =method _ddl_schema_up_produce_filenames
645 $dm->_ddl_schema_up_produce_filename( 'SQLite', [qw( 1.00 1.01 )] )
647 Returns a single file in which the sql to upgrade from one schema to another
650 =method _ddl_schema_down_produce_filename
652 $dm->_ddl_schema_down_produce_filename( 'SQLite', [qw( 1.00 1.01 )] )
654 Returns a single file in which the sql to downgrade from one schema to another
657 =method _resultsource_install_filename
659 my $filename_fn = $dm->_resultsource_install_filename('User');
660 $dm->$filename_fn('SQLite', '1.00')
662 Returns a function which in turn returns a single filename used to install a
663 single resultsource. Weird interface is convenient for me. Deal with it.
665 =method _run_sql_and_perl
667 $dm->_run_sql_and_perl([qw( list of filenames )])
669 Simply put, this runs the list of files passed to it. If the file ends in
670 C<.sql> it runs it as sql and if it ends in C<.pl> it runs it as a perl file.
672 Depending on L</txn_wrap> all of the files run will be wrapped in a single
675 =method _prepare_install
677 $dm->_prepare_install({ add_drop_table => 0 }, sub { 'file_to_create' })
679 Generates the sql file for installing the database. First arg is simply
680 L<SQL::Translator> args and the second is a coderef that returns the filename
683 =method _prepare_changegrade
685 $dm->_prepare_changegrade('1.00', '1.01', [qw( 1.00 1.01)], 'up')
687 Generates the sql file for migrating from one schema version to another. First
688 arg is the version to start from, second is the version to go to, third is the
689 L<version set|DBIx::Class::DeploymentHandler/VERSION SET>, and last is the
690 direction of the changegrade, be it 'up' or 'down'.
692 =method _read_sql_file
694 $dm->_read_sql_file('foo.sql')
696 Reads a sql file and returns lines in an C<ArrayRef>. Strips out comments,
697 transactions, and blank lines.