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,
206 sub preinstall_scripts {
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
535 So basically, the code
539 on an C<SQLite> database that would simply run
540 C<$sql_migration_dir/SQLite/schema/1/001-auto.sql>. Next,
542 $dm->upgrade_single_step([1,2])
544 would run C<$sql_migration_dir/SQLite/up/1-2/001-auto.sql> followed by
545 C<$sql_migration_dir/_common/up/1-2/002-generate-customers.pl>.
547 Now, a C<.pl> file doesn't have to be in the C<_common> directory, but most of
548 the time it probably should be, since perl scripts will mostly be database
551 C<_generic> exists for when you for some reason are sure that your SQL is
552 generic enough to run on all databases. Good luck with that one.
556 A perl script for this tool is very simple. It merely needs to contain an
557 anonymous sub that takes a L<DBIx::Class::Schema> as it's only argument.
558 A very basic perl script might look like:
568 $schema->resultset('Users')->create({
576 The L<DBIx::Class::Schema> (B<required>) that is used to talk to the database
577 and generate the DDL.
581 The L<DBIx::Class::Storage> that is I<actually> used to talk to the database
582 and generate the DDL. This is automatically created with L</_build_storage>.
584 =attr sql_translator_args
586 The arguments that get passed to L<SQL::Translator> when it's used.
588 =attr upgrade_directory
590 The directory (default C<'sql'>) that upgrades are stored in
594 The types of databases (default C<< [qw( MySQL SQLite PostgreSQL )] >>) to
599 Set to true (which is the default) to wrap all upgrades and deploys in a single
604 The version the schema on your harddrive is at. Defaults to
605 C<< $self->schema->schema_version >>.
607 =method __ddl_consume_with_prefix
609 $dm->__ddl_consume_with_prefix( 'SQLite', [qw( 1.00 1.01 )], 'up' )
611 This is the meat of the multi-file upgrade/deploy stuff. It returns a list of
612 files in the order that they should be run for a generic "type" of upgrade.
613 You should not be calling this in user code.
615 =method _ddl_schema_consume_filenames
617 $dm->__ddl_schema_consume_filenames( 'SQLite', [qw( 1.00 )] )
619 Just a curried L</__ddl_consume_with_prefix>. Get's a list of files for an
622 =method _ddl_schema_produce_filename
624 $dm->__ddl_schema_produce_filename( 'SQLite', [qw( 1.00 )] )
626 Returns a single file in which an initial schema will be stored.
628 =method _ddl_schema_up_consume_filenames
630 $dm->_ddl_schema_up_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_down_consume_filenames
637 $dm->_ddl_schema_down_consume_filenames( 'SQLite', [qw( 1.00 )] )
639 Just a curried L</__ddl_consume_with_prefix>. Get's a list of files for a
642 =method _ddl_schema_up_produce_filenames
644 $dm->_ddl_schema_up_produce_filename( 'SQLite', [qw( 1.00 1.01 )] )
646 Returns a single file in which the sql to upgrade from one schema to another
649 =method _ddl_schema_down_produce_filename
651 $dm->_ddl_schema_down_produce_filename( 'SQLite', [qw( 1.00 1.01 )] )
653 Returns a single file in which the sql to downgrade from one schema to another
656 =method _resultsource_install_filename
658 my $filename_fn = $dm->_resultsource_install_filename('User');
659 $dm->$filename_fn('SQLite', '1.00')
661 Returns a function which in turn returns a single filename used to install a
662 single resultsource. Weird interface is convenient for me. Deal with it.
664 =method _run_sql_and_perl
666 $dm->_run_sql_and_perl([qw( list of filenames )])
668 Simply put, this runs the list of files passed to it. If the file ends in
669 C<.sql> it runs it as sql and if it ends in C<.pl> it runs it as a perl file.
671 Depending on L</txn_wrap> all of the files run will be wrapped in a single
674 =method _prepare_install
676 $dm->_prepare_install({ add_drop_table => 0 }, sub { 'file_to_create' })
678 Generates the sql file for installing the database. First arg is simply
679 L<SQL::Translator> args and the second is a coderef that returns the filename
682 =method _prepare_changegrade
684 $dm->_prepare_changegrade('1.00', '1.01', [qw( 1.00 1.01)], 'up')
686 Generates the sql file for migrating from one schema version to another. First
687 arg is the version to start from, second is the version to go to, third is the
688 L<version set|DBIx::Class::DeploymentHandler/VERSION SET>, and last is the
689 direction of the changegrade, be it 'up' or 'down'.
691 =method _read_sql_file
693 $dm->_read_sql_file('foo.sql')
695 Reads a sql file and returns lines in an C<ArrayRef>. Strips out comments,
696 transactions, and blank lines.