1 package # Hide from PAUSE
2 DBIx::Class::Version::Table;
3 use base 'DBIx::Class::Core';
7 __PACKAGE__->table('dbix_class_schema_versions');
9 __PACKAGE__->add_columns
11 'data_type' => 'VARCHAR',
12 'is_auto_increment' => 0,
13 'default_value' => undef,
14 'is_foreign_key' => 0,
20 'data_type' => 'VARCHAR',
21 'is_auto_increment' => 0,
22 'default_value' => undef,
23 'is_foreign_key' => 0,
24 'name' => 'installed',
29 __PACKAGE__->set_primary_key('version');
31 package # Hide from PAUSE
32 DBIx::Class::Version::TableCompat;
33 use base 'DBIx::Class::Core';
34 __PACKAGE__->table('SchemaVersions');
36 __PACKAGE__->add_columns
38 'data_type' => 'VARCHAR',
41 'data_type' => 'VARCHAR',
44 __PACKAGE__->set_primary_key('Version');
46 package # Hide from PAUSE
48 use base 'DBIx::Class::Schema';
52 __PACKAGE__->register_class('Table', 'DBIx::Class::Version::Table');
54 package # Hide from PAUSE
55 DBIx::Class::VersionCompat;
56 use base 'DBIx::Class::Schema';
60 __PACKAGE__->register_class('TableCompat', 'DBIx::Class::Version::TableCompat');
63 # ---------------------------------------------------------------------------
67 DBIx::Class::Schema::Versioned - DBIx::Class::Schema plugin for Schema upgrades
71 package MyApp::Schema;
72 use base qw/DBIx::Class::Schema/;
76 # load MyApp::Schema::CD, MyApp::Schema::Book, MyApp::Schema::DVD
77 __PACKAGE__->load_classes(qw/CD Book DVD/);
79 __PACKAGE__->load_components(qw/Schema::Versioned/);
80 __PACKAGE__->upgrade_directory('/path/to/upgrades/');
85 This module provides methods to apply DDL changes to your database using SQL
86 diff files. Normally these diff files would be created using
87 L<DBIx::Class::Schema/create_ddl_dir>.
89 A table called I<dbix_class_schema_versions> is created and maintained by the
90 module. This is used to determine which version your database is currently at.
91 Similarly the $VERSION in your DBIC schema class is used to determine the
92 current DBIC schema version.
94 The upgrade is initiated manually by calling C<upgrade> on your schema object,
95 this will attempt to upgrade the database from its current version to the current
96 schema version using a diff from your I<upgrade_directory>. If a suitable diff is
97 not found then no upgrade is possible.
99 NB: At the moment, only SQLite and MySQL are supported. This is due to
100 spotty behaviour in the SQL::Translator producers, please help us by
101 enhancing them. Ask on the mailing list or IRC channel for details (community details
104 =head1 GETTING STARTED
106 Firstly you need to setup your schema class as per the L</SYNOPSIS>, make sure
107 you have specified an upgrade_directory and an initial $VERSION.
109 Then you'll need two scripts, one to create DDL files and diffs and another to perform
110 upgrades. Your creation script might look like a bit like this:
117 my ( $preversion, $help );
119 'p|preversion:s' => \$preversion,
122 my $schema = MyApp::Schema->connect(
127 my $sql_dir = './sql';
128 my $version = $schema->schema_version();
129 $schema->create_ddl_dir( 'MySQL', $version, $sql_dir, $preversion );
131 Then your upgrade script might look like so:
136 my $schema = MyApp::Schema->connect(
142 if (!$schema->get_db_version()) {
143 # schema is unversioned
149 The script above assumes that if the database is unversioned then it is empty
150 and we can safely deploy the DDL to it. However things are not always so simple.
152 if you want to initialise a pre-existing database where the DDL is not the same
153 as the DDL for your current schema version then you will need a diff which
154 converts the database's DDL to the current DDL. The best way to do this is
155 to get a dump of the database schema (without data) and save that in your
156 SQL directory as version 0.000 (the filename must be as with
157 L<DBIx::Class::Schema/ddl_filename>) then create a diff using your create DDL
158 script given above from version 0.000 to the current version. Then hand check
159 and if necessary edit the resulting diff to ensure that it will apply. Once you have
160 done all that you can do this:
162 if (!$schema->get_db_version()) {
163 # schema is unversioned
164 $schema->install("0.000");
167 # this will now apply the 0.000 to current version diff
170 In the case of an unversioned database the above code will create the
171 dbix_class_schema_versions table and write version 0.000 to it, then
172 upgrade will then apply the diff we talked about creating in the previous paragraph
173 and then you're good to go.
177 package DBIx::Class::Schema::Versioned;
181 use base 'DBIx::Class::Schema';
183 use Carp::Clan qw/^DBIx::Class/;
184 use POSIX 'strftime';
186 __PACKAGE__->mk_classdata('_filedata');
187 __PACKAGE__->mk_classdata('upgrade_directory');
188 __PACKAGE__->mk_classdata('backup_directory');
189 __PACKAGE__->mk_classdata('do_backup');
190 __PACKAGE__->mk_classdata('do_diff_on_init');
195 =head2 upgrade_directory
197 Use this to set the directory your upgrade files are stored in.
199 =head2 backup_directory
201 Use this to set the directory you want your backups stored in (note that backups
202 are disabled by default).
210 =item Arguments: $db_version
214 Call this to initialise a previously unversioned database. The table 'dbix_class_schema_versions' will be created which will be used to store the database version.
216 Takes one argument which should be the version that the database is currently at. Defaults to the return value of L</schema_version>.
218 See L</getting_started> for more details.
224 my ($self, $new_version) = @_;
226 # must be called on a fresh database
227 if ($self->get_db_version()) {
228 carp 'Install not possible as versions table already exists in database';
231 # default to current version if none passed
232 $new_version ||= $self->schema_version();
235 # create versions table and version row
236 $self->{vschema}->deploy;
237 $self->_set_db_version({ version => $new_version });
243 Same as L<DBIx::Class::Schema/deploy> but also calls C<install>.
249 $self->next::method(@_);
253 =head2 create_upgrade_path
257 =item Arguments: { upgrade_file => $file }
261 Virtual method that should be overriden to create an upgrade file.
262 This is useful in the case of upgrading across multiple versions
263 to concatenate several files to create one upgrade file.
265 You'll probably want the db_version retrieved via $self->get_db_version
266 and the schema_version which is retrieved via $self->schema_version
270 sub create_upgrade_path {
271 ## override this method
276 Call this to attempt to upgrade your database from the version it is at to the version
277 this DBIC schema is at. If they are the same it does nothing.
279 It requires an SQL diff file to exist in you I<upgrade_directory>, normally you will
280 have created this using L<DBIx::Class::Schema/create_ddl_dir>.
282 If successful the dbix_class_schema_versions table is updated with the current
290 my $db_version = $self->get_db_version();
293 unless ($db_version) {
294 carp 'Upgrade not possible as database is unversioned. Please call install first.';
298 # db and schema at same version. do nothing
299 if ($db_version eq $self->schema_version) {
300 carp "Upgrade not necessary\n";
304 # strangely the first time this is called can
305 # differ to subsequent times. so we call it
308 $self->storage->sqlt_type;
310 my $upgrade_file = $self->ddl_filename(
311 $self->storage->sqlt_type,
312 $self->schema_version,
313 $self->upgrade_directory,
317 $self->create_upgrade_path({ upgrade_file => $upgrade_file });
319 unless (-f $upgrade_file) {
320 carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
324 carp "\nDB version ($db_version) is lower than the schema version (".$self->schema_version."). Attempting upgrade.\n";
326 # backup if necessary then apply upgrade
327 $self->_filedata($self->_read_sql_file($upgrade_file));
328 $self->backup() if($self->do_backup);
329 $self->txn_do(sub { $self->do_upgrade() });
331 # set row in dbix_class_schema_versions table
332 $self->_set_db_version;
337 This is an overwritable method used to run your upgrade. The freeform method
338 allows you to run your upgrade any way you please, you can call C<run_upgrade>
339 any number of times to run the actual SQL commands, and in between you can
340 sandwich your data upgrading. For example, first run all the B<CREATE>
341 commands, then migrate your data from old to new tables/formats, then
342 issue the DROP commands when you are finished. Will run the whole file as it is by default.
350 # just run all the commands (including inserts) in order
351 $self->run_upgrade(qr/.*?/);
356 $self->run_upgrade(qr/create/i);
358 Runs a set of SQL statements matching a passed in regular expression. The
359 idea is that this method can be called any number of times from your
360 C<do_upgrade> method, running whichever commands you specify via the
361 regex in the parameter. Probably won't work unless called from the overridable
368 my ($self, $stm) = @_;
370 return unless ($self->_filedata);
371 my @statements = grep { $_ =~ $stm } @{$self->_filedata};
372 $self->_filedata([ grep { $_ !~ /$stm/i } @{$self->_filedata} ]);
376 $self->storage->debugobj->query_start($_) if $self->storage->debug;
377 $self->apply_statement($_);
378 $self->storage->debugobj->query_end($_) if $self->storage->debug;
384 =head2 apply_statement
386 Takes an SQL statement and runs it. Override this if you want to handle errors
391 sub apply_statement {
392 my ($self, $statement) = @_;
394 $self->storage->dbh->do($_) or carp "SQL was:\n $_";
397 =head2 get_db_version
399 Returns the version that your database is currently at. This is determined by the values in the
400 dbix_class_schema_versions table that C<upgrade> and C<install> write to.
406 my ($self, $rs) = @_;
408 my $vtable = $self->{vschema}->resultset('Table');
411 my $stamp = $vtable->get_column('installed')->max;
412 $version = $vtable->search({ installed => $stamp })->first->version;
417 =head2 schema_version
419 Returns the current schema class' $VERSION
425 This is an overwritable method which is called just before the upgrade, to
426 allow you to make a backup of the database. Per default this method attempts
427 to call C<< $self->storage->backup >>, to run the standard backup on each
430 This method should return the name of the backup file, if appropriate..
432 This method is disabled by default. Set $schema->do_backup(1) to enable it.
439 ## Make each ::DBI::Foo do this
440 $self->storage->backup($self->backup_directory());
445 Overloaded method. This checks the DBIC schema version against the DB version and
446 warns if they are not the same or if the DB is unversioned. It also provides
447 compatibility between the old versions table (SchemaVersions) and the new one
448 (dbix_class_schema_versions).
450 To avoid the checks on connect, set the env var DBIC_NO_VERSION_CHECK or alternatively you can set the ignore_version attr in the forth argument like so:
452 my $schema = MyApp::Schema->connect(
456 { ignore_version => 1 },
463 $self->next::method(@_);
464 $self->_on_connect($_[3]);
470 my ($self, $args) = @_;
472 $args = {} unless $args;
474 $self->{vschema} = DBIx::Class::Version->connect(@{$self->storage->connect_info()});
475 my $vtable = $self->{vschema}->resultset('Table');
477 # useful when connecting from scripts etc
478 return if ($args->{ignore_version} || ($ENV{DBIC_NO_VERSION_CHECK} && !exists $args->{ignore_version}));
480 # check for legacy versions table and move to new if exists
481 my $vschema_compat = DBIx::Class::VersionCompat->connect(@{$self->storage->connect_info()});
482 unless ($self->_source_exists($vtable)) {
483 my $vtable_compat = $vschema_compat->resultset('TableCompat');
484 if ($self->_source_exists($vtable_compat)) {
485 $self->{vschema}->deploy;
486 map { $vtable->create({ installed => $_->Installed, version => $_->Version }) } $vtable_compat->all;
487 $self->storage->dbh->do("DROP TABLE " . $vtable_compat->result_source->from);
491 my $pversion = $self->get_db_version();
493 if($pversion eq $self->schema_version)
495 # carp "This version is already installed\n";
501 carp "Your DB is currently unversioned. Please call upgrade on your schema to sync the DB.\n";
505 carp "Versions out of sync. This is " . $self->schema_version .
506 ", your database contains version $pversion, please call upgrade on your Schema.\n";
509 # is this just a waste of time? if not then merge with DBI.pm
510 sub _create_db_to_schema_diff {
513 my %driver_to_db_map = (
517 my $db = $driver_to_db_map{$self->storage->dbh->{Driver}->{Name}};
519 print "Sorry, this is an unsupported DB\n";
523 $self->throw_exception($self->storage->_sqlt_version_error)
524 if (not $self->storage->_sqlt_version_ok);
526 my $db_tr = SQL::Translator->new({
529 parser_args => { dbh => $self->storage->dbh }
532 $db_tr->producer($db);
533 my $dbic_tr = SQL::Translator->new;
534 $dbic_tr->parser('SQL::Translator::Parser::DBIx::Class');
535 $dbic_tr->data($self);
536 $dbic_tr->producer($db);
538 $db_tr->schema->name('db_schema');
539 $dbic_tr->schema->name('dbic_schema');
541 # is this really necessary?
542 foreach my $tr ($db_tr, $dbic_tr) {
543 my $data = $tr->data;
544 $tr->parser->($tr, $$data);
547 my $diff = SQL::Translator::Diff::schema_diff($db_tr->schema, $db,
548 $dbic_tr->schema, $db,
549 { ignore_constraint_names => 1, ignore_index_names => 1, caseopt => 1 });
551 my $filename = $self->ddl_filename(
553 $self->schema_version,
554 $self->upgrade_directory,
558 if(!open($file, ">$filename"))
560 $self->throw_exception("Can't open $filename for writing ($!)");
566 carp "WARNING: There may be differences between your DB and your DBIC schema. Please review and if necessary run the SQL in $filename to sync your DB.\n";
570 sub _set_db_version {
575 my $version = $params->{version} ? $params->{version} : $self->schema_version;
576 my $vtable = $self->{vschema}->resultset('Table');
577 $vtable->create({ version => $version,
578 installed => strftime("%Y-%m-%d %H:%M:%S", gmtime())
585 my $file = shift || return;
588 open $fh, "<$file" or carp("Can't open upgrade file, $file ($!)");
589 my @data = split(/\n/, join('', <$fh>));
590 @data = grep(!/^--/, @data);
591 @data = split(/;/, join('', @data));
593 @data = grep { $_ && $_ !~ /^-- / } @data;
594 @data = grep { $_ !~ /^(BEGIN|BEGIN TRANSACTION|COMMIT)/m } @data;
600 my ($self, $rs) = @_;
603 $rs->search({ 1, 0 })->count;
605 return 0 if $@ || !defined $c;
615 Jess Robinson <castaway@desert-island.me.uk>
616 Luke Saunders <luke@shadowcatsystems.co.uk>
620 You may distribute this code under the same terms as Perl itself.