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 );
8 use DBIx::Class::DeploymentHandler::Logger;
9 use Log::Contextual qw(:log :dlog), -default_logger =>
10 DBIx::Class::DeploymentHandler::Logger->new({
11 env_prefix => 'DBICDH'
14 use Method::Signatures::Simple;
18 require SQL::Translator::Diff;
20 require DBIx::Class::Storage; # loaded for type constraint
21 use DBIx::Class::DeploymentHandler::Types;
23 use File::Path 'mkpath';
24 use File::Spec::Functions;
26 with 'DBIx::Class::DeploymentHandler::HandlesDeploy';
35 isa => 'DBIx::Class::Schema',
41 isa => 'DBIx::Class::Storage',
46 method _build_storage {
47 my $s = $self->schema->storage;
48 $s->_determine_driver;
52 has sql_translator_args => (
55 default => sub { {} },
57 has script_directory => (
66 isa => 'DBIx::Class::DeploymentHandler::Databases',
68 default => sub { [qw( MySQL SQLite PostgreSQL )] },
77 has schema_version => (
83 # this will probably never get called as the DBICDH
84 # will be passing down a schema_version normally, which
85 # is built the same way, but we leave this in place
86 method _build_schema_version { $self->schema->schema_version }
88 method __ddl_consume_with_prefix($type, $versions, $prefix) {
89 my $base_dir = $self->script_directory;
91 my $main = catfile( $base_dir, $type );
93 catfile( $base_dir, '_common', $prefix, join q(-), @{$versions} );
97 $dir = catfile($main, $prefix, join q(-), @{$versions})
99 if ($self->ignore_ddl) {
102 croak "$main does not exist; please write/generate some SQL"
108 opendir my($dh), $dir;
110 map { $_ => "$dir/$_" }
111 grep { /\.(?:sql|pl|sql-\w+)$/ && -f "$dir/$_" }
115 die $_ unless $self->ignore_ddl;
118 opendir my($dh), $common;
119 for my $filename (grep { /\.(?:sql|pl)$/ && -f catfile($common,$_) } readdir $dh) {
120 unless ($files{$filename}) {
121 $files{$filename} = catfile($common,$filename);
127 return [@files{sort keys %files}]
130 method _ddl_preinstall_consume_filenames($type, $version) {
131 $self->__ddl_consume_with_prefix($type, [ $version ], 'preinstall')
134 method _ddl_schema_consume_filenames($type, $version) {
135 $self->__ddl_consume_with_prefix($type, [ $version ], 'deploy')
138 method _ddl_protoschema_upgrade_consume_filenames($versions) {
139 my $base_dir = $self->script_directory;
141 my $dir = catfile( $base_dir, '_preprocess_schema', 'upgrade', join q(-), @{$versions});
143 return [] unless -d $dir;
145 opendir my($dh), $dir;
146 my %files = map { $_ => "$dir/$_" } grep { /\.pl$/ && -f "$dir/$_" } readdir $dh;
149 return [@files{sort keys %files}]
152 method _ddl_protoschema_downgrade_consume_filenames($versions) {
153 my $base_dir = $self->script_directory;
155 my $dir = catfile( $base_dir, '_preprocess_schema', 'downgrade', join q(-), @{$versions});
157 return [] unless -d $dir;
159 opendir my($dh), $dir;
160 my %files = map { $_ => "$dir/$_" } grep { /\.pl$/ && -f "$dir/$_" } readdir $dh;
163 return [@files{sort keys %files}]
166 method _ddl_protoschema_produce_filename($version) {
167 my $dirname = catfile( $self->script_directory, '_source', 'deploy', $version );
168 mkpath($dirname) unless -d $dirname;
170 return catfile( $dirname, '001-auto.yml' );
173 method _ddl_schema_produce_filename($type, $version) {
174 my $dirname = catfile( $self->script_directory, $type, 'deploy', $version );
175 mkpath($dirname) unless -d $dirname;
177 return catfile( $dirname, '001-auto.sql' );
180 method _ddl_schema_upgrade_consume_filenames($type, $versions) {
181 $self->__ddl_consume_with_prefix($type, $versions, 'upgrade')
184 method _ddl_schema_downgrade_consume_filenames($type, $versions) {
185 $self->__ddl_consume_with_prefix($type, $versions, 'downgrade')
188 method _ddl_schema_upgrade_produce_filename($type, $versions) {
189 my $dir = $self->script_directory;
191 my $dirname = catfile( $dir, $type, 'upgrade', join q(-), @{$versions});
192 mkpath($dirname) unless -d $dirname;
194 return catfile( $dirname, '001-auto.sql' );
197 method _ddl_schema_downgrade_produce_filename($type, $versions, $dir) {
198 my $dirname = catfile( $dir, $type, 'downgrade', join q(-), @{$versions} );
199 mkpath($dirname) unless -d $dirname;
201 return catfile( $dirname, '001-auto.sql');
204 method _run_sql_array($sql) {
205 my $storage = $self->storage;
208 $_ && # remove blank lines
209 !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/ # strip txn's
211 s/^\s+//; s/\s+$//; # trim whitespace
212 join '', grep { !/^--/ } split /\n/ # remove comments
215 Dlog_trace { "Running SQL $_" } $sql;
216 foreach my $line (@{$sql}) {
217 $storage->_query_start($line);
218 # the whole reason we do this is so that we can see the line that was run
220 $storage->dbh_do (sub { $_[1]->do($line) });
223 die "$_ (running line '$line')"
225 $storage->_query_end($line);
227 return join "\n", @$sql
230 method _run_sql($filename) {
231 log_debug { "Running SQL from $filename" };
232 return $self->_run_sql_array($self->_read_sql_file($filename));
235 method _run_perl($filename) {
236 log_debug { "Running Perl from $filename" };
237 my $filedata = do { local( @ARGV, $/ ) = $filename; <> };
239 no warnings 'redefine';
240 my $fn = eval "$filedata";
242 Dlog_trace { "Running Perl $_" } $fn;
245 carp "$filename failed to compile: $@";
246 } elsif (ref $fn eq 'CODE') {
249 carp "$filename should define an anonymouse sub that takes a schema but it didn't!";
253 method _run_sql_and_perl($filenames, $sql_to_run) {
254 my @files = @{$filenames};
255 my $guard = $self->schema->txn_scope_guard if $self->txn_wrap;
257 $self->_run_sql_array($sql_to_run) if $self->ignore_ddl;
259 my $sql = ($sql_to_run)?join ";\n", @$sql_to_run:'';
261 for my $filename (@files) {
262 if ($self->ignore_ddl && $filename =~ /^[^_]*-auto.*\.sql$/) {
264 } elsif ($filename =~ /\.sql$/) {
265 $sql .= $self->_run_sql($filename)
266 } elsif ( $filename =~ /\.pl$/ ) {
267 $self->_run_perl($filename)
269 croak "A file ($filename) got to deploy that wasn't sql or perl!";
273 $guard->commit if $self->txn_wrap;
280 my $version = (shift @_ || {})->{version} || $self->schema_version;
281 log_info { "deploying version $version" };
282 my $sqlt_type = $self->storage->sqlt_type;
284 if ($self->ignore_ddl) {
285 $sql = $self->_sql_from_yaml({},
286 '_ddl_protoschema_produce_filename', $sqlt_type
289 return $self->_run_sql_and_perl($self->_ddl_schema_consume_filenames(
298 my $version = $args->{version} || $self->schema_version;
299 log_info { "preinstalling version $version" };
300 my $storage_type = $args->{storage_type} || $self->storage->sqlt_type;
302 my @files = @{$self->_ddl_preinstall_consume_filenames(
307 for my $filename (@files) {
308 # We ignore sql for now (till I figure out what to do with it)
309 if ( $filename =~ /^(.+)\.pl$/ ) {
310 my $filedata = do { local( @ARGV, $/ ) = $filename; <> };
312 no warnings 'redefine';
313 my $fn = eval "$filedata";
317 carp "$filename failed to compile: $@";
318 } elsif (ref $fn eq 'CODE') {
321 carp "$filename should define an anonymous sub but it didn't!";
324 croak "A file ($filename) got to preinstall_scripts that wasn't sql or perl!";
329 method _sqldiff_from_yaml($from_version, $to_version, $db, $direction) {
330 my $dir = $self->script_directory;
333 ignore_constraint_names => 1,
334 ignore_index_names => 1,
335 %{$self->sql_translator_args}
340 my $prefilename = $self->_ddl_protoschema_produce_filename($from_version, $dir);
342 # should probably be a croak
343 carp("No previous schema file found ($prefilename)")
344 unless -e $prefilename;
346 my $t = SQL::Translator->new({
350 parser => 'SQL::Translator::Parser::YAML',
353 my $out = $t->translate( $prefilename )
356 $source_schema = $t->schema;
358 $source_schema->name( $prefilename )
359 unless $source_schema->name;
364 my $filename = $self->_ddl_protoschema_produce_filename($to_version, $dir);
366 # should probably be a croak
367 carp("No next schema file found ($filename)")
370 my $t = SQL::Translator->new({
374 parser => 'SQL::Translator::Parser::YAML',
377 my $out = $t->translate( $filename )
380 $dest_schema = $t->schema;
382 $dest_schema->name( $filename )
383 unless $dest_schema->name;
386 my $transform_files_method = "_ddl_protoschema_${direction}_consume_filenames";
387 my $transforms = $self->_coderefs_per_files(
388 $self->$transform_files_method([$from_version, $to_version])
390 $_->($source_schema, $dest_schema) for @$transforms;
392 return [SQL::Translator::Diff::schema_diff(
399 method _sql_from_yaml($sqltargs, $from_file, $db) {
400 my $schema = $self->schema;
401 my $version = $self->schema_version;
403 my $sqlt = SQL::Translator->new({
405 parser => 'SQL::Translator::Parser::YAML',
410 my $yaml_filename = $self->$from_file($version);
412 my @sql = $sqlt->translate($yaml_filename);
414 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
420 sub _prepare_install {
422 my $sqltargs = { %{$self->sql_translator_args}, %{shift @_} };
423 my $from_file = shift;
425 my $dir = $self->script_directory;
426 my $databases = $self->databases;
427 my $version = $self->schema_version;
429 foreach my $db (@$databases) {
430 my $sql = $self->_sql_from_yaml($sqltargs, $from_file, $db ) or next;
432 my $filename = $self->$to_file($db, $version, $dir);
434 carp "Overwriting existing DDL file - $filename";
437 open my $file, q(>), $filename;
438 print {$file} join ";\n", @$sql;
443 sub _resultsource_install_filename {
444 my ($self, $source_name) = @_;
446 my ($self, $type, $version) = @_;
447 my $dirname = catfile( $self->script_directory, $type, 'deploy', $version );
448 mkpath($dirname) unless -d $dirname;
450 return catfile( $dirname, "001-auto-$source_name.sql" );
454 sub _resultsource_protoschema_filename {
455 my ($self, $source_name) = @_;
457 my ($self, $version) = @_;
458 my $dirname = catfile( $self->script_directory, '_source', $version );
459 mkpath($dirname) unless -d $dirname;
461 return catfile( $dirname, "001-auto-$source_name.yml" );
465 sub install_resultsource {
466 my ($self, $args) = @_;
467 my $source = $args->{result_source};
468 my $version = $args->{version};
469 log_info { 'installing_resultsource ' . $source->source_name . ", version $version" };
470 my $rs_install_file =
471 $self->_resultsource_install_filename($source->source_name);
474 $self->$rs_install_file(
475 $self->storage->sqlt_type,
479 $self->_run_sql_and_perl($files);
482 sub prepare_resultsource_install {
484 my $source = (shift @_)->{result_source};
485 log_info { 'preparing install for resultsource ' . $source->source_name };
487 my $install_filename = $self->_resultsource_install_filename($source->source_name);
488 my $proto_filename = $self->_resultsource_protoschema_filename($source->source_name);
489 $self->prepare_protoschema({
490 parser_args => { sources => [$source->source_name], }
492 $self->_prepare_install({}, $proto_filename, $install_filename);
496 log_info { 'preparing deploy' };
498 $self->prepare_protoschema({}, '_ddl_protoschema_produce_filename');
499 $self->_prepare_install({}, '_ddl_protoschema_produce_filename', '_ddl_schema_produce_filename');
502 sub prepare_upgrade {
503 my ($self, $args) = @_;
505 "preparing upgrade from $args->{from_version} to $args->{to_version}"
507 $self->_prepare_changegrade(
508 $args->{from_version}, $args->{to_version}, $args->{version_set}, 'upgrade'
512 sub prepare_downgrade {
513 my ($self, $args) = @_;
515 "preparing downgrade from $args->{from_version} to $args->{to_version}"
517 $self->_prepare_changegrade(
518 $args->{from_version}, $args->{to_version}, $args->{version_set}, 'downgrade'
522 method _coderefs_per_files($files) {
523 no warnings 'redefine';
524 [map eval do { local( @ARGV, $/ ) = $_; <> }, @$files]
527 method _prepare_changegrade($from_version, $to_version, $version_set, $direction) {
528 my $schema = $self->schema;
529 my $databases = $self->databases;
530 my $dir = $self->script_directory;
532 my $schema_version = $self->schema_version;
533 my $diff_file_method = "_ddl_schema_${direction}_produce_filename";
534 foreach my $db (@$databases) {
535 my $diff_file = $self->$diff_file_method($db, $version_set, $dir );
537 carp("Overwriting existing $direction-diff file - $diff_file");
541 open my $file, q(>), $diff_file;
542 print {$file} join ";\n", @{$self->_sqldiff_from_yaml($from_version, $to_version, $db, $direction)};
547 method _read_sql_file($file) {
550 open my $fh, '<', $file;
551 my @data = split /;\n/, join '', <$fh>;
555 $_ && # remove blank lines
556 !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/ # strip txn's
558 s/^\s+//; s/\s+$//; # trim whitespace
559 join '', grep { !/^--/ } split /\n/ # remove comments
565 sub downgrade_single_step {
567 my $version_set = (shift @_)->{version_set};
568 Dlog_info { "downgrade_single_step'ing $_" } $version_set;
570 my $sqlt_type = $self->storage->sqlt_type;
572 if ($self->ignore_ddl) {
573 $sql_to_run = $self->_sqldiff_from_yaml(
574 $version_set->[0], $version_set->[1], $sqlt_type, 'downgrade',
577 my $sql = $self->_run_sql_and_perl($self->_ddl_schema_downgrade_consume_filenames(
585 sub upgrade_single_step {
587 my $version_set = (shift @_)->{version_set};
588 Dlog_info { "upgrade_single_step'ing $_" } $version_set;
590 my $sqlt_type = $self->storage->sqlt_type;
592 if ($self->ignore_ddl) {
593 $sql_to_run = $self->_sqldiff_from_yaml(
594 $version_set->[0], $version_set->[1], $sqlt_type, 'upgrade',
597 my $sql = $self->_run_sql_and_perl($self->_ddl_schema_upgrade_consume_filenames(
604 sub prepare_protoschema {
606 my $sqltargs = { %{$self->sql_translator_args}, %{shift @_} };
609 = $self->$to_file($self->schema_version);
611 # we do this because the code that uses this sets parser args,
612 # so we just need to merge in the package
613 $sqltargs->{parser_args}{package} = $self->schema;
614 my $sqlt = SQL::Translator->new({
615 parser => 'SQL::Translator::Parser::DBIx::Class',
616 producer => 'SQL::Translator::Producer::YAML',
620 my $yml = $sqlt->translate;
622 croak("Failed to translate to YAML: " . $sqlt->error)
626 carp "Overwriting existing DDL-YML file - $filename";
630 open my $file, q(>), $filename;
635 __PACKAGE__->meta->make_immutable;
639 # vim: ts=2 sw=2 expandtab
645 This class is the meat of L<DBIx::Class::DeploymentHandler>. It takes care
646 of generating serialized schemata as well as sql files to move from one
647 version of a schema to the rest. One of the hallmark features of this class
648 is that it allows for multiple sql files for deploy and upgrade, allowing
649 developers to fine tune deployment. In addition it also allows for perl
650 files to be run at any stage of the process.
652 For basic usage see L<DBIx::Class::DeploymentHandler::HandlesDeploy>. What's
653 documented here is extra fun stuff or private methods.
655 =head1 DIRECTORY LAYOUT
657 Arguably this is the best feature of L<DBIx::Class::DeploymentHandler>.
658 It's spiritually based upon L<DBIx::Migration::Directories>, but has a
659 lot of extensions and modifications, so even if you are familiar with it,
660 please read this. I feel like the best way to describe the layout is with
661 the following example:
687 | | `- 002-remove-customers.pl
690 | `- 002-generate-customers.pl
697 | |- 001-create_database.pl
698 | `- 002-create_users_and_permissions.pl
706 So basically, the code
710 on an C<SQLite> database that would simply run
711 C<$sql_migration_dir/SQLite/deploy/1/001-auto.sql>. Next,
713 $dm->upgrade_single_step([1,2])
715 would run C<$sql_migration_dir/SQLite/upgrade/1-2/001-auto.sql> followed by
716 C<$sql_migration_dir/_common/upgrade/1-2/002-generate-customers.pl>.
718 C<.pl> files don't have to be in the C<_common> directory, but most of the time
719 they should be, because perl scripts are generally database independent.
721 Note that unlike most steps in the process, C<preinstall> will not run SQL, as
722 there may not even be an database at preinstall time. It will run perl scripts
723 just like the other steps in the process, but nothing is passed to them.
724 Until people have used this more it will remain freeform, but a recommended use
725 of preinstall is to have it prompt for username and password, and then call the
726 appropriate C<< CREATE DATABASE >> commands etc.
728 =head2 Directory Specification
730 The following subdirectories are recognized by this DeployMethod:
734 =item C<_source> This directory can contain the following directories:
738 =item C<deploy> This directory merely contains directories named after schema
739 versions, which in turn contain C<yaml> files that are serialized versions
740 of the schema at that version. These files are not for editing by hand.
744 =item C<_preprocess_schema> This directory can contain the following
749 =item C<downgrade> This directory merely contains directories named after
750 migrations, which are of the form C<$from_version-$to_version>. Inside of
751 these directories you may put Perl scripts which are to return a subref
752 that takes the arguments C<< $from_schema, $to_schema >>, which are
753 L<SQL::Translator::Schema> objects.
755 =item C<upgrade> This directory merely contains directories named after
756 migrations, which are of the form C<$from_version-$to_version>. Inside of
757 these directories you may put Perl scripts which are to return a subref
758 that takes the arguments C<< $from_schema, $to_schema >>, which are
759 L<SQL::Translator::Schema> objects.
763 =item C<$storage_type> This is a set of scripts that gets run depending on what
764 your storage type is. If you are not sure what your storage type is, take a
765 look at the producers listed for L<SQL::Translator>. Also note, C<_common>
766 is a special case. C<_common> will get merged into whatever other files you
767 already have. This directory can containt the following directories itself:
771 =item C<preinstall> Gets run before the C<deploy> is C<deploy>ed. Has the
772 same structure as the C<deploy> subdirectory as well; that is, it has a
773 directory for each schema version. Unlike C<deploy>, C<upgrade>, and C<downgrade>
774 though, it can only run C<.pl> files, and the coderef in the perl files get
775 no arguments passed to them.
777 =item C<deploy> Gets run when the schema is C<deploy>ed. Structure is a
778 directory per schema version, and then files are merged with C<_common> and run
779 in filename order. C<.sql> files are merely run, as expected. C<.pl> files are
780 run according to L</PERL SCRIPTS>.
782 =item C<upgrade> Gets run when the schema is C<upgrade>d. Structure is a directory
783 per upgrade step, (for example, C<1-2> for upgrading from version 1 to version
784 2,) and then files are merged with C<_common> and run in filename order.
785 C<.sql> files are merely run, as expected. C<.pl> files are run according
788 =item C<downgrade> Gets run when the schema is C<downgrade>d. Structure is a directory
789 per downgrade step, (for example, C<2-1> for downgrading from version 2 to version
790 1,) and then files are merged with C<_common> and run in filename order.
791 C<.sql> files are merely run, as expected. C<.pl> files are run according
801 A perl script for this tool is very simple. It merely needs to contain an
802 anonymous sub that takes a L<DBIx::Class::Schema> as it's only argument.
803 A very basic perl script might look like:
813 $schema->resultset('Users')->create({
821 This attribute will, when set to true (default is false), cause the DM to use
822 L<SQL::Translator> to use the C<_source>'s serialized SQL::Translator::Schema
823 instead of any pregenerated SQL. If you have a development server this is
824 probably the best plan of action as you will not be putting as many generated
825 files in your version control. Goes well with with C<databases> of C<[]>.
829 The L<DBIx::Class::Schema> (B<required>) that is used to talk to the database
830 and generate the DDL.
834 The L<DBIx::Class::Storage> that is I<actually> used to talk to the database
835 and generate the DDL. This is automatically created with L</_build_storage>.
837 =attr sql_translator_args
839 The arguments that get passed to L<SQL::Translator> when it's used.
841 =attr script_directory
843 The directory (default C<'sql'>) that scripts are stored in
847 The types of databases (default C<< [qw( MySQL SQLite PostgreSQL )] >>) to
852 Set to true (which is the default) to wrap all upgrades and deploys in a single
857 The version the schema on your harddrive is at. Defaults to
858 C<< $self->schema->schema_version >>.