lots more 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 4ff7694..34e83ad 100644 (file)
--- a/lib/DBIx/Class/DeploymentHandler/HandlesDeploy.pm
+++ b/lib/DBIx/Class/DeploymentHandler/HandlesDeploy.pm
@@ -12,8 +12,6 @@ requires 'deploy';
 
 1;
 
-__END__
-
 # should this be renamed prepare_deploy?
 
 =method prepare_install
@@ -22,7 +20,9 @@ __END__
 
 =method deploy
 
- $deploy_method->deploy;
+ $dh->deploy
+
+Deploy the schema to the database.
 
 =method prepare_resultsource_install
 
@@ -50,10 +50,33 @@ __END__
 
 =method upgrade_single_step
 
- $deploy_method->upgrade_single_step([1, 2]);
+ 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
 
- $deploy_method->upgrade_single_step([1, 2]);
+ $dh->downgrade_single_step($version_set);
+
+call a single downgrade migration.  Takes an arrayref describing the version to
+downgrade to.
+
+=head1 KNOWN IMPLEMENTATIONS
+
+=over
+
+=item *
+
+L<DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator>
+
+=item *
+
+L<DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator::Deprecated>
+
+=back
+
+__END__
 
 vim: ts=2 sw=2 expandtab