X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits%2FDBIx-Class-DeploymentHandler.git;a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FDeploymentHandler.pm;h=1fd2038e7e5ae890d4bdca4768f6ed8905b68ea2;hp=b325716663d33e9a11d34cbc2ee19c7a26041c47;hb=f7e215c9d2af2471f4586336fb7ed1ae3725be07;hpb=2eaf903b4450604819a24ee038ff2fc3a3302fed diff --git a/lib/DBIx/Class/DeploymentHandler.pm b/lib/DBIx/Class/DeploymentHandler.pm index b325716..1fd2038 100644 --- a/lib/DBIx/Class/DeploymentHandler.pm +++ b/lib/DBIx/Class/DeploymentHandler.pm @@ -1,185 +1,179 @@ package DBIx::Class::DeploymentHandler; +# ABSTRACT: Extensible DBIx::Class deployment + 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::WithSqltDeployMethod'; - -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 => ( # configuration - isa => 'Str', - is => 'ro', - required => 1, - default => 'sql', -); - -has backup_directory => ( # configuration - isa => 'Str', - is => 'ro', - predicate => 'has_backup_directory', -); - -has storage => ( - isa => 'DBIx::Class::Storage', - is => 'ro', - lazy_build => 1, -); - -method _build_storage { - my $s = $self->schema->storage; - $s->_determine_driver; - $s -} +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'; -has do_backup => ( # configuration - 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') -} +sub prepare_version_storage_install { + my $self = shift; -has databases => ( # configuration - coerce => 1, - isa => 'DBIx::Class::DeploymentHandler::Databases', - is => 'ro', - default => sub { [qw( MySQL SQLite PostgreSQL )] }, -); - -has sqltargs => ( # configuration - isa => 'HashRef', - is => 'ro', - default => sub { {} }, -); - -method deploy { - my $storage = $self->storage; - - my $deploy = sub { - my $line = shift; - # the \nCOMMIT below is entirely to make the tests quieter, - # there is surely a better way to fix it (/m breaks everything) - return if(!$line || $line =~ /^(--|BEGIN TRANSACTION|\nCOMMIT|\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 ); - } - } + $self->prepare_resultsource_install( + $self->version_storage->version_rs->result_source + ); } -method install($new_version) { - carp 'Install not possible as versions table already exists in database' - if $self->is_installed; +sub install_version_storage { + my $self = shift; - $new_version ||= $self->schema_version; - - if ($new_version) { - $self->deploy; - - $self->version_rs->create({ - version => $new_version, - # ddl => $ddl, - # upgrade_sql => $upgrade_sql, - }); - } + $self->install_resultsource( + $self->version_storage->version_rs->result_source + ); } -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; - } +sub prepare_install { + $_[0]->prepare_deploy; + $_[0]->prepare_version_storage_install; } __PACKAGE__->meta->make_immutable; 1; +#vim: ts=2 sw=2 expandtab + __END__ -vim: ts=2 sw=2 expandtab +=head1 SYNOPSIS + + use aliased 'DBIx::Class::DeploymentHandler' => 'DH'; + my $s = My::Schema->connect(...); + + my $dh = DH->new({ + schema => $s, + databases => 'SQLite', + sqltargs => { add_drop_table => 0 }, + }); + + $dh->prepare_install; + + $dh->install; + +or for upgrades: + + use aliased 'DBIx::Class::DeploymentHandler' => 'DH'; + my $s = My::Schema->connect(...); + + my $dh = DH->new({ + schema => $s, + databases => 'SQLite', + sqltargs => { add_drop_table => 0 }, + }); + + $dh->prepare_upgrade(1, 2); + + $dh->upgrade; + +=head1 DESCRIPTION + +C is, as it's name suggests, a tool for +deploying and upgrading databases with L. It is designed to be +much more flexible than L, hence the use of +L and lots of roles. + +C itself is just a recommended set of roles +that we think will not only work well for everyone, but will also yeild the +best overall mileage. Each role it uses has it's own nuances and +documentation, so I won't describe all of them here, but here are a few of the +major benefits over how L worked (and +L tries to maintain compatibility +with): + +=over + +=item * + +Downgrades in addition to upgrades. + +=item * + +Multiple sql files files per upgrade/downgrade/install. + +=item * + +Perl scripts allowed for upgrade/downgrade/install. + +=item * + +Just one set of files needed for upgrade, unlike before where one might need +to generate C, which is just silly. + +=item * + +And much, much more! + +=back + +That's really just a taste of some of the differences. Check out each role for +all the details. + +=head1 WHERE IS ALL THE DOC?! + +C extends +L, so that's probably the first place to +look when you are trying to figure out how everything works. + +Next would be to look at all the roles that fill in the blanks that +L expects to be filled. They would be +L, +L, +L, and +L. + +=method prepare_version_storage_install + + $dh->prepare_version_storage_install + +Creates the needed C<.sql> file to install the version storage and not the rest +of the tables + +=method prepare_install + + $dh->prepare_install + +First prepare all the tables to be installed and the prepare just the version +storage + +=method install_version_storage + + $dh->install_version_storage + +Install the version storage and not the rest of the tables + +=head1 THIS SUCKS + +You started your project and weren't using C? +Lucky for you I had you in mind when I wrote this doc. + +First off, you'll want to just install the C: + + my $s = My::Schema->connect(...); + my $dh = DBIx::Class::DeploymentHandler({ schema => $s }); + + $dh->prepare_version_storage_install; + $dh->install_version_storage; + +Then set your database version: + + $dh->add_database_version({ version => $s->version }); + +Now you should be able to use C like normal! + +=head1 DONATIONS + +If you'd like to thank me for the work I've done on this module, don't give me +a donation. I spend a lot of free time creating free software, but I do it +because I love it. + +Instead, consider donating to someone who might actually need it. Obviously +you should do research when donating to a charity, so don't just take my word +on this. I like Children's Survival Fund: +L, but there are a host of other +charities that can do much more good than I will with your money.