rearrange doc

[dbsrgits/DBIx-Class-DeploymentHandler.git] / lib / DBIx / Class / DeploymentHandler / HandlesDeploy.pm

diff --git a/lib/DBIx/Class/DeploymentHandler/HandlesDeploy.pm b/lib/DBIx/Class/DeploymentHandler/HandlesDeploy.pm
index d328b52..3ee83f0 100644 (file)
--- a/lib/DBIx/Class/DeploymentHandler/HandlesDeploy.pm
+++ b/lib/DBIx/Class/DeploymentHandler/HandlesDeploy.pm
@@ -2,14 +2,67 @@ package DBIx::Class::DeploymentHandler::HandlesDeploy;
 use Moose::Role;
 
 requires 'prepare_install';
+requires 'prepare_resultsource_install';
+requires 'install_resultsource';
 requires 'prepare_upgrade';
 requires 'prepare_downgrade';
-requires '_upgrade_single_step';
-requires '_downgrade_single_step';
-requires '_deploy';
+requires 'upgrade_single_step';
+requires 'downgrade_single_step';
+requires 'deploy';
 
 1;
 
 __END__
 
+# should this be renamed prepare_deploy?
+
+=method prepare_install
+
+ $deploy_method->prepare_install;
+
+=method deploy
+
+ $dh->deploy
+
+Deploy the schema to the database.
+
+=method prepare_resultsource_install
+
+ $deploy_method->prepare_resultsource_install($resultset->result_source);
+
+=method install_resultsource
+
+ $deploy_method->prepare_resultsource_install($resultset->result_source);
+
+# for updates prepared automatically (rob's stuff)
+# one would want to explicitly set $version_set to
+# [$to_version]
+
+=method prepare_upgrade
+
+ $deploy_method->prepare_upgrade(1, 2, [1, 2]);
+
+# for updates prepared automatically (rob's stuff)
+# one would want to explicitly set $version_set to
+# [$to_version]
+
+=method prepare_downgrade
+
+ $deploy_method->prepare_downgrade(2, 1, [1, 2]);
+
+=method upgrade_single_step
+
+ my ($ddl, $sql) = @{$dh->upgrade_single_step($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.
+
+=method downgrade_single_step
+
+ $dh->downgrade_single_step($version_set);
+
+call a single downgrade migration.  Takes an arrayref describing the version to
+downgrade to.
+
 vim: ts=2 sw=2 expandtab