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::WithMonotonicVersions',
- '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(
- $self->version_storage->version_rs->result_source
- );
+ $self->prepare_resultsource_install({
+ result_source => $self->version_storage->version_rs->result_source
+ });
}
sub install_version_storage {
my $self = shift;
- $self->install_resultsource(
- $self->version_storage->version_rs->result_source
- );
+ 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__
-=SYNOPSIS
+=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 },
+ schema => $s,
+ databases => 'SQLite',
+ sql_translator_args => { add_drop_table => 0 },
});
$dh->prepare_install;
my $s = My::Schema->connect(...);
my $dh = DH->new({
- schema => $s,
- databases => 'SQLite',
- sqltargs => { add_drop_table => 0 },
+ schema => $s,
+ databases => 'SQLite',
+ sql_translator_args => { add_drop_table => 0 },
});
- $dh->prepare_upgrade(1, 2);
+ $dh->prepare_upgrade({
+ from_version => 1,
+ to_version => 2,
+ });
$dh->upgrade;
=head1 DESCRIPTION
-C<DBIx::Class::DeploymentHandler> is, as it's name suggests, a tool for
+C<DBIx::Class::DeploymentHandler> is, as its name suggests, a tool for
deploying and upgrading databases with L<DBIx::Class>. It is designed to be
much more flexible than L<DBIx::Class::Schema::Versioned>, hence the use of
L<Moose> and lots of roles.
C<DBIx::Class::DeploymentHandler> 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
+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<DBIx::Class::Schema::Versioned> worked (and
L<DBIx::Class::DeploymentHandler::Deprecated> tries to maintain compatibility
L<DBIx::Class::DeploymentHandler::Dad>, 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
+Next would be to look at all the pieces that fill in the blanks that
L<DBIx::Class::DeploymentHandler::Dad> expects to be filled. They would be
-L<DBIx::Class::DeploymentHandler::WithSqltDeployMethod>,
-L<DBIx::Class::DeploymentHandler::WithMonotonicVersions>,
-L<DBIx::Class::DeploymentHandler::WithStandardVersionStorage>, and
+L<DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator>,
+L<DBIx::Class::DeploymentHandler::VersionHandler::Monotonic>,
+L<DBIx::Class::DeploymentHandler::VersionStorage::Standard>, and
L<DBIx::Class::DeploymentHandler::WithReasonableDefaults>.
=method 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
-__END__
+=head1 THIS SUCKS
+
+You started your project and weren't using C<DBIx::Class::DeploymentHandler>?
+Lucky for you I had you in mind when I wrote this doc.
+
+First,
+L<define the version|DBIx::Class::DeploymentHandler::Intro/Sample_database>
+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<DBIx::Class::DeploymentHandler> 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<fatal>, C<error>,
+C<warn>, C<info>, C<debug>, and C<trace>. 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<DBICDH_FATAL>, C<DBICDH_ERROR>, C<DBICDH_WARN>, C<DBICDH_INFO>,
+C<DBICDH_DEBUG>, and C<DBICDH_TRACE>. 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.
-vim: ts=2 sw=2 expandtab
+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<http://www.childrenssurvivalfund.org>, but there are a host of other
+charities that can do much more good than I will with your money.
projects / dbsrgits/DBIx-Class-DeploymentHandler.git / blobdiff