X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FDeploymentHandler%2FHandlesDeploy.pm;h=b020eacccd994357a12f9e5ad0f2c2f1c7af83a6;hb=a976d6e46695d7015239ee4c30cb3708f4ce7942;hp=feba3736bcb366af2918b6b22e6d33f5d51530fe;hpb=9deabd1fcf64a04422d1903f8656ac445e73336a;p=dbsrgits%2FDBIx-Class-DeploymentHandler.git

diff --git a/lib/DBIx/Class/DeploymentHandler/HandlesDeploy.pm b/lib/DBIx/Class/DeploymentHandler/HandlesDeploy.pm
index feba373..b020eac 100644
--- a/lib/DBIx/Class/DeploymentHandler/HandlesDeploy.pm
+++ b/lib/DBIx/Class/DeploymentHandler/HandlesDeploy.pm
@@ -1,16 +1,23 @@
 package DBIx::Class::DeploymentHandler::HandlesDeploy;
-use Moose::Role;
+use Moo::Role;
 
 # ABSTRACT: Interface for deploy methods
 
-requires 'prepare_install';
+requires 'initialize';
+
+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';
+
+requires 'txn_do';
 
 1;
 
@@ -18,37 +25,53 @@ requires 'deploy';
 
 __END__
 
-=method prepare_install
+=method initialize
+
+ $dh->initialize({
+   version      => 1,
+   storage_type => 'SQLite'
+ });
+
+Run scripts before deploying to the database
 
- (should this be renamed prepare_deploy?)
+=method prepare_deploy
 
- $dh->prepare_install
+ $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
 
- $dh->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
 
- $dh->prepare_resultsource_install($resultset->result_source);
+ $dh->install_resultsource({
+   result_source => $resultset->result_source,
+   version       => 1,
+ })
 
 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]);
+ $dh->prepare_upgrade({
+   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 up from the first version to the second version.
@@ -56,16 +79,22 @@ The version set uniquely identifies the migration.
 
 =method prepare_downgrade
 
- $dh->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
+The version set uniquely identifies the migration and should match its
 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 a version set as an argument.
 Optionally return C<< [ $ddl, $upgrade_sql ] >> where C<$ddl> is the DDL for
@@ -81,6 +110,12 @@ 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 txn_do
+
+ $dh->txn_do(sub { ... })
+
+Wrap the passed coderef in a transaction (if transactions are enabled.)
+
 =head1 KNOWN IMPLEMENTATIONS
 
 =over