lots more doc
[dbsrgits/DBIx-Class-DeploymentHandler.git] / lib / DBIx / Class / DeploymentHandler / HandlesDeploy.pm
CommitLineData
7521a845 1package DBIx::Class::DeploymentHandler::HandlesDeploy;
2use Moose::Role;
3
4requires 'prepare_install';
c8a2f7bd 5requires 'prepare_resultsource_install';
6requires 'install_resultsource';
a41a04e5 7requires 'prepare_upgrade';
76d311e7 8requires 'prepare_downgrade';
7d2a6974 9requires 'upgrade_single_step';
10requires 'downgrade_single_step';
11requires 'deploy';
7521a845 12
131;
14
96ef97e5 15# should this be renamed prepare_deploy?
16
17=method prepare_install
18
19 $deploy_method->prepare_install;
20
21=method deploy
22
5228a963 23 $dh->deploy
24
25Deploy the schema to the database.
96ef97e5 26
27=method prepare_resultsource_install
28
29 $deploy_method->prepare_resultsource_install($resultset->result_source);
30
31=method install_resultsource
32
33 $deploy_method->prepare_resultsource_install($resultset->result_source);
34
35# for updates prepared automatically (rob's stuff)
36# one would want to explicitly set $version_set to
37# [$to_version]
38
39=method prepare_upgrade
40
41 $deploy_method->prepare_upgrade(1, 2, [1, 2]);
42
43# for updates prepared automatically (rob's stuff)
44# one would want to explicitly set $version_set to
45# [$to_version]
46
47=method prepare_downgrade
48
49 $deploy_method->prepare_downgrade(2, 1, [1, 2]);
50
51=method upgrade_single_step
52
5228a963 53 my ($ddl, $sql) = @{$dh->upgrade_single_step($version_set)||[]}
54
55call a single upgrade migration. Takes an arrayref describing the version to
56upgrade to. Optionally return an arrayref containing C<$ddl> describing
57version installed and C<$sql> used to get to that version.
96ef97e5 58
59=method downgrade_single_step
60
5228a963 61 $dh->downgrade_single_step($version_set);
62
63call a single downgrade migration. Takes an arrayref describing the version to
64downgrade to.
96ef97e5 65
ed1721b9 66=head1 KNOWN IMPLEMENTATIONS
67
68=over
69
70=item *
71
72L<DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator>
73
74=item *
75
76L<DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator::Deprecated>
77
78=back
79
80__END__
81
7521a845 82vim: ts=2 sw=2 expandtab