release 0.001000_05

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

diff --git a/lib/DBIx/Class/DeploymentHandler.pm b/lib/DBIx/Class/DeploymentHandler.pm
index d679d5b..1fd2038 100644 (file)
--- a/lib/DBIx/Class/DeploymentHandler.pm
+++ b/lib/DBIx/Class/DeploymentHandler.pm
@@ -1,5 +1,7 @@
 package DBIx::Class::DeploymentHandler;
 
+# ABSTRACT: Extensible DBIx::Class deployment
+
 use Moose;
 
 extends 'DBIx::Class::DeploymentHandler::Dad';
@@ -26,13 +28,20 @@ sub install_version_storage {
   );
 }
 
+sub prepare_install {
+   $_[0]->prepare_deploy;
+   $_[0]->prepare_version_storage_install;
+}
+
 __PACKAGE__->meta->make_immutable;
 
 1;
 
+#vim: ts=2 sw=2 expandtab
+
 __END__
 
-=SYNOPSIS
+=head1 SYNOPSIS
 
  use aliased 'DBIx::Class::DeploymentHandler' => 'DH';
  my $s = My::Schema->connect(...);
@@ -79,8 +88,6 @@ with):
 
 =over
 
-=over
-
 =item *
 
 Downgrades in addition to upgrades.
@@ -127,10 +134,46 @@ L<DBIx::Class::DeploymentHandler::WithReasonableDefaults>.
 Creates the needed C<.sql> file to install the version storage and not the rest
 of the tables
 
+=method prepare_install
+
+ $dh->prepare_install
+
+First prepare all the tables to be installed and the prepare just the version
+storage
+
 =method install_version_storage
 
  $dh->install_version_storage
 
 Install the version storage and not the rest of the tables
 
-vim: ts=2 sw=2 expandtab
+=head1 THIS SUCKS
+
+You started your project and weren't using C<DBIx::Class::DeploymentHandler>?
+Lucky for you I had you in mind when I wrote this doc.
+
+First off, you'll want to just install the C<version_storage>:
+
+ my $s = My::Schema->connect(...);
+ my $dh = DBIx::Class::DeploymentHandler({ schema => $s });
+
+ $dh->prepare_version_storage_install;
+ $dh->install_version_storage;
+
+Then set your database version:
+
+ $dh->add_database_version({ version => $s->version });
+
+Now you should be able to use C<DBIx::Class::DeploymentHandler> like normal!
+
+=head1 DONATIONS
+
+If you'd like to thank me for the work I've done on this module, don't give me
+a donation. I spend a lot of free time creating free software, but I do it
+because I love it.
+
+Instead, consider donating to someone who might actually need it.  Obviously
+you should do research when donating to a charity, so don't just take my word
+on this.  I like Children's Survival Fund:
+L<http://www.childrenssurvivalfund.org>, but there are a host of other
+charities that can do much more good than I will with your money.