various pod fixes

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

diff --git a/lib/DBIx/Class/DeploymentHandler/Dad.pm b/lib/DBIx/Class/DeploymentHandler/Dad.pm
index db485b3..2051cd2 100644 (file)
--- a/lib/DBIx/Class/DeploymentHandler/Dad.pm
+++ b/lib/DBIx/Class/DeploymentHandler/Dad.pm
@@ -107,7 +107,7 @@ returned from L</upgrade_single_step>.
  $dh->downgrade
 
 Downgrades the database one step at a time till L</previous_version_set>
-returns C<undef>.  Each downgrade step will delete a C<version>from the
+returns C<undef>.  Each downgrade step will delete a C<version> from the
 version storage.
 
 =method backup
@@ -120,71 +120,84 @@ assuming it will work.
 
 =head1 METHODS THAT ARE REQUIRED IN SUBCLASSES
 
+=head2 deploy
+
+See L<DBIx::Class::DeploymentHandler::HandlesDeploy/deploy>.
+
 =head2 version_storage_is_installed
 
- warn q(I can't version this database!)
-   unless $dh->version_storage_is_installed
+See L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/version_storage_is_installed>.
 
-return true iff the version storage is installed.
+=head2 add_database_version
 
-=head2 deploy
+See L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/add_database_version>.
 
- $dh->deploy
+=head2 delete_database_version
 
-Deploy the schema to the database.
+See L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/delete_database_version>.
 
-=head2 add_database_version
+=head2 next_version_set
 
- $dh->add_database_version({
-   version     => '1.02',
-   ddl         => $ddl # can be undef,
-   upgrade_sql => $sql # can be undef,
- });
+See L<DBIx::Class::DeploymentHandler::HandlesVersioning/next_version_set>.
 
-Store a new version into the version storage
+=head2 previous_version_set
 
-=head2 delete_database_version
+See L<DBIx::Class::DeploymentHandler::HandlesVersioning/previous_version_set>.
 
- $dh->delete_database_version({ version => '1.02' })
+=head2 upgrade_single_step
 
-simply deletes given database version from the version storage
+See L<DBIx::Class::DeploymentHandler::HandlesDeploy/upgrade_single_step>.
 
-=head2 next_version_set
+=head2 downgrade_single_step
 
- print 'versions to install: ';
- while (my $vs = $dh->next_version_set) {
-   print join q(, ), @{$vs}
- }
- print qq(\n);
+See L<DBIx::Class::DeploymentHandler::HandlesDeploy/downgrade_single_step>.
 
-return an arrayref describing each version that needs to be
-installed to upgrade to C<< $dh->to_version >>.
+=head1 ORTHODOX METHODS
 
-=head2 previous_version_set
+These methods are not actually B<required> as things will probably still work
+if you don't implement them, but if you want your subclass to get along with
+other subclasses (or more likely, tools made to use another subclass), you
+should probably implement these too, even if they are no-ops.
 
- print 'versions to uninstall: ';
- while (my $vs = $dh->previous_version_set) {
-   print join q(, ), @{$vs}
- }
- print qq(\n);
+=head2 database_version
 
-return an arrayref describing each version that needs to be
-"installed" to downgrade to C<< $dh->to_version >>.
+see L<DBIx::Class::DeploymentHandler::HandlesVersionStorage/database_version>
 
-=head2 upgrade_single_step
+=head2 prepare_install
 
- my ($ddl, $sql) = @{$dh->upgrade_single_step($version_set)||[]}
+see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_install>
 
-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.
+=head2 prepare_resultsource_install
 
-=head2 downgrade_single_step
+see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_resultsource_install>
+
+=head2 install_resultsource
+
+see L<DBIx::Class::DeploymentHandler::HandlesDeploy/install_resultsource>
+
+=head2 prepare_upgrade
+
+see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_upgrade>
+
+=head2 prepare_downgrade
+
+see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_downgrade>
+
+=back
+
+=head2 SUBCLASSING
 
- $dh->upgrade_single_step($version_set);
+All of the methods mentioned in L</METHODS THAT ARE REQUIRED IN SUBCLASSES> and
+L</ORTHODOX METHODS> can be implemented in any fashion you choose.  In the
+spirit of code reuse I have used roles to implement them in my two subclasses,
+L<DBIx::Class::DeploymentHandler> and
+L<DBIx::Class::DeploymentHandler::Deprecated>, but you are free to implement
+them entirely in a subclass if you so choose to.
 
-call a single downgrade migration.  Takes an arrayref describing the version to
-downgrade to.
+For in-depth documentation on how methods are supposed to work, see the roles
+L<DBIx::Class::DeploymentHandler::HandlesDeploy>,
+L<DBIx::Class::DeploymentHandler::HandlesVersioning>, and
+L<DBIx::Class::DeploymentHandler::HandlesVersionStorage>.
 
 __END__