package DBIx::Class::DeploymentHandler;
use Moose;
-use Method::Signatures::Simple;
-require DBIx::Class::Schema; # loaded for type constraint
-require DBIx::Class::Storage; # loaded for type constraint
-require DBIx::Class::ResultSet; # loaded for type constraint
-use Carp::Clan '^DBIx::Class::DeploymentHandler';
-use SQL::Translator;
-require SQL::Translator::Diff;
-use Try::Tiny;
-with 'DBIx::Class::DeploymentHandler::SqltDeployMethod';
-
-BEGIN {
- use Moose::Util::TypeConstraints;
- subtype 'DBIx::Class::DeploymentHandler::Databases'
- => as 'ArrayRef[Str]';
-
- coerce 'DBIx::Class::DeploymentHandler::Databases'
- => from 'Str'
- => via { [$_] };
- no Moose::Util::TypeConstraints;
-}
-
-has schema => (
- isa => 'DBIx::Class::Schema',
- is => 'ro',
- required => 1,
- handles => [qw( ddl_filename schema_version )],
-);
-
-has upgrade_directory => (
- isa => 'Str',
- is => 'ro',
- required => 1,
- default => 'sql',
-);
-
-has backup_directory => (
- isa => 'Str',
- is => 'ro',
-);
-
-has storage => (
- isa => 'DBIx::Class::Storage',
- is => 'ro',
- lazy_build => 1,
-);
-
-method _build_storage {
- my $s = $self->schema->storage;
- $s->_determine_driver;
- $s
-}
-
-has _filedata => (
- isa => 'ArrayRef[Str]',
- is => 'rw',
-);
-
-has do_backup => (
- isa => 'Bool',
- is => 'ro',
- default => undef,
-);
-
-has do_diff_on_init => (
- isa => 'Bool',
- is => 'ro',
- default => undef,
-);
-
-has version_rs => (
- isa => 'DBIx::Class::ResultSet',
- is => 'ro',
- lazy_build => 1,
- handles => [qw( is_installed db_version )],
-);
-
-method _build_version_rs {
- $self->schema->set_us_up_the_bomb;
- $self->schema->resultset('__VERSION')
-}
-
-has databases => (
- coerce => 1,
- isa => 'DBIx::Class::DeploymentHandler::Databases',
- is => 'ro',
- default => sub { [qw( MySQL SQLite PostgreSQL )] },
-);
-
-has sqltargs => (
- isa => 'HashRef',
- is => 'ro',
- default => sub { {} },
-);
-
-method deploy {
- my $schema = $self->schema;
- my $type = undef;
- my $sqltargs = $self->sqltargs;
- my $dir = $self->upgrade_directory;
- my $storage = $self->storage;
-
- my $deploy = sub {
- my $line = shift;
- return if(!$line || $line =~ /^--|^BEGIN TRANSACTION|^COMMIT|^\s+$/);
- $storage->_query_start($line);
- try {
- # do a dbh_do cycle here, as we need some error checking in
- # place (even though we will ignore errors)
- $storage->dbh_do (sub { $_[1]->do($line) });
- }
- catch {
- carp "$_ (running '${line}')"
- }
- $storage->_query_end($line);
- };
- my @statements = $self->deployment_statements();
- if (@statements > 1) {
- foreach my $statement (@statements) {
- $deploy->( $statement );
- }
- }
- elsif (@statements == 1) {
- foreach my $line ( split(";\n", $statements[0])) {
- $deploy->( $line );
- }
- }
-}
-
-method backup { $self->storage->backup($self->backup_directory) }
-
-method install($new_version) {
- carp 'Install not possible as versions table already exists in database'
- if $self->is_installed;
-
- $new_version ||= $self->schema_version;
-
- if ($new_version) {
- $self->deploy();
-
- $self->version_rs->create({
- version => $new_version,
- # ddl => $ddl,
- # upgrade_sql => $upgrade_sql,
- });
- }
-}
-
-method create_upgrade_path { }
-
-method ordered_schema_versions { undef }
-
-method upgrade {
- my $db_version = $self->db_version;
- my $schema_version = $self->schema_version;
-
- unless ($db_version) {
- # croak?
- carp 'Upgrade not possible as database is unversioned. Please call install first.';
- return;
- }
-
- if ( $db_version eq $schema_version ) {
- # croak?
- carp "Upgrade not necessary\n";
- return;
- }
-
- my @version_list = $self->ordered_schema_versions ||
- ( $db_version, $schema_version );
-
- # remove all versions in list above the required version
- while ( @version_list && ( $version_list[-1] ne $schema_version ) ) {
- pop @version_list;
- }
-
- # remove all versions in list below the current version
- while ( @version_list && ( $version_list[0] ne $db_version ) ) {
- shift @version_list;
- }
-
- # check we have an appropriate list of versions
- die if @version_list < 2;
-
- # do sets of upgrade
- while ( @version_list >= 2 ) {
- $self->upgrade_single_step( $version_list[0], $version_list[1] );
- shift @version_list;
- }
-}
-
-method upgrade_single_step($db_version, $target_version) {
- if ($db_version eq $target_version) {
- # croak?
- carp "Upgrade not necessary\n";
- return;
- }
-
- my $upgrade_file = $self->ddl_filename(
- $self->storage->sqlt_type,
- $target_version,
- $self->upgrade_directory,
- $db_version,
- );
-
- $self->create_upgrade_path({ upgrade_file => $upgrade_file });
-
- unless (-f $upgrade_file) {
- # croak?
- carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
- return;
- }
-
- carp "DB version ($db_version) is lower than the schema version (".$self->schema_version."). Attempting upgrade.\n";
-
- $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22
- $self->backup if $self->do_backup;
- $self->schema->txn_do(sub { $self->do_upgrade });
-
- $self->version_rs->create({
- version => $target_version,
- # ddl => $ddl,
- # upgrade_sql => $upgrade_sql,
- });
-}
-
-method do_upgrade { $self->run_upgrade(qr/.*?/) }
-
-method run_upgrade($stm) {
- return unless $self->_filedata;
- my @statements = grep { $_ =~ $stm } @{$self->_filedata};
-
- for (@statements) {
- $self->storage->debugobj->query_start($_) if $self->storage->debug;
- $self->apply_statement($_);
- $self->storage->debugobj->query_end($_) if $self->storage->debug;
- }
-}
-
-method apply_statement($statement) {
- # croak?
- $self->storage->dbh->do($_) or carp "SQL was: $_"
-}
-
-method _read_sql_file($file) {
- return unless $file;
-
- open my $fh, '<', $file or carp("Can't open upgrade file, $file ($!)");
- my @data = split /\n/, join '', <$fh>;
- close $fh;
-
- @data = grep {
- $_ &&
- !/^--/ &&
- !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/m
- } split /;/,
- join '', @data;
-
- return \@data;
-}
+extends 'DBIx::Class::DeploymentHandler::Dad';
+# a single with would be better, but we can't do that
+# see: http://rt.cpan.org/Public/Bug/Display.html?id=46347
+with 'DBIx::Class::DeploymentHandler::WithSqltDeployMethod',
+ 'DBIx::Class::DeploymentHandler::WithMonotonicVersions',
+ 'DBIx::Class::DeploymentHandler::WithStandardVersionStorage';
+with 'DBIx::Class::DeploymentHandler::WithReasonableDefaults';
__PACKAGE__->meta->make_immutable;
__END__
-vim: ts=2,sw=2,expandtab
+vim: ts=2 sw=2 expandtab
projects / dbsrgits/DBIx-Class-DeploymentHandler.git / blobdiff