1 package DBIx::Class::DeploymentHandler;
3 # ABSTRACT: Extensible DBIx::Class deployment
7 extends 'DBIx::Class::DeploymentHandler::Dad';
8 # a single with would be better, but we can't do that
9 # see: http://rt.cpan.org/Public/Bug/Display.html?id=46347
10 with 'DBIx::Class::DeploymentHandler::WithApplicatorDumple' => {
11 interface_role => 'DBIx::Class::DeploymentHandler::HandlesDeploy',
12 class_name => 'DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator',
13 delegate_name => 'deploy_method',
14 attributes_to_assume => ['schema'],
15 attributes_to_copy => [qw( databases upgrade_directory sql_translator_args )],
17 'DBIx::Class::DeploymentHandler::WithApplicatorDumple' => {
18 interface_role => 'DBIx::Class::DeploymentHandler::HandlesVersioning',
19 class_name => 'DBIx::Class::DeploymentHandler::VersionHandler::Monotonic',
20 delegate_name => 'version_handler',
21 attributes_to_assume => [qw( database_version schema_version to_version )],
23 'DBIx::Class::DeploymentHandler::WithApplicatorDumple' => {
24 interface_role => 'DBIx::Class::DeploymentHandler::HandlesVersionStorage',
25 class_name => 'DBIx::Class::DeploymentHandler::VersionStorage::Standard',
26 delegate_name => 'version_storage',
27 attributes_to_assume => ['schema'],
29 with 'DBIx::Class::DeploymentHandler::WithReasonableDefaults';
31 sub prepare_version_storage_install {
34 $self->prepare_resultsource_install(
35 $self->version_storage->version_rs->result_source
39 sub install_version_storage {
42 $self->install_resultsource(
43 $self->version_storage->version_rs->result_source
48 $_[0]->prepare_deploy;
49 $_[0]->prepare_version_storage_install;
52 __PACKAGE__->meta->make_immutable;
56 #vim: ts=2 sw=2 expandtab
62 use aliased 'DBIx::Class::DeploymentHandler' => 'DH';
63 my $s = My::Schema->connect(...);
67 databases => 'SQLite',
68 sql_translator_args => { add_drop_table => 0 },
77 use aliased 'DBIx::Class::DeploymentHandler' => 'DH';
78 my $s = My::Schema->connect(...);
82 databases => 'SQLite',
83 sql_translator_args => { add_drop_table => 0 },
86 $dh->prepare_upgrade(1, 2);
92 C<DBIx::Class::DeploymentHandler> is, as it's name suggests, a tool for
93 deploying and upgrading databases with L<DBIx::Class>. It is designed to be
94 much more flexible than L<DBIx::Class::Schema::Versioned>, hence the use of
95 L<Moose> and lots of roles.
97 C<DBIx::Class::DeploymentHandler> itself is just a recommended set of roles
98 that we think will not only work well for everyone, but will also yeild the
99 best overall mileage. Each role it uses has it's own nuances and
100 documentation, so I won't describe all of them here, but here are a few of the
101 major benefits over how L<DBIx::Class::Schema::Versioned> worked (and
102 L<DBIx::Class::DeploymentHandler::Deprecated> tries to maintain compatibility
109 Downgrades in addition to upgrades.
113 Multiple sql files files per upgrade/downgrade/install.
117 Perl scripts allowed for upgrade/downgrade/install.
121 Just one set of files needed for upgrade, unlike before where one might need
122 to generate C<factorial(scalar @versions)>, which is just silly.
130 That's really just a taste of some of the differences. Check out each role for
133 =head1 WHERE IS ALL THE DOC?!
135 C<DBIx::Class::DeploymentHandler> extends
136 L<DBIx::Class::DeploymentHandler::Dad>, so that's probably the first place to
137 look when you are trying to figure out how everything works.
139 Next would be to look at all the roles that fill in the blanks that
140 L<DBIx::Class::DeploymentHandler::Dad> expects to be filled. They would be
141 L<DBIx::Class::DeploymentHandler::WithSqltDeployMethod>,
142 L<DBIx::Class::DeploymentHandler::WithMonotonicVersions>,
143 L<DBIx::Class::DeploymentHandler::WithStandardVersionStorage>, and
144 L<DBIx::Class::DeploymentHandler::WithReasonableDefaults>.
146 =method prepare_version_storage_install
148 $dh->prepare_version_storage_install
150 Creates the needed C<.sql> file to install the version storage and not the rest
153 =method prepare_install
157 First prepare all the tables to be installed and the prepare just the version
160 =method install_version_storage
162 $dh->install_version_storage
164 Install the version storage and not the rest of the tables
168 You started your project and weren't using C<DBIx::Class::DeploymentHandler>?
169 Lucky for you I had you in mind when I wrote this doc.
171 First off, you'll want to just install the C<version_storage>:
173 my $s = My::Schema->connect(...);
174 my $dh = DBIx::Class::DeploymentHandler({ schema => $s });
176 $dh->prepare_version_storage_install;
177 $dh->install_version_storage;
179 Then set your database version:
181 $dh->add_database_version({ version => $s->version });
183 Now you should be able to use C<DBIx::Class::DeploymentHandler> like normal!
187 If you'd like to thank me for the work I've done on this module, don't give me
188 a donation. I spend a lot of free time creating free software, but I do it
191 Instead, consider donating to someone who might actually need it. Obviously
192 you should do research when donating to a charity, so don't just take my word
193 on this. I like Children's Survival Fund:
194 L<http://www.childrenssurvivalfund.org>, but there are a host of other
195 charities that can do much more good than I will with your money.