package DBIx::Class::DeploymentHandler::Dad;
+# ABSTRACT: Parent class for DeploymentHandlers
+
use Moose;
use Method::Signatures::Simple;
-use DBIx::Class::DeploymentHandler::Types;
require DBIx::Class::Schema; # loaded for type constraint
-require DBIx::Class::ResultSet; # loaded for type constraint
use Carp::Clan '^DBIx::Class::DeploymentHandler';
has schema => (
isa => 'DBIx::Class::Schema',
is => 'ro',
required => 1,
- handles => ['schema_version'],
-);
-
-has upgrade_directory => ( # configuration
- isa => 'Str',
- is => 'ro',
- required => 1,
- default => 'sql',
);
-has backup_directory => ( # configuration
+has backup_directory => (
isa => 'Str',
is => 'ro',
predicate => 'has_backup_directory',
);
-has to_version => ( # configuration
+has to_version => (
is => 'ro',
lazy_build => 1,
);
sub _build_to_version { $_[0]->schema->schema_version }
-has databases => ( # configuration
- coerce => 1,
- isa => 'DBIx::Class::DeploymentHandler::Databases',
- is => 'ro',
- default => sub { [qw( MySQL SQLite PostgreSQL )] },
+has schema_version => (
+ is => 'ro',
+ lazy_build => 1,
);
-has sqltargs => ( # configuration
- isa => 'HashRef',
- is => 'ro',
- default => sub { {} },
-);
+sub _build_schema_version { $_[0]->schema->schema_version }
method install {
croak 'Install not possible as versions table already exists in database'
my $ddl = $self->deploy;
- $self->version_storage->add_database_version({
+ $self->add_database_version({
version => $self->to_version,
ddl => $ddl,
});
1;
+# vim: ts=2 sw=2 expandtab
+
+__END__
+
=pod
=attr schema
-=attr upgrade_directory
+The L<DBIx::Class::Schema> (B<required>) 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 where backups are stored
+
=attr to_version
-=attr databases
+The version (defaults to schema's version) to migrate the database to
=method install
+ $dh->install
+
+Deploys the current schema into the database. Populates C<version_storage> with
+C<version> and C<ddl>.
+
+B<Note>: you typically need to call C<< $dh->prepare_deploy >> before you call
+this method.
+
+B<Note>: you cannot install on top of an already installed database
+
=method upgrade
+ $dh->upgrade
+
+Upgrades the database one step at a time till L</next_version_set>
+returns C<undef>. Each upgrade step will add a C<version>, C<ddl>, and
+C<upgrade_sql> to the version storage (if C<ddl> and/or C<upgrade_sql> are
+returned from L</upgrade_single_step>.
+
+=method downgrade
+
+ $dh->downgrade
+
+Downgrades the database one step at a time till L</previous_version_set>
+returns C<undef>. Each downgrade step will delete a C<version> from the
+version storage.
+
=method backup
-__END__
+ $dh->backup
+
+Simply calls backup on the C<< $schema->storage >>, passing in
+C<< $self->backup_directory >> as an argument. Please test yourself before
+assuming it will work.
+
+=head1 METHODS THAT ARE REQUIRED IN SUBCLASSES
+
+=head2 deploy
+
+See L<DBIx::Class::DeploymentHandler::HandlesDeploy/deploy>.
+
+=head2 version_storage_is_installed
+
+See L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/version_storage_is_installed>.
+
+=head2 add_database_version
+
+See L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/add_database_version>.
+
+=head2 delete_database_version
+
+See L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/delete_database_version>.
+
+=head2 next_version_set
+
+See L<DBIx::Class::DeploymentHandler::HandlesVersioning/next_version_set>.
+
+=head2 previous_version_set
+
+See L<DBIx::Class::DeploymentHandler::HandlesVersioning/previous_version_set>.
+
+=head2 upgrade_single_step
+
+See L<DBIx::Class::DeploymentHandler::HandlesDeploy/upgrade_single_step>.
+
+=head2 downgrade_single_step
+
+See L<DBIx::Class::DeploymentHandler::HandlesDeploy/downgrade_single_step>.
+
+=head1 ORTHODOX METHODS
+
+These methods are not actually B<required> 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 database_version
+
+see L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/database_version>
+
+=head2 prepare_deploy
+
+see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_deploy>
+
+=head2 prepare_resultsource_install
+
+see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_resultsource_install>
+
+=head2 install_resultsource
+
+see L<DBIx::Class::DeploymentHandler::HandlesDeploy/install_resultsource>
+
+=head2 prepare_upgrade
+
+see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_upgrade>
+
+=head2 prepare_downgrade
+
+see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_downgrade>
+
+=head2 SUBCLASSING
+
+All of the methods mentioned in L</METHODS THAT ARE REQUIRED IN SUBCLASSES> and
+L</ORTHODOX METHODS> 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<DBIx::Class::DeploymentHandler> and
+L<DBIx::Class::DeploymentHandler::Deprecated>, 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<DBIx::Class::DeploymentHandler::HandlesDeploy>,
+L<DBIx::Class::DeploymentHandler::HandlesVersioning>, and
+L<DBIx::Class::DeploymentHandler::HandlesVersionStorage>.
-vim: ts=2 sw=2 expandtab
projects / dbsrgits/DBIx-Class-DeploymentHandler.git / blobdiff