rename sqltargs to sql_translator_args

[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 394a16e..2a37231 100644 (file)
--- a/lib/DBIx/Class/DeploymentHandler.pm
+++ b/lib/DBIx/Class/DeploymentHandler.pm
@@ -28,19 +28,28 @@ 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__
+
 =head1 SYNOPSIS
 
  use aliased 'DBIx::Class::DeploymentHandler' => 'DH';
  my $s = My::Schema->connect(...);
 
  my $dh = DH->new({
-   schema => $s,
-   databases => 'SQLite',
-   sqltargs => { add_drop_table => 0 },
+   schema              => $s,
+   databases           => 'SQLite',
+   sql_translator_args => { add_drop_table => 0 },
  });
 
  $dh->prepare_install;
@@ -53,9 +62,9 @@ or for upgrades:
  my $s = My::Schema->connect(...);
 
  my $dh = DH->new({
-   schema => $s,
-   databases => 'SQLite',
-   sqltargs => { add_drop_table => 0 },
+   schema              => $s,
+   databases           => 'SQLite',
+   sql_translator_args => { add_drop_table => 0 },
  });
 
  $dh->prepare_upgrade(1, 2);
@@ -125,12 +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
 
-__END__
+=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.
 
-vim: ts=2 sw=2 expandtab
+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.