package DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator;
use Moose;
+# ABSTRACT: Manage your SQL and Perl migrations in nicely laid out directories
+
use autodie;
use Carp qw( carp croak );
isa => 'DBIx::Class::Schema',
is => 'ro',
required => 1,
- handles => [qw( schema_version )],
);
has storage => (
$s
}
-has sqltargs => (
+has sql_translator_args => (
isa => 'HashRef',
is => 'ro',
default => sub { {} },
default => 1,
);
+has schema_version => (
+ is => 'ro',
+ lazy_build => 1,
+);
+
+method _build_schema_version { $self->schema->schema_version }
+
method __ddl_consume_with_prefix($type, $versions, $prefix) {
my $base_dir = $self->upgrade_directory;
return [@files{sort keys %files}]
}
+method _ddl_preinstall_consume_filenames($type, $version) {
+ $self->__ddl_consume_with_prefix($type, [ $version ], 'preinstall')
+}
+
method _ddl_schema_consume_filenames($type, $version) {
$self->__ddl_consume_with_prefix($type, [ $version ], 'schema')
}
$storage->_query_end($line);
}
} elsif ( $filename =~ /^(.+)\.pl$/ ) {
- my $package = $1;
my $filedata = do { local( @ARGV, $/ ) = $filename; <> };
- # make the package name more palateable to perl
- $package =~ s/\W/_/g;
no warnings 'redefine';
- eval "package $package;\n\n$filedata";
+ my $fn = eval "$filedata";
use warnings;
- if (my $fn = $package->can('run')) {
- $fn->($self->schema);
+ if ($@) {
+ carp "$filename failed to compile: $@";
+ } elsif (ref $fn eq 'CODE') {
+ $fn->($self->schema)
} else {
- carp "$filename should define a run method that takes a schema but it didn't!";
+ carp "$filename should define an anonymouse sub that takes a schema but it didn't!";
}
} else {
- croak "A file got to deploy that wasn't sql or perl!";
+ croak "A file ($filename) got to deploy that wasn't sql or perl!";
}
}
));
}
-sub _prepare_install {
+sub preinstall {
my $self = shift;
- my $sqltargs = { %{$self->sqltargs}, %{shift @_} };
+ my $version = shift || $self->schema_version;
+
+ my @files = @{$self->_ddl_preinstall_consume_filenames(
+ $self->storage->sqlt_type,
+ $version,
+ )};
+
+ for my $filename (@files) {
+ # We ignore sql for now (till I figure out what to do with it)
+ if ( $filename =~ /^(.+)\.pl$/ ) {
+ my $filedata = do { local( @ARGV, $/ ) = $filename; <> };
+
+ no warnings 'redefine';
+ my $fn = eval "$filedata";
+ use warnings;
+
+ if ($@) {
+ carp "$filename failed to compile: $@";
+ } elsif (ref $fn eq 'CODE') {
+ $fn->()
+ } else {
+ carp "$filename should define an anonymous sub but it didn't!";
+ }
+ } else {
+ croak "A file ($filename) got to preinstall_scripts that wasn't sql or perl!";
+ }
+ }
+}
+
+sub _prepare_install {
+ my $self = shift;
+ my $sqltargs = { %{$self->sql_translator_args}, %{shift @_} };
my $to_file = shift;
my $schema = $self->schema;
my $databases = $self->databases;
my $dir = $self->upgrade_directory;
- my $version = $schema->schema_version;
+ my $version = $self->schema_version;
my $sqlt = SQL::Translator->new({
add_drop_table => 1,
}, $filename);
}
-sub prepare_install {
+sub prepare_deploy {
my $self = shift;
$self->_prepare_install({}, '_ddl_schema_produce_filename');
}
my $schema = $self->schema;
my $databases = $self->databases;
my $dir = $self->upgrade_directory;
- my $sqltargs = $self->sqltargs;
+ my $sqltargs = $self->sql_translator_args;
- my $schema_version = $schema->schema_version;
+ my $schema_version = $self->schema_version;
$sqltargs = {
add_drop_table => 1,
$sql_migration_dir
|- SQLite
| |- down
- | | `- 1-2
+ | | `- 2-1
| | `- 001-auto.sql
| |- schema
| | `- 1
| `- 001-auto.sql
|- _common
| |- down
- | | `- 1-2
+ | | `- 2-1
| | `- 002-remove-customers.pl
| `- up
| `- 1-2
| `- 002-generate-customers.pl
|- _generic
| |- down
- | | `- 1-2
+ | | `- 2-1
| | `- 001-auto.sql
| |- schema
| | `- 1
| `- 002-create-stored-procedures.sql
`- MySQL
|- down
- | `- 1-2
+ | `- 2-1
| `- 001-auto.sql
+ |- preinstall
+ | `- 1
+ | |- 001-create_database.pl
+ | `- 002-create_users_and_permissions.pl
|- schema
| `- 1
| `- 001-auto.sql
C<_generic> exists for when you for some reason are sure that your SQL is
generic enough to run on all databases. Good luck with that one.
+Note that unlike most steps in the process, C<preinstall> will not run SQL, as
+there may not even be an database at preinstall time. It will run perl scripts
+just like the other steps in the process, but nothing is passed to them.
+Until people have used this more it will remain freeform, but a recommended use
+of preinstall is to have it prompt for username and password, and then call the
+appropriate C<< CREATE DATABASE >> commands etc.
+
=head1 PERL SCRIPTS
-A perl script for this tool is very simple. It merely needs to contain a
-sub called C<run> that takes a L<DBIx::Class::Schema> as it's only argument.
+A perl script for this tool is very simple. It merely needs to contain an
+anonymous sub that takes a L<DBIx::Class::Schema> as it's only argument.
A very basic perl script might look like:
#!perl
use strict;
use warnings;
- sub run {
+ sub {
my $schema = shift;
$schema->resultset('Users')->create({
The L<DBIx::Class::Storage> that is I<actually> used to talk to the database
and generate the DDL. This is automatically created with L</_build_storage>.
-=attr sqltargs
+=attr sql_translator_args
-#rename
+The arguments that get passed to L<SQL::Translator> when it's used.
=attr upgrade_directory
Set to true (which is the default) to wrap all upgrades and deploys in a single
transaction.
+=attr schema_version
+
+The version the schema on your harddrive is at. Defaults to
+C<< $self->schema->schema_version >>.
+
=method __ddl_consume_with_prefix
$dm->__ddl_consume_with_prefix( 'SQLite', [qw( 1.00 1.01 )], 'up' )