package DBIx::Class::DeploymentHandler::HandlesDeploy;
use Moose::Role;
-requires 'prepare_install';
+# ABSTRACT: Interface for deploy methods
+
+requires 'preinstall';
+
+requires 'prepare_deploy';
+requires 'deploy';
+
requires 'prepare_resultsource_install';
requires 'install_resultsource';
+
requires 'prepare_upgrade';
-requires 'prepare_downgrade';
requires 'upgrade_single_step';
+
+requires 'prepare_downgrade';
requires 'downgrade_single_step';
-requires 'deploy';
1;
-# should this be renamed prepare_deploy?
+# vim: ts=2 sw=2 expandtab
-=method prepare_install
+__END__
- $deploy_method->prepare_install;
+=method preinstall
+
+ $dh->preinstall({
+ version => 1,
+ storage_type => 'SQLite'
+ });
+
+Run scripts before deploying to the database
+
+=method prepare_deploy
+
+ $dh->prepare_deploy
+
+Generate the needed data files to install the schema to the database.
=method deploy
- $dh->deploy
+ $dh->deploy({ version => 1 })
Deploy the schema to the database.
=method prepare_resultsource_install
- $deploy_method->prepare_resultsource_install($resultset->result_source);
+ $dh->prepare_resultsource_install({
+ result_source => $resultset->result_source,
+ })
+
+Takes a L<DBIx::Class::ResultSource> and generates a single migration file to
+create the resultsource's table.
=method install_resultsource
- $deploy_method->prepare_resultsource_install($resultset->result_source);
+ $dh->install_resultsource({
+ result_source => $resultset->result_source,
+ version => 1,
+ })
-# for updates prepared automatically (rob's stuff)
-# one would want to explicitly set $version_set to
-# [$to_version]
+Takes a L<DBIx::Class::ResultSource> and runs a single migration file to
+deploy the resultsource's table.
=method prepare_upgrade
- $deploy_method->prepare_upgrade(1, 2, [1, 2]);
+ $dh->prepare_upgrade({
+ from_version => 1,
+ to_version => 2,
+ version_set => [1, 2]
+ });
-# for updates prepared automatically (rob's stuff)
-# one would want to explicitly set $version_set to
-# [$to_version]
+Takes two versions and a version set. This basically is supposed to generate
+the needed C<SQL> to migrate up from the first version to the second version.
+The version set uniquely identifies the migration.
=method prepare_downgrade
- $deploy_method->prepare_downgrade(2, 1, [1, 2]);
+ $dh->prepare_downgrade({
+ from_version => 1,
+ to_version => 2,
+ version_set => [1, 2]
+ });
+
+Takes two versions and a version set. This basically is supposed to generate
+the needed C<SQL> to migrate down from the first version to the second version.
+The version set uniquely identifies the migration and should match it's
+respective upgrade version set.
=method upgrade_single_step
- my ($ddl, $sql) = @{$dh->upgrade_single_step($version_set)||[]}
+ my ($ddl, $sql) = @{
+ $dh->upgrade_single_step({ version_set => $version_set })
+ ||[]}
-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.
+Call a single upgrade migration. Takes a version set as an argument.
+Optionally return C<< [ $ddl, $upgrade_sql ] >> where C<$ddl> is the DDL for
+that version of the schema and C<$upgrade_sql> is the SQL that was run to
+upgrade the database.
=method downgrade_single_step
$dh->downgrade_single_step($version_set);
-call a single downgrade migration. Takes an arrayref describing the version to
-downgrade to.
+Call a single downgrade migration. Takes a version set as an argument.
+Optionally return C<< [ $ddl, $upgrade_sql ] >> where C<$ddl> is the DDL for
+that version of the schema and C<$upgrade_sql> is the SQL that was run to
+upgrade the database.
=head1 KNOWN IMPLEMENTATIONS
=back
-__END__
-
-vim: ts=2 sw=2 expandtab