X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FDeploymentHandler.pm;h=74602ed3ec5deb9a20a97699edf4d8edc1ff0dd7;hb=88fecddb0e689b3ecdbefdf9ba4912ad301ba357;hp=35246156dfc18d9ec038035604f1b3c257f6f42f;hpb=41219a5d4f081af0ad0507a465101a21546c1a4b;p=dbsrgits%2FDBIx-Class-DeploymentHandler.git diff --git a/lib/DBIx/Class/DeploymentHandler.pm b/lib/DBIx/Class/DeploymentHandler.pm index 3524615..74602ed 100644 --- a/lib/DBIx/Class/DeploymentHandler.pm +++ b/lib/DBIx/Class/DeploymentHandler.pm @@ -1,19 +1,304 @@ package DBIx::Class::DeploymentHandler; +# ABSTRACT: Extensible DBIx::Class deployment + use Moose; 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::WithDatabaseToSchemaVersions', - 'DBIx::Class::DeploymentHandler::WithStandardVersionStorage'; +with 'DBIx::Class::DeploymentHandler::WithApplicatorDumple' => { + interface_role => 'DBIx::Class::DeploymentHandler::HandlesDeploy', + class_name => 'DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator', + delegate_name => 'deploy_method', + attributes_to_assume => [qw(schema schema_version)], + attributes_to_copy => [qw( + ignore_ddl databases script_directory sql_translator_args force_overwrite + )], + }, + 'DBIx::Class::DeploymentHandler::WithApplicatorDumple' => { + interface_role => 'DBIx::Class::DeploymentHandler::HandlesVersioning', + class_name => 'DBIx::Class::DeploymentHandler::VersionHandler::Monotonic', + delegate_name => 'version_handler', + attributes_to_assume => [qw( database_version schema_version to_version )], + }, + 'DBIx::Class::DeploymentHandler::WithApplicatorDumple' => { + interface_role => 'DBIx::Class::DeploymentHandler::HandlesVersionStorage', + class_name => 'DBIx::Class::DeploymentHandler::VersionStorage::Standard', + delegate_name => 'version_storage', + attributes_to_assume => ['schema'], + }; with 'DBIx::Class::DeploymentHandler::WithReasonableDefaults'; +sub prepare_version_storage_install { + my $self = shift; + + $self->prepare_resultsource_install({ + result_source => $self->version_storage->version_rs->result_source + }); +} + +sub install_version_storage { + my $self = shift; + + my $version = (shift||{})->{version} || $self->schema_version; + + $self->install_resultsource({ + result_source => $self->version_storage->version_rs->result_source, + version => $version, + }); +} + +sub prepare_install { + $_[0]->prepare_deploy; + $_[0]->prepare_version_storage_install; +} + +# the following is just a hack so that ->version_storage +# won't be lazy +sub BUILD { $_[0]->version_storage } __PACKAGE__->meta->make_immutable; +sub dev_version_instaled { shift->database_version eq 'DEV' } + +use SQL::Translator; +sub install_dev_version { + my ($self, $extra) = @_; + + die 'roll back existing dev version before installing a new dev version' + if $self->dev_version_installed; + + my $from_schema = do { + my $t = SQL::Translator->new({ + debug => 0, + trace => 0, + parser => 'SQL::Translator::Parser::YAML', + }); + $t->translate($self->deploy_method->_ddl_protoschema_produce_filename( + $self->database_version, $self->script_directory + ) or die $t->error; + $t->schema; + }; + + my $to_schema = do { + my $t = SQL::Translator->new({ + parser => 'SQL::Translator::Parser::DBIx::Class', + parser_args => { + package => $self->schema, + }, + }); + $t->translate or die $t->error; + $t->schema; + }; + + my $db = $self->deploy_method->storage->sqlt_type; + + my @up = [SQL::Translator::Diff::schema_diff( + $source_schema, $db, + $dest_schema, $db, + $sqltargs + )]; + + my @down = [SQL::Translator::Diff::schema_diff( + $dest_schema, $db, + $source_schema, $db, + $sqltargs + )]; + + $self->deploy_method->_run_sql_array(\@up); + + $self->version_storage->version_rs->create({ + version => 'DEV', + upgrade_sql => \@up, + downgrade_sql => \@down, + extra => $extra, + }); +} + +sub remove_dev_version { + my ($self, $extra) = @_; + + die 'no dev version installed to remove' + unless $self->dev_version_installed; + + my ($dev_data, $to_version) = $self->version_storage + ->version_rs + ->search(undef, { + order_by => { -desc => 'id' }, + rows => 2, + })->all; + + $self->deploy_method->_run_sql_array(\@sql_to_run); + + $self->version_storage->version_rs->create({ + version => $to_version->version, + upgrade_sql => \@sql_to_run, + downgrade_sql => [], # not meant to be "reverted" + extra => $extra + }) +} + 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', + sql_translator_args => { 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', + sql_translator_args => { add_drop_table => 0 }, + }); + + $dh->prepare_upgrade({ + from_version => 1, + to_version => 2, + }); + + $dh->upgrade; + +=head1 DESCRIPTION + +C is, as its 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 yield the +best overall mileage. Each role it uses has its 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 pieces 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, +L +in your main schema file (maybe using C<$VERSION>). + +Then you'll want to just install the version_storage: + + my $s = My::Schema->connect(...); + my $dh = DBIx::Class::DeploymentHandler->new({ 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 LOGGING + +This is a complex tool, and because of that sometimes you'll want to see +what exactly is happening. The best way to do that is to use the built in +logging functionality. It the standard six log levels; C, C, +C, C, C, and C. Most of those are pretty self +explanatory. Generally a safe level to see what all is going on is debug, +which will give you everything except for the exact SQL being run. + +To enable the various logging levels all you need to do is set an environment +variables: C, C, C, C, +C, and C. Each level can be set on its own, +but the default is the first three on and the last three off, and the levels +cascade, so if you turn on trace the rest will turn on automatically. + +=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.