X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FDeploymentHandler%2FDad.pm;h=d816acd6ff83168e3d9588b588aca7814fc5689c;hb=e86c0c07a9464b4a3cab37b9dfcf9971a8dd151b;hp=db485b3c8320487165fb7e0d36122a047efd412f;hpb=cfc9edf93ec15cb3ae64af76905d96c89681f51b;p=dbsrgits%2FDBIx-Class-DeploymentHandler.git diff --git a/lib/DBIx/Class/DeploymentHandler/Dad.pm b/lib/DBIx/Class/DeploymentHandler/Dad.pm index db485b3..d816acd 100644 --- a/lib/DBIx/Class/DeploymentHandler/Dad.pm +++ b/lib/DBIx/Class/DeploymentHandler/Dad.pm @@ -1,5 +1,7 @@ package DBIx::Class::DeploymentHandler::Dad; +# ABSTRACT: Parent class for DeploymentHandlers + use Moose; use Method::Signatures::Simple; require DBIx::Class::Schema; # loaded for type constraint @@ -9,7 +11,6 @@ has schema => ( isa => 'DBIx::Class::Schema', is => 'ro', required => 1, - handles => ['schema_version'], ); has backup_directory => ( @@ -20,10 +21,19 @@ has backup_directory => ( has to_version => ( is => 'ro', + isa => 'Str', lazy_build => 1, ); -sub _build_to_version { $_[0]->schema->schema_version } +sub _build_to_version { $_[0]->schema_version } + +has schema_version => ( + is => 'ro', + isa => 'Str', + lazy_build => 1, +); + +sub _build_schema_version { $_[0]->schema->schema_version } method install { croak 'Install not possible as versions table already exists in database' @@ -40,7 +50,9 @@ method install { sub upgrade { my $self = shift; while ( my $version_list = $self->next_version_set ) { - my ($ddl, $upgrade_sql) = @{$self->upgrade_single_step($version_list)||[]}; + my ($ddl, $upgrade_sql) = @{ + $self->upgrade_single_step({ version_set => $version_list }) + ||[]}; $self->add_database_version({ version => $version_list->[-1], @@ -53,7 +65,7 @@ sub upgrade { sub downgrade { my $self = shift; while ( my $version_list = $self->previous_version_set ) { - $self->downgrade_single_step($version_list); + $self->downgrade_single_step({ version_set => $version_list }); # do we just delete a row here? I think so but not sure $self->delete_database_version({ version => $version_list->[-1] }); @@ -66,6 +78,10 @@ __PACKAGE__->meta->make_immutable; 1; +# vim: ts=2 sw=2 expandtab + +__END__ + =pod =attr schema @@ -73,9 +89,14 @@ __PACKAGE__->meta->make_immutable; The L (B) that is used to talk to the database and generate the DDL. +=attr schema_version + +The version that the schema is currently at. Defaults to +C<< $self->schema->schema_version >>. + =attr backup_directory -The directory that backups are stored in +The directory where backups are stored =attr to_version @@ -88,7 +109,7 @@ The version (defaults to schema's version) to migrate the database to Deploys the current schema into the database. Populates C with C and C. -B: you typically need to call C<< $dh->prepare_install >> before you call +B: you typically need to call C<< $dh->prepare_deploy >> before you call this method. B: you cannot install on top of an already installed database @@ -107,7 +128,7 @@ returned from L. $dh->downgrade Downgrades the database one step at a time till L -returns C. Each downgrade step will delete a Cfrom the +returns C. Each downgrade step will delete a C from the version storage. =method backup @@ -120,72 +141,80 @@ assuming it will work. =head1 METHODS THAT ARE REQUIRED IN SUBCLASSES +=head2 deploy + +See L. + =head2 version_storage_is_installed - warn q(I can't version this database!) - unless $dh->version_storage_is_installed +See L. + +=head2 add_database_version -return true iff the version storage is installed. +See L. -=head2 deploy +=head2 delete_database_version - $dh->deploy +See L. -Deploy the schema to the database. +=head2 next_version_set -=head2 add_database_version +See L. - $dh->add_database_version({ - version => '1.02', - ddl => $ddl # can be undef, - upgrade_sql => $sql # can be undef, - }); +=head2 previous_version_set -Store a new version into the version storage +See L. -=head2 delete_database_version +=head2 upgrade_single_step - $dh->delete_database_version({ version => '1.02' }) +See L. -simply deletes given database version from the version storage +=head2 downgrade_single_step -=head2 next_version_set +See L. - print 'versions to install: '; - while (my $vs = $dh->next_version_set) { - print join q(, ), @{$vs} - } - print qq(\n); +=head1 ORTHODOX METHODS -return an arrayref describing each version that needs to be -installed to upgrade to C<< $dh->to_version >>. +These methods are not actually B as things will probably still work +if you don't implement them, but if you want your subclass to get along with +other subclasses (or more likely, tools made to use another subclass), you +should probably implement these too, even if they are no-ops. -=head2 previous_version_set +=head2 database_version - print 'versions to uninstall: '; - while (my $vs = $dh->previous_version_set) { - print join q(, ), @{$vs} - } - print qq(\n); +see L -return an arrayref describing each version that needs to be -"installed" to downgrade to C<< $dh->to_version >>. +=head2 prepare_deploy -=head2 upgrade_single_step +see L - my ($ddl, $sql) = @{$dh->upgrade_single_step($version_set)||[]} +=head2 prepare_resultsource_install -call a single upgrade migration. Takes an arrayref describing the version to -upgrade to. Optionally return an arrayref containing C<$ddl> describing -version installed and C<$sql> used to get to that version. +see L -=head2 downgrade_single_step +=head2 install_resultsource - $dh->upgrade_single_step($version_set); +see L -call a single downgrade migration. Takes an arrayref describing the version to -downgrade to. +=head2 prepare_upgrade -__END__ +see L + +=head2 prepare_downgrade + +see L + +=head2 SUBCLASSING + +All of the methods mentioned in L and +L can be implemented in any fashion you choose. In the +spirit of code reuse I have used roles to implement them in my two subclasses, +L and +L, but you are free to implement +them entirely in a subclass if you so choose to. + +For in-depth documentation on how methods are supposed to work, see the roles +L, +L, and +L. -vim: ts=2 sw=2 expandtab