X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FDeploymentHandler%2FHandlesDeploy.pm;h=089eda12473111182e480852fce21ddaff5c4312;hb=be16f27bd8bd3119d5ceedcc1e023f4326b4e46c;hp=e8994950523588f83d1578ca191241470e91f045;hpb=7521a845ba34a0063724e30987b6ab350d5942e5;p=dbsrgits%2FDBIx-Class-DeploymentHandler.git

diff --git a/lib/DBIx/Class/DeploymentHandler/HandlesDeploy.pm b/lib/DBIx/Class/DeploymentHandler/HandlesDeploy.pm
index e899495..089eda1 100644
--- a/lib/DBIx/Class/DeploymentHandler/HandlesDeploy.pm
+++ b/lib/DBIx/Class/DeploymentHandler/HandlesDeploy.pm
@@ -1,13 +1,106 @@
 package DBIx::Class::DeploymentHandler::HandlesDeploy;
 use Moose::Role;
 
-requires 'prepare_install';
-requires 'prepare_update';
-requires '_upgrade_single_step';
-requires '_deploy';
+# ABSTRACT: Interface for deploy methods
+
+requires 'preinstall';
+
+requires 'prepare_deploy';
+requires 'deploy';
+
+requires 'prepare_resultsource_install';
+requires 'install_resultsource';
+
+requires 'prepare_upgrade';
+requires 'upgrade_single_step';
+
+requires 'prepare_downgrade';
+requires 'downgrade_single_step';
 
 1;
 
+# vim: ts=2 sw=2 expandtab
+
 __END__
 
-vim: ts=2 sw=2 expandtab
+=method preinstall
+
+ $dh->preinstall
+
+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
+
+Deploy the schema to the database.
+
+=method prepare_resultsource_install
+
+ $dh->prepare_resultsource_install($resultset->result_source)
+
+Takes a L<DBIx::Class::ResultSource> and generates a single migration file to
+create the resultsource's table.
+
+=method install_resultsource
+
+ $dh->prepare_resultsource_install($resultset->result_source);
+
+Takes a L<DBIx::Class::ResultSource> and runs a single migration file to
+deploy the resultsource's table.
+
+=method prepare_upgrade
+
+ $dh->prepare_upgrade(1, 2, [1, 2]);
+
+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
+
+ $dh->prepare_downgrade(2, 1, [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)||[]}
+
+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 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
+
+=over
+
+=item *
+
+L<DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator>
+
+=item *
+
+L<DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator::Deprecated>
+
+=back
+