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$/ ) {
173 my $filedata = do { local( @ARGV, $/ ) = $filename; <> };
175 no warnings 'redefine';
176 my $fn = eval "$filedata";
180 carp "$filename failed to compile: $@";
181 } elsif (ref $fn eq 'CODE') {
184 carp "$filename should define an anonymouse sub that takes a schema but it didn't!";
187 croak "A file ($filename) got to deploy that wasn't sql or perl!";
191 $guard->commit if $self->txn_wrap;
198 my $version = shift || $self->schema_version;
200 return $self->_run_sql_and_perl($self->_ddl_schema_consume_filenames(
201 $self->storage->sqlt_type,
209 my $version = $args->{version} || $self->schema_version;
210 my $storage_type = $args->{storage_type} || $self->storage->sqlt_type;
212 my @files = @{$self->_ddl_preinstall_consume_filenames(
217 for my $filename (@files) {
218 # We ignore sql for now (till I figure out what to do with it)
219 if ( $filename =~ /^(.+)\.pl$/ ) {
220 my $filedata = do { local( @ARGV, $/ ) = $filename; <> };
222 no warnings 'redefine';
223 my $fn = eval "$filedata";
227 carp "$filename failed to compile: $@";
228 } elsif (ref $fn eq 'CODE') {
231 carp "$filename should define an anonymous sub but it didn't!";
234 croak "A file ($filename) got to preinstall_scripts that wasn't sql or perl!";
239 sub _prepare_install {
241 my $sqltargs = { %{$self->sql_translator_args}, %{shift @_} };
243 my $schema = $self->schema;
244 my $databases = $self->databases;
245 my $dir = $self->upgrade_directory;
246 my $version = $self->schema_version;
248 my $sqlt = SQL::Translator->new({
250 ignore_constraint_names => 1,
251 ignore_index_names => 1,
252 parser => 'SQL::Translator::Parser::DBIx::Class',
256 my $sqlt_schema = $sqlt->translate( data => $schema )
257 or croak($sqlt->error);
259 foreach my $db (@$databases) {
261 $sqlt->{schema} = $sqlt_schema;
262 $sqlt->producer($db);
264 my $filename = $self->$to_file($db, $version, $dir);
266 carp "Overwriting existing DDL file - $filename";
270 my $output = $sqlt->translate;
272 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
275 open my $file, q(>), $filename;
276 print {$file} $output;
281 sub _resultsource_install_filename {
282 my ($self, $source_name) = @_;
284 my ($self, $type, $version) = @_;
285 my $dirname = catfile( $self->upgrade_directory, $type, 'schema', $version );
286 mkpath($dirname) unless -d $dirname;
288 return catfile( $dirname, "001-auto-$source_name.sql" );
292 sub install_resultsource {
293 my ($self, $source, $version) = @_;
295 my $rs_install_file =
296 $self->_resultsource_install_filename($source->source_name);
299 $self->$rs_install_file(
300 $self->storage->sqlt_type,
304 $self->_run_sql_and_perl($files);
307 sub prepare_resultsource_install {
311 my $filename = $self->_resultsource_install_filename($source->source_name);
312 $self->_prepare_install({
313 parser_args => { sources => [$source->source_name], }
319 $self->_prepare_install({}, '_ddl_schema_produce_filename');
322 sub prepare_upgrade {
323 my ($self, $from_version, $to_version, $version_set) = @_;
324 $self->_prepare_changegrade($from_version, $to_version, $version_set, 'up');
327 sub prepare_downgrade {
328 my ($self, $from_version, $to_version, $version_set) = @_;
330 $self->_prepare_changegrade($from_version, $to_version, $version_set, 'down');
333 method _prepare_changegrade($from_version, $to_version, $version_set, $direction) {
334 my $schema = $self->schema;
335 my $databases = $self->databases;
336 my $dir = $self->upgrade_directory;
337 my $sqltargs = $self->sql_translator_args;
339 my $schema_version = $self->schema_version;
343 ignore_constraint_names => 1,
344 ignore_index_names => 1,
348 my $sqlt = SQL::Translator->new( $sqltargs );
350 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
351 my $sqlt_schema = $sqlt->translate( data => $schema )
352 or croak($sqlt->error);
354 foreach my $db (@$databases) {
356 $sqlt->{schema} = $sqlt_schema;
357 $sqlt->producer($db);
359 my $prefilename = $self->_ddl_schema_produce_filename($db, $from_version, $dir);
360 unless(-e $prefilename) {
361 carp("No previous schema file found ($prefilename)");
364 my $diff_file_method = "_ddl_schema_${direction}_produce_filename";
365 my $diff_file = $self->$diff_file_method($db, $version_set, $dir );
367 carp("Overwriting existing $direction-diff file - $diff_file");
373 my $t = SQL::Translator->new({
379 $t->parser( $db ) # could this really throw an exception?
382 my $out = $t->translate( $prefilename )
385 $source_schema = $t->schema;
387 $source_schema->name( $prefilename )
388 unless $source_schema->name;
391 # The "new" style of producers have sane normalization and can support
392 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
393 # And we have to diff parsed SQL against parsed SQL.
394 my $dest_schema = $sqlt_schema;
396 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
397 my $t = SQL::Translator->new({
403 $t->parser( $db ) # could this really throw an exception?
406 my $filename = $self->_ddl_schema_produce_filename($db, $to_version, $dir);
407 my $out = $t->translate( $filename )
410 $dest_schema = $t->schema;
412 $dest_schema->name( $filename )
413 unless $dest_schema->name;
416 my $diff = SQL::Translator::Diff::schema_diff(
421 open my $file, q(>), $diff_file;
427 method _read_sql_file($file) {
430 open my $fh, '<', $file;
431 my @data = split /;\n/, join '', <$fh>;
435 $_ && # remove blank lines
436 !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/ # strip txn's
438 s/^\s+//; s/\s+$//; # trim whitespace
439 join '', grep { !/^--/ } split /\n/ # remove comments
445 sub downgrade_single_step {
447 my $version_set = shift @_;
449 my $sql = $self->_run_sql_and_perl($self->_ddl_schema_down_consume_filenames(
450 $self->storage->sqlt_type,
457 sub upgrade_single_step {
459 my $version_set = shift @_;
461 my $sql = $self->_run_sql_and_perl($self->_ddl_schema_up_consume_filenames(
462 $self->storage->sqlt_type,
468 __PACKAGE__->meta->make_immutable;
472 # vim: ts=2 sw=2 expandtab
478 This class is the meat of L<DBIx::Class::DeploymentHandler>. It takes care of
479 generating sql files representing schemata as well as sql files to move from
480 one version of a schema to the rest. One of the hallmark features of this
481 class is that it allows for multiple sql files for deploy and upgrade, allowing
482 developers to fine tune deployment. In addition it also allows for perl files
483 to be run at any stage of the process.
485 For basic usage see L<DBIx::Class::DeploymentHandler::HandlesDeploy>. What's
486 documented here is extra fun stuff or private methods.
488 =head1 DIRECTORY LAYOUT
490 Arguably this is the best feature of L<DBIx::Class::DeploymentHandler>. It's
491 heavily based upon L<DBIx::Migration::Directories>, but has some extensions and
492 modifications, so even if you are familiar with it, please read this. I feel
493 like the best way to describe the layout is with the following example:
511 | | `- 002-remove-customers.pl
514 | `- 002-generate-customers.pl
525 | `- 002-create-stored-procedures.sql
532 | |- 001-create_database.pl
533 | `- 002-create_users_and_permissions.pl
541 So basically, the code
545 on an C<SQLite> database that would simply run
546 C<$sql_migration_dir/SQLite/schema/1/001-auto.sql>. Next,
548 $dm->upgrade_single_step([1,2])
550 would run C<$sql_migration_dir/SQLite/up/1-2/001-auto.sql> followed by
551 C<$sql_migration_dir/_common/up/1-2/002-generate-customers.pl>.
553 Now, a C<.pl> file doesn't have to be in the C<_common> directory, but most of
554 the time it probably should be, since perl scripts will mostly be database
557 C<_generic> exists for when you for some reason are sure that your SQL is
558 generic enough to run on all databases. Good luck with that one.
560 Note that unlike most steps in the process, C<preinstall> will not run SQL, as
561 there may not even be an database at preinstall time. It will run perl scripts
562 just like the other steps in the process, but nothing is passed to them.
563 Until people have used this more it will remain freeform, but a recommended use
564 of preinstall is to have it prompt for username and password, and then call the
565 appropriate C<< CREATE DATABASE >> commands etc.
569 A perl script for this tool is very simple. It merely needs to contain an
570 anonymous sub that takes a L<DBIx::Class::Schema> as it's only argument.
571 A very basic perl script might look like:
581 $schema->resultset('Users')->create({
589 The L<DBIx::Class::Schema> (B<required>) that is used to talk to the database
590 and generate the DDL.
594 The L<DBIx::Class::Storage> that is I<actually> used to talk to the database
595 and generate the DDL. This is automatically created with L</_build_storage>.
597 =attr sql_translator_args
599 The arguments that get passed to L<SQL::Translator> when it's used.
601 =attr upgrade_directory
603 The directory (default C<'sql'>) that upgrades are stored in
607 The types of databases (default C<< [qw( MySQL SQLite PostgreSQL )] >>) to
612 Set to true (which is the default) to wrap all upgrades and deploys in a single
617 The version the schema on your harddrive is at. Defaults to
618 C<< $self->schema->schema_version >>.
620 =method __ddl_consume_with_prefix
622 $dm->__ddl_consume_with_prefix( 'SQLite', [qw( 1.00 1.01 )], 'up' )
624 This is the meat of the multi-file upgrade/deploy stuff. It returns a list of
625 files in the order that they should be run for a generic "type" of upgrade.
626 You should not be calling this in user code.
628 =method _ddl_schema_consume_filenames
630 $dm->__ddl_schema_consume_filenames( 'SQLite', [qw( 1.00 )] )
632 Just a curried L</__ddl_consume_with_prefix>. Get's a list of files for an
635 =method _ddl_schema_produce_filename
637 $dm->__ddl_schema_produce_filename( 'SQLite', [qw( 1.00 )] )
639 Returns a single file in which an initial schema will be stored.
641 =method _ddl_schema_up_consume_filenames
643 $dm->_ddl_schema_up_consume_filenames( 'SQLite', [qw( 1.00 )] )
645 Just a curried L</__ddl_consume_with_prefix>. Get's a list of files for an
648 =method _ddl_schema_down_consume_filenames
650 $dm->_ddl_schema_down_consume_filenames( 'SQLite', [qw( 1.00 )] )
652 Just a curried L</__ddl_consume_with_prefix>. Get's a list of files for a
655 =method _ddl_schema_up_produce_filenames
657 $dm->_ddl_schema_up_produce_filename( 'SQLite', [qw( 1.00 1.01 )] )
659 Returns a single file in which the sql to upgrade from one schema to another
662 =method _ddl_schema_down_produce_filename
664 $dm->_ddl_schema_down_produce_filename( 'SQLite', [qw( 1.00 1.01 )] )
666 Returns a single file in which the sql to downgrade from one schema to another
669 =method _resultsource_install_filename
671 my $filename_fn = $dm->_resultsource_install_filename('User');
672 $dm->$filename_fn('SQLite', '1.00')
674 Returns a function which in turn returns a single filename used to install a
675 single resultsource. Weird interface is convenient for me. Deal with it.
677 =method _run_sql_and_perl
679 $dm->_run_sql_and_perl([qw( list of filenames )])
681 Simply put, this runs the list of files passed to it. If the file ends in
682 C<.sql> it runs it as sql and if it ends in C<.pl> it runs it as a perl file.
684 Depending on L</txn_wrap> all of the files run will be wrapped in a single
687 =method _prepare_install
689 $dm->_prepare_install({ add_drop_table => 0 }, sub { 'file_to_create' })
691 Generates the sql file for installing the database. First arg is simply
692 L<SQL::Translator> args and the second is a coderef that returns the filename
695 =method _prepare_changegrade
697 $dm->_prepare_changegrade('1.00', '1.01', [qw( 1.00 1.01)], 'up')
699 Generates the sql file for migrating from one schema version to another. First
700 arg is the version to start from, second is the version to go to, third is the
701 L<version set|DBIx::Class::DeploymentHandler/VERSION SET>, and last is the
702 direction of the changegrade, be it 'up' or 'down'.
704 =method _read_sql_file
706 $dm->_read_sql_file('foo.sql')
708 Reads a sql file and returns lines in an C<ArrayRef>. Strips out comments,
709 transactions, and blank lines.