lib/DBIx/Class/DeploymentHandler/HandlesDeploy.pm

   1 package DBIx::Class::DeploymentHandler::HandlesDeploy;
   2 use Moose::Role;
   3
   4 # ABSTRACT: Interface for deploy methods
   5
   6 requires 'preinstall_scripts';
   7
   8 requires 'prepare_deploy';
   9 requires 'deploy';
  10
  11 requires 'prepare_resultsource_install';
  12 requires 'install_resultsource';
  13
  14 requires 'prepare_upgrade';
  15 requires 'upgrade_single_step';
  16
  17 requires 'prepare_downgrade';
  18 requires 'downgrade_single_step';
  19
  20 1;
  21
  22 # vim: ts=2 sw=2 expandtab
  23
  24 __END__
  25
  26 =method prepare_deploy
  27
  28  $dh->prepare_deploy
  29
  30 Generate the needed data files to install the schema to the database.
  31
  32 =method deploy
  33
  34  $dh->deploy
  35
  36 Deploy the schema to the database.
  37
  38 =method prepare_resultsource_install
  39
  40  $dh->prepare_resultsource_install($resultset->result_source)
  41
  42 Takes a L<DBIx::Class::ResultSource> and generates a single migration file to
  43 create the resultsource's table.
  44
  45 =method install_resultsource
  46
  47  $dh->prepare_resultsource_install($resultset->result_source);
  48
  49 Takes a L<DBIx::Class::ResultSource> and runs a single migration file to
  50 deploy the resultsource's table.
  51
  52 =method prepare_upgrade
  53
  54  $dh->prepare_upgrade(1, 2, [1, 2]);
  55
  56 Takes two versions and a version set.  This basically is supposed to generate
  57 the needed C<SQL> to migrate up from the first version to the second version.
  58 The version set uniquely identifies the migration.
  59
  60 =method prepare_downgrade
  61
  62  $dh->prepare_downgrade(2, 1, [1, 2]);
  63
  64 Takes two versions and a version set.  This basically is supposed to generate
  65 the needed C<SQL> to migrate down from the first version to the second version.
  66 The version set uniquely identifies the migration and should match it's
  67 respective upgrade version set.
  68
  69 =method upgrade_single_step
  70
  71  my ($ddl, $sql) = @{$dh->upgrade_single_step($version_set)||[]}
  72
  73 Call a single upgrade migration.  Takes a version set as an argument.
  74 Optionally return C<< [ $ddl, $upgrade_sql ] >> where C<$ddl> is the DDL for
  75 that version of the schema and C<$upgrade_sql> is the SQL that was run to
  76 upgrade the database.
  77
  78 =method downgrade_single_step
  79
  80  $dh->downgrade_single_step($version_set);
  81
  82 Call a single downgrade migration.  Takes a version set as an argument.
  83 Optionally return C<< [ $ddl, $upgrade_sql ] >> where C<$ddl> is the DDL for
  84 that version of the schema and C<$upgrade_sql> is the SQL that was run to
  85 upgrade the database.
  86
  87 =head1 KNOWN IMPLEMENTATIONS
  88
  89 =over
  90
  91 =item *
  92
  93 L<DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator>
  94
  95 =item *
  96
  97 L<DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator::Deprecated>
  98
  99 =back
 100