initial pod docs
[dbsrgits/DBIx-Class-DeploymentHandler.git] / lib / DBIx / Class / DeploymentHandler / HandlesDeploy.pm
1 package DBIx::Class::DeploymentHandler::HandlesDeploy;
2 use Moose::Role;
3
4 requires 'prepare_install';
5 requires 'prepare_resultsource_install';
6 requires 'install_resultsource';
7 requires 'prepare_upgrade';
8 requires 'prepare_downgrade';
9 requires 'upgrade_single_step';
10 requires 'downgrade_single_step';
11 requires 'deploy';
12
13 1;
14
15 __END__
16
17 # should this be renamed prepare_deploy?
18
19 =method prepare_install
20
21  $deploy_method->prepare_install;
22
23 =method deploy
24
25  $deploy_method->deploy;
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
53  $deploy_method->upgrade_single_step([1, 2]);
54
55 =method downgrade_single_step
56
57  $deploy_method->upgrade_single_step([1, 2]);
58
59 vim: ts=2 sw=2 expandtab