1;
+#vim: ts=2 sw=2 expandtab
+
+__END__
+
=head1 SYNOPSIS
use aliased 'DBIx::Class::DeploymentHandler' => 'DH';
Install the version storage and not the rest of the tables
-__END__
+=head1 THIS SUCKS
+
+You started your project and weren't using DBICDH? FOOL! Lucky for you I had
+you in mind when I wrote this doc <3
+
+First off, you'll want to just install the version_storage:
+
+ my $s = My::Schema->connect(...);
+ my $dh = DeployHandler({ schema => $s });
+
+ $dh->prepare_version_storage_install;
+ $dh->install_version_storage;
-vim: ts=2 sw=2 expandtab
+Then, bump your schema version, and you can use DBICDH like normal!
$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
=head2 prepare_resultsource_install
-see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_resultsouce_install>
+see L<DBIx::Class::DeploymentHandler::HandlesDeploy/prepare_resultsource_install>
=head2 install_resultsource
=head1 DESCRIPTION
-Typically a VersionHandler will take a to_version and yeild an iterator of
+Typically a VersionHandler will take a C<to_version> and yeild an iterator of
"version sets."
-A "version set" is basically an arrayref of "version numbers" (which we
-already know is vague as is.) Typically a call to a VersionHandler's
-L</next_version_set> with a db version of 1 and a "to_version" of 5 will
-iterate over something like the following:
+A "version set" could be defined as:
+
+ subtype 'Version', as 'Str';
+ subtype 'VersionSet', as 'ArrayRef[Str]';
+
+and all a "version set" does is uniquely identify a migration.
+
+Typically a call to a VersionHandler's L</next_version_set> with a C<db_version>
+of 1 and a C<to_version> of 5 will iterate over something like the following:
[1, 2]
[2, 3]
[1, 5]
undef
-Really how the version set's are arranged is up to the VersionHandler being
+Really how the version sets are arranged is up to the VersionHandler being
used.
In some cases users will not want versions to have inherent "previous
__END__
-=head1 THIS SUCKS
-
-You started your project and weren't using DBICDH? FOOL! Lucky for you I had
-you in mind when I wrote this doc <3
-
-First off, you'll want to just install the version_storage:
-
- my $s = My::Schema->connect(...);
- my $dh = DeployHandler({ schema => $s });
-
- $dh->prepare_version_storage_install;
- $dh->install_version_storage;
-
-Then, bump your schema version, and you can use DBICDH like normal!
-
vim: ts=2 sw=2 expandtab