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  $dh->deploy
  26
  27 Deploy the schema to the database.
  28
  29 =method prepare_resultsource_install
  30
  31  $deploy_method->prepare_resultsource_install($resultset->result_source);
  32
  33 =method install_resultsource
  34
  35  $deploy_method->prepare_resultsource_install($resultset->result_source);
  36
  37 # for updates prepared automatically (rob's stuff)
  38 # one would want to explicitly set $version_set to
  39 # [$to_version]
  40
  41 =method prepare_upgrade
  42
  43  $deploy_method->prepare_upgrade(1, 2, [1, 2]);
  44
  45 # for updates prepared automatically (rob's stuff)
  46 # one would want to explicitly set $version_set to
  47 # [$to_version]
  48
  49 =method prepare_downgrade
  50
  51  $deploy_method->prepare_downgrade(2, 1, [1, 2]);
  52
  53 =method upgrade_single_step
  54
  55  my ($ddl, $sql) = @{$dh->upgrade_single_step($version_set)||[]}
  56
  57 call a single upgrade migration.  Takes an arrayref describing the version to
  58 upgrade to.  Optionally return an arrayref containing C<$ddl> describing
  59 version installed and C<$sql> used to get to that version.
  60
  61 =method downgrade_single_step
  62
  63  $dh->downgrade_single_step($version_set);
  64
  65 call a single downgrade migration.  Takes an arrayref describing the version to
  66 downgrade to.
  67
  68 vim: ts=2 sw=2 expandtab