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 'carp';
-
-has schema => (
- isa => 'DBIx::Class::Schema',
- is => 'ro',
- required => 1,
- handles => [qw{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
+
+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::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
+ });
}
-has _filedata => (
- isa => '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->resultset('VersionResult') }
-
-method backup { $self->storage->backup($self->backup_directory) }
-
-method install($new_version) {
- carp 'Install not possible as versions table already exists in database'
- unless $self->is_installed;
-
- $new_version ||= $self->schema_version;
-
- if ($new_version) {
- $self->schema->deploy;
-
- $self->version_rs->create({
- version => $new_version,
- # ddl => $ddl,
- # upgrade_sql => $upgrade_sql,
- });
- }
+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,
+ });
}
-method create_upgrade_path { }
+sub prepare_install {
+ $_[0]->prepare_deploy;
+ $_[0]->prepare_version_storage_install;
+}
-method ordered_schema_versions { }
+# the following is just a hack so that ->version_storage
+# won't be lazy
+sub BUILD { $_[0]->version_storage }
+__PACKAGE__->meta->make_immutable;
-method upgrade {
- my $db_version = $self->db_version;
- my $schema_version = $self->schema_version;
+1;
- unless ($db_version) {
- carp 'Upgrade not possible as database is unversioned. Please call install first.';
- return;
- }
+#vim: ts=2 sw=2 expandtab
- if ( $db_version eq $schema_version ) {
- carp "Upgrade not necessary\n";
- return;
- }
+__END__
- my @version_list = $self->ordered_schema_versions ||
- ( $db_version, $schema_version );
+=head1 SYNOPSIS
- # remove all versions in list above the required version
- while ( @version_list && ( $version_list[-1] ne $schema_version ) ) {
- pop @version_list;
- }
+ use aliased 'DBIx::Class::DeploymentHandler' => 'DH';
+ my $s = My::Schema->connect(...);
- # remove all versions in list below the current version
- while ( @version_list && ( $version_list[0] ne $db_version ) ) {
- shift @version_list;
- }
+ my $dh = DH->new({
+ schema => $s,
+ databases => 'SQLite',
+ sql_translator_args => { add_drop_table => 0 },
+ });
- # check we have an appropriate list of versions
- die if @version_list < 2;
+ $dh->prepare_install;
- # do sets of upgrade
- while ( @version_list >= 2 ) {
- $self->upgrade_single_step( $version_list[0], $version_list[1] );
- shift @version_list;
- }
-}
+ $dh->install;
-method upgrade_single_step($db_version, $target_version) {
- if ($db_version eq $target_version) {
- 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) {
- 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";
-
- # backup if necessary then apply upgrade
- $self->_filedata($self->_read_sql_file($upgrade_file));
- $self->backup if $self->do_backup;
- $self->schema->txn_do(sub { $self->do_upgrade });
-
- # set row in dbix_class_schema_versions table
- $self->version_rs->create({
- version => $target_version,
- # ddl => $ddl,
- # upgrade_sql => $upgrade_sql,
- });
-}
+or for upgrades:
-method do_upgrade { $self->run_upgrade(qr/.*?/) }
+ use aliased 'DBIx::Class::DeploymentHandler' => 'DH';
+ my $s = My::Schema->connect(...);
-method run_upgrade($stm) {
- return unless $self->_filedata;
- my @statements = grep { $_ =~ $stm } @{$self->_filedata};
+ my $dh = DH->new({
+ schema => $s,
+ databases => 'SQLite',
+ sql_translator_args => { add_drop_table => 0 },
+ });
- for (@statements) {
- $self->storage->debugobj->query_start($_) if $self->storage->debug;
- $self->apply_statement($_);
- $self->storage->debugobj->query_end($_) if $self->storage->debug;
- }
-}
+ $dh->prepare_upgrade({
+ from_version => 1,
+ to_version => 2,
+ });
-method apply_statement($statement) {
- $self->storage->dbh->do($_) or carp "SQL was: $_"
-}
+ $dh->upgrade;
-sub _create_db_to_schema_diff {
- my $self = shift;
+=head1 DESCRIPTION
- my %driver_to_db_map = (
- 'mysql' => 'MySQL'
- );
+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.
- my $db = $driver_to_db_map{$self->storage->dbh->{Driver}{Name}};
- unless ($db) {
- print "Sorry, this is an unsupported DB\n";
- return;
- }
+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 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
+with):
- $self->throw_exception($self->storage->_sqlt_version_error)
- unless $self->storage->_sqlt_version_ok;
+=over
- my $db_tr = SQL::Translator->new({
- add_drop_table => 1,
- parser => 'DBI',
- parser_args => { dbh => $self->storage->dbh },
- producer => $db,
- });
+=item *
- my $dbic_tr = SQL::Translator->new({
- parser => 'SQL::Translator::Parser::DBIx::Class',
- data => $self,
- producer => $db,
- });
+Downgrades in addition to upgrades.
- $db_tr->schema->name('db_schema');
- $dbic_tr->schema->name('dbic_schema');
-
- # is this really necessary?
- foreach my $tr ($db_tr, $dbic_tr) {
- my $data = $tr->data;
- $tr->parser->($tr, $$data);
- }
-
- my $diff = SQL::Translator::Diff::schema_diff(
- $db_tr->schema, $db,
- $dbic_tr->schema, $db, {
- ignore_constraint_names => 1,
- ignore_index_names => 1,
- caseopt => 1,
- }
- );
-
- my $filename = $self->ddl_filename(
- $db,
- $self->schema_version,
- $self->upgrade_directory,
- 'PRE',
- );
-
- open my $file, '>', $filename
- or $self->throw_exception("Can't open $filename for writing ($!)");
- print {$file} $diff;
- close $file;
-
- carp "WARNING: There may be differences between your DB and your DBIC schema.\n" .
- "Please review and if necessary run the SQL in $filename to sync your DB.\n";
-}
+=item *
-method _read_sql_file($file) {
- return unless $file;
+Multiple sql files files per upgrade/downgrade/install.
- open my $fh, '<', $file or carp("Can't open upgrade file, $file ($!)");
- my @data = split /\n/, join '', <$fh>;
- close $fh;
+=item *
- @data = grep {
- $_ &&
- !/^--/ &&
- !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/m
- } split /;/,
- join '', @data;
+Perl scripts allowed for upgrade/downgrade/install.
- return \@data;
-}
+=item *
-1;
+Just one set of files needed for upgrade, unlike before where one might need
+to generate C<factorial(scalar @versions)>, 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<DBIx::Class::DeploymentHandler> extends
+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 pieces that fill in the blanks that
+L<DBIx::Class::DeploymentHandler::Dad> expects to be filled. They would be
+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
+
+ $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<DBIx::Class::DeploymentHandler>?
+Lucky for you I had you in mind when I wrote this doc.
+
+First,
+L<define the version|DBIx::Class::DeploymentHandler::Manual::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->schema_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.
+
+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.