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::WithSqltDeployMethod',
11 'DBIx::Class::DeploymentHandler::WithMonotonicVersions',
12 'DBIx::Class::DeploymentHandler::WithStandardVersionStorage';
13 with 'DBIx::Class::DeploymentHandler::WithReasonableDefaults';
15 sub prepare_version_storage_install {
18 $self->prepare_resultsource_install(
19 $self->version_storage->version_rs->result_source
23 sub install_version_storage {
26 $self->install_resultsource(
27 $self->version_storage->version_rs->result_source
32 $_[0]->prepare_deploy;
33 $_[0]->prepare_version_storage_install;
36 __PACKAGE__->meta->make_immutable;
40 #vim: ts=2 sw=2 expandtab
46 use aliased 'DBIx::Class::DeploymentHandler' => 'DH';
47 my $s = My::Schema->connect(...);
51 databases => 'SQLite',
52 sql_translator_args => { add_drop_table => 0 },
61 use aliased 'DBIx::Class::DeploymentHandler' => 'DH';
62 my $s = My::Schema->connect(...);
66 databases => 'SQLite',
67 sql_translator_args => { add_drop_table => 0 },
70 $dh->prepare_upgrade(1, 2);
76 C<DBIx::Class::DeploymentHandler> is, as it's name suggests, a tool for
77 deploying and upgrading databases with L<DBIx::Class>. It is designed to be
78 much more flexible than L<DBIx::Class::Schema::Versioned>, hence the use of
79 L<Moose> and lots of roles.
81 C<DBIx::Class::DeploymentHandler> itself is just a recommended set of roles
82 that we think will not only work well for everyone, but will also yeild the
83 best overall mileage. Each role it uses has it's own nuances and
84 documentation, so I won't describe all of them here, but here are a few of the
85 major benefits over how L<DBIx::Class::Schema::Versioned> worked (and
86 L<DBIx::Class::DeploymentHandler::Deprecated> tries to maintain compatibility
93 Downgrades in addition to upgrades.
97 Multiple sql files files per upgrade/downgrade/install.
101 Perl scripts allowed for upgrade/downgrade/install.
105 Just one set of files needed for upgrade, unlike before where one might need
106 to generate C<factorial(scalar @versions)>, which is just silly.
114 That's really just a taste of some of the differences. Check out each role for
117 =head1 WHERE IS ALL THE DOC?!
119 C<DBIx::Class::DeploymentHandler> extends
120 L<DBIx::Class::DeploymentHandler::Dad>, so that's probably the first place to
121 look when you are trying to figure out how everything works.
123 Next would be to look at all the roles that fill in the blanks that
124 L<DBIx::Class::DeploymentHandler::Dad> expects to be filled. They would be
125 L<DBIx::Class::DeploymentHandler::WithSqltDeployMethod>,
126 L<DBIx::Class::DeploymentHandler::WithMonotonicVersions>,
127 L<DBIx::Class::DeploymentHandler::WithStandardVersionStorage>, and
128 L<DBIx::Class::DeploymentHandler::WithReasonableDefaults>.
130 =method prepare_version_storage_install
132 $dh->prepare_version_storage_install
134 Creates the needed C<.sql> file to install the version storage and not the rest
137 =method prepare_install
141 First prepare all the tables to be installed and the prepare just the version
144 =method install_version_storage
146 $dh->install_version_storage
148 Install the version storage and not the rest of the tables
152 You started your project and weren't using C<DBIx::Class::DeploymentHandler>?
153 Lucky for you I had you in mind when I wrote this doc.
155 First off, you'll want to just install the C<version_storage>:
157 my $s = My::Schema->connect(...);
158 my $dh = DBIx::Class::DeploymentHandler({ schema => $s });
160 $dh->prepare_version_storage_install;
161 $dh->install_version_storage;
163 Then set your database version:
165 $dh->add_database_version({ version => $s->version });
167 Now you should be able to use C<DBIx::Class::DeploymentHandler> like normal!
171 If you'd like to thank me for the work I've done on this module, don't give me
172 a donation. I spend a lot of free time creating free software, but I do it
175 Instead, consider donating to someone who might actually need it. Obviously
176 you should do research when donating to a charity, so don't just take my word
177 on this. I like Children's Survival Fund:
178 L<http://www.childrenssurvivalfund.org>, but there are a host of other
179 charities that can do much more good than I will with your money.