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,
208 my $version = shift || $self->schema_version;
210 my @files = @{$self->_ddl_preinstall_consume_filenames(
211 $self->storage->sqlt_type,
215 for my $filename (@files) {
216 # We ignore sql for now (till I figure out what to do with it)
217 if ( $filename =~ /^(.+)\.pl$/ ) {
218 my $filedata = do { local( @ARGV, $/ ) = $filename; <> };
220 no warnings 'redefine';
221 my $fn = eval "$filedata";
225 carp "$filename failed to compile: $@";
226 } elsif (ref $fn eq 'CODE') {
229 carp "$filename should define an anonymous sub but it didn't!";
232 croak "A file ($filename) got to preinstall_scripts that wasn't sql or perl!";
237 sub _prepare_install {
239 my $sqltargs = { %{$self->sql_translator_args}, %{shift @_} };
241 my $schema = $self->schema;
242 my $databases = $self->databases;
243 my $dir = $self->upgrade_directory;
244 my $version = $self->schema_version;
246 my $sqlt = SQL::Translator->new({
248 ignore_constraint_names => 1,
249 ignore_index_names => 1,
250 parser => 'SQL::Translator::Parser::DBIx::Class',
254 my $sqlt_schema = $sqlt->translate( data => $schema )
255 or croak($sqlt->error);
257 foreach my $db (@$databases) {
259 $sqlt->{schema} = $sqlt_schema;
260 $sqlt->producer($db);
262 my $filename = $self->$to_file($db, $version, $dir);
264 carp "Overwriting existing DDL file - $filename";
268 my $output = $sqlt->translate;
270 carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
273 open my $file, q(>), $filename;
274 print {$file} $output;
279 sub _resultsource_install_filename {
280 my ($self, $source_name) = @_;
282 my ($self, $type, $version) = @_;
283 my $dirname = catfile( $self->upgrade_directory, $type, 'schema', $version );
284 mkpath($dirname) unless -d $dirname;
286 return catfile( $dirname, "001-auto-$source_name.sql" );
290 sub install_resultsource {
291 my ($self, $source, $version) = @_;
293 my $rs_install_file =
294 $self->_resultsource_install_filename($source->source_name);
297 $self->$rs_install_file(
298 $self->storage->sqlt_type,
302 $self->_run_sql_and_perl($files);
305 sub prepare_resultsource_install {
309 my $filename = $self->_resultsource_install_filename($source->source_name);
310 $self->_prepare_install({
311 parser_args => { sources => [$source->source_name], }
317 $self->_prepare_install({}, '_ddl_schema_produce_filename');
320 sub prepare_upgrade {
321 my ($self, $from_version, $to_version, $version_set) = @_;
322 $self->_prepare_changegrade($from_version, $to_version, $version_set, 'up');
325 sub prepare_downgrade {
326 my ($self, $from_version, $to_version, $version_set) = @_;
328 $self->_prepare_changegrade($from_version, $to_version, $version_set, 'down');
331 method _prepare_changegrade($from_version, $to_version, $version_set, $direction) {
332 my $schema = $self->schema;
333 my $databases = $self->databases;
334 my $dir = $self->upgrade_directory;
335 my $sqltargs = $self->sql_translator_args;
337 my $schema_version = $self->schema_version;
341 ignore_constraint_names => 1,
342 ignore_index_names => 1,
346 my $sqlt = SQL::Translator->new( $sqltargs );
348 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
349 my $sqlt_schema = $sqlt->translate( data => $schema )
350 or croak($sqlt->error);
352 foreach my $db (@$databases) {
354 $sqlt->{schema} = $sqlt_schema;
355 $sqlt->producer($db);
357 my $prefilename = $self->_ddl_schema_produce_filename($db, $from_version, $dir);
358 unless(-e $prefilename) {
359 carp("No previous schema file found ($prefilename)");
362 my $diff_file_method = "_ddl_schema_${direction}_produce_filename";
363 my $diff_file = $self->$diff_file_method($db, $version_set, $dir );
365 carp("Overwriting existing $direction-diff file - $diff_file");
371 my $t = SQL::Translator->new({
377 $t->parser( $db ) # could this really throw an exception?
380 my $out = $t->translate( $prefilename )
383 $source_schema = $t->schema;
385 $source_schema->name( $prefilename )
386 unless $source_schema->name;
389 # The "new" style of producers have sane normalization and can support
390 # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
391 # And we have to diff parsed SQL against parsed SQL.
392 my $dest_schema = $sqlt_schema;
394 unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
395 my $t = SQL::Translator->new({
401 $t->parser( $db ) # could this really throw an exception?
404 my $filename = $self->_ddl_schema_produce_filename($db, $to_version, $dir);
405 my $out = $t->translate( $filename )
408 $dest_schema = $t->schema;
410 $dest_schema->name( $filename )
411 unless $dest_schema->name;
414 my $diff = SQL::Translator::Diff::schema_diff(
419 open my $file, q(>), $diff_file;
425 method _read_sql_file($file) {
428 open my $fh, '<', $file;
429 my @data = split /;\n/, join '', <$fh>;
433 $_ && # remove blank lines
434 !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/ # strip txn's
436 s/^\s+//; s/\s+$//; # trim whitespace
437 join '', grep { !/^--/ } split /\n/ # remove comments
443 sub downgrade_single_step {
445 my $version_set = shift @_;
447 my $sql = $self->_run_sql_and_perl($self->_ddl_schema_down_consume_filenames(
448 $self->storage->sqlt_type,
455 sub upgrade_single_step {
457 my $version_set = shift @_;
459 my $sql = $self->_run_sql_and_perl($self->_ddl_schema_up_consume_filenames(
460 $self->storage->sqlt_type,
466 __PACKAGE__->meta->make_immutable;
470 # vim: ts=2 sw=2 expandtab
476 This class is the meat of L<DBIx::Class::DeploymentHandler>. It takes care of
477 generating sql files representing schemata as well as sql files to move from
478 one version of a schema to the rest. One of the hallmark features of this
479 class is that it allows for multiple sql files for deploy and upgrade, allowing
480 developers to fine tune deployment. In addition it also allows for perl files
481 to be run at any stage of the process.
483 For basic usage see L<DBIx::Class::DeploymentHandler::HandlesDeploy>. What's
484 documented here is extra fun stuff or private methods.
486 =head1 DIRECTORY LAYOUT
488 Arguably this is the best feature of L<DBIx::Class::DeploymentHandler>. It's
489 heavily based upon L<DBIx::Migration::Directories>, but has some extensions and
490 modifications, so even if you are familiar with it, please read this. I feel
491 like the best way to describe the layout is with the following example:
509 | | `- 002-remove-customers.pl
512 | `- 002-generate-customers.pl
523 | `- 002-create-stored-procedures.sql
530 | |- 001-create_database.pl
531 | `- 002-create_users_and_permissions.pl
539 So basically, the code
543 on an C<SQLite> database that would simply run
544 C<$sql_migration_dir/SQLite/schema/1/001-auto.sql>. Next,
546 $dm->upgrade_single_step([1,2])
548 would run C<$sql_migration_dir/SQLite/up/1-2/001-auto.sql> followed by
549 C<$sql_migration_dir/_common/up/1-2/002-generate-customers.pl>.
551 Now, a C<.pl> file doesn't have to be in the C<_common> directory, but most of
552 the time it probably should be, since perl scripts will mostly be database
555 C<_generic> exists for when you for some reason are sure that your SQL is
556 generic enough to run on all databases. Good luck with that one.
558 Note that unlike most steps in the process, C<preinstall> will not run SQL, as
559 there may not even be an database at preinstall time. It will run perl scripts
560 just like the other steps in the process, but nothing is passed to them.
561 Until people have used this more it will remain freeform, but a recommended use
562 of preinstall is to have it prompt for username and password, and then call the
563 appropriate C<< CREATE DATABASE >> commands etc.
567 A perl script for this tool is very simple. It merely needs to contain an
568 anonymous sub that takes a L<DBIx::Class::Schema> as it's only argument.
569 A very basic perl script might look like:
579 $schema->resultset('Users')->create({
587 The L<DBIx::Class::Schema> (B<required>) that is used to talk to the database
588 and generate the DDL.
592 The L<DBIx::Class::Storage> that is I<actually> used to talk to the database
593 and generate the DDL. This is automatically created with L</_build_storage>.
595 =attr sql_translator_args
597 The arguments that get passed to L<SQL::Translator> when it's used.
599 =attr upgrade_directory
601 The directory (default C<'sql'>) that upgrades are stored in
605 The types of databases (default C<< [qw( MySQL SQLite PostgreSQL )] >>) to
610 Set to true (which is the default) to wrap all upgrades and deploys in a single
615 The version the schema on your harddrive is at. Defaults to
616 C<< $self->schema->schema_version >>.
618 =method __ddl_consume_with_prefix
620 $dm->__ddl_consume_with_prefix( 'SQLite', [qw( 1.00 1.01 )], 'up' )
622 This is the meat of the multi-file upgrade/deploy stuff. It returns a list of
623 files in the order that they should be run for a generic "type" of upgrade.
624 You should not be calling this in user code.
626 =method _ddl_schema_consume_filenames
628 $dm->__ddl_schema_consume_filenames( 'SQLite', [qw( 1.00 )] )
630 Just a curried L</__ddl_consume_with_prefix>. Get's a list of files for an
633 =method _ddl_schema_produce_filename
635 $dm->__ddl_schema_produce_filename( 'SQLite', [qw( 1.00 )] )
637 Returns a single file in which an initial schema will be stored.
639 =method _ddl_schema_up_consume_filenames
641 $dm->_ddl_schema_up_consume_filenames( 'SQLite', [qw( 1.00 )] )
643 Just a curried L</__ddl_consume_with_prefix>. Get's a list of files for an
646 =method _ddl_schema_down_consume_filenames
648 $dm->_ddl_schema_down_consume_filenames( 'SQLite', [qw( 1.00 )] )
650 Just a curried L</__ddl_consume_with_prefix>. Get's a list of files for a
653 =method _ddl_schema_up_produce_filenames
655 $dm->_ddl_schema_up_produce_filename( 'SQLite', [qw( 1.00 1.01 )] )
657 Returns a single file in which the sql to upgrade from one schema to another
660 =method _ddl_schema_down_produce_filename
662 $dm->_ddl_schema_down_produce_filename( 'SQLite', [qw( 1.00 1.01 )] )
664 Returns a single file in which the sql to downgrade from one schema to another
667 =method _resultsource_install_filename
669 my $filename_fn = $dm->_resultsource_install_filename('User');
670 $dm->$filename_fn('SQLite', '1.00')
672 Returns a function which in turn returns a single filename used to install a
673 single resultsource. Weird interface is convenient for me. Deal with it.
675 =method _run_sql_and_perl
677 $dm->_run_sql_and_perl([qw( list of filenames )])
679 Simply put, this runs the list of files passed to it. If the file ends in
680 C<.sql> it runs it as sql and if it ends in C<.pl> it runs it as a perl file.
682 Depending on L</txn_wrap> all of the files run will be wrapped in a single
685 =method _prepare_install
687 $dm->_prepare_install({ add_drop_table => 0 }, sub { 'file_to_create' })
689 Generates the sql file for installing the database. First arg is simply
690 L<SQL::Translator> args and the second is a coderef that returns the filename
693 =method _prepare_changegrade
695 $dm->_prepare_changegrade('1.00', '1.01', [qw( 1.00 1.01)], 'up')
697 Generates the sql file for migrating from one schema version to another. First
698 arg is the version to start from, second is the version to go to, third is the
699 L<version set|DBIx::Class::DeploymentHandler/VERSION SET>, and last is the
700 direction of the changegrade, be it 'up' or 'down'.
702 =method _read_sql_file
704 $dm->_read_sql_file('foo.sql')
706 Reads a sql file and returns lines in an C<ArrayRef>. Strips out comments,
707 transactions, and blank lines.