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 Time::HiRes qw/gettimeofday/;
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 overridden 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
274 =head2 ordered_schema_versions
278 =item Returns: a list of version numbers, ordered from lowest to highest
282 Virtual method that should be overridden to return an ordered list
283 of schema versions. This is then used to produce a set of steps to
284 upgrade through to achieve the required schema version.
286 You may want the db_version retrieved via $self->get_db_version
287 and the schema_version which is retrieved via $self->schema_version
291 sub ordered_schema_versions {
292 ## override this method
297 Call this to attempt to upgrade your database from the version it
298 is at to the version this DBIC schema is at. If they are the same
301 It will call L</ordered_schema_versions> to retrieve an ordered
302 list of schema versions (if ordered_schema_versions returns nothing
303 then it is assumed you can do the upgrade as a single step). It
304 then iterates through the list of versions between the current db
305 version and the schema version applying one update at a time until
306 all relevant updates are applied.
308 The individual update steps are performed by using
309 L</upgrade_single_step>, which will apply the update and also
310 update the dbix_class_schema_versions table.
316 my $db_version = $self->get_db_version();
319 unless ($db_version) {
320 carp 'Upgrade not possible as database is unversioned. Please call install first.';
324 # db and schema at same version. do nothing
325 if ( $db_version eq $self->schema_version ) {
326 carp "Upgrade not necessary\n";
330 my @version_list = $self->ordered_schema_versions;
332 # if nothing returned then we preload with min/max
333 @version_list = ( $db_version, $self->schema_version )
334 unless ( scalar(@version_list) );
336 # catch the case of someone returning an arrayref
337 @version_list = @{ $version_list[0] }
338 if ( ref( $version_list[0] ) eq 'ARRAY' );
340 # remove all versions in list above the required version
341 while ( scalar(@version_list)
342 && ( $version_list[-1] ne $self->schema_version ) )
347 # remove all versions in list below the current version
348 while ( scalar(@version_list) && ( $version_list[0] ne $db_version ) ) {
352 # check we have an appropriate list of versions
353 if ( scalar(@version_list) < 2 ) {
358 while ( scalar(@version_list) >= 2 ) {
359 $self->upgrade_single_step( $version_list[0], $version_list[1] );
364 =head2 upgrade_single_step
368 =item Arguments: db_version - the version currently within the db
370 =item Arguments: target_version - the version to upgrade to
374 Call this to attempt to upgrade your database from the
375 I<db_version> to the I<target_version>. If they are the same it
378 It requires an SQL diff file to exist in your I<upgrade_directory>,
379 normally you will have created this using L<DBIx::Class::Schema/create_ddl_dir>.
381 If successful the dbix_class_schema_versions table is updated with
382 the I<target_version>.
384 This method may be called repeatedly by the upgrade method to
385 upgrade through a series of updates.
389 sub upgrade_single_step
393 $target_version) = @_;
395 # db and schema at same version. do nothing
396 if ($db_version eq $target_version) {
397 carp "Upgrade not necessary\n";
401 # strangely the first time this is called can
402 # differ to subsequent times. so we call it
405 $self->storage->sqlt_type;
407 my $upgrade_file = $self->ddl_filename(
408 $self->storage->sqlt_type,
410 $self->upgrade_directory,
414 $self->create_upgrade_path({ upgrade_file => $upgrade_file });
416 unless (-f $upgrade_file) {
417 carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
421 carp "DB version ($db_version) is lower than the schema version (".$self->schema_version."). Attempting upgrade.\n";
423 # backup if necessary then apply upgrade
424 $self->_filedata($self->_read_sql_file($upgrade_file));
425 $self->backup() if($self->do_backup);
426 $self->txn_do(sub { $self->do_upgrade() });
428 # set row in dbix_class_schema_versions table
429 $self->_set_db_version({version => $target_version});
434 This is an overwritable method used to run your upgrade. The freeform method
435 allows you to run your upgrade any way you please, you can call C<run_upgrade>
436 any number of times to run the actual SQL commands, and in between you can
437 sandwich your data upgrading. For example, first run all the B<CREATE>
438 commands, then migrate your data from old to new tables/formats, then
439 issue the DROP commands when you are finished. Will run the whole file as it is by default.
447 # just run all the commands (including inserts) in order
448 $self->run_upgrade(qr/.*?/);
453 $self->run_upgrade(qr/create/i);
455 Runs a set of SQL statements matching a passed in regular expression. The
456 idea is that this method can be called any number of times from your
457 C<do_upgrade> method, running whichever commands you specify via the
458 regex in the parameter. Probably won't work unless called from the overridable
465 my ($self, $stm) = @_;
467 return unless ($self->_filedata);
468 my @statements = grep { $_ =~ $stm } @{$self->_filedata};
469 $self->_filedata([ grep { $_ !~ /$stm/i } @{$self->_filedata} ]);
473 $self->storage->debugobj->query_start($_) if $self->storage->debug;
474 $self->apply_statement($_);
475 $self->storage->debugobj->query_end($_) if $self->storage->debug;
481 =head2 apply_statement
483 Takes an SQL statement and runs it. Override this if you want to handle errors
488 sub apply_statement {
489 my ($self, $statement) = @_;
491 $self->storage->dbh->do($_) or carp "SQL was: $_";
494 =head2 get_db_version
496 Returns the version that your database is currently at. This is determined by the values in the
497 dbix_class_schema_versions table that C<upgrade> and C<install> write to.
503 my ($self, $rs) = @_;
505 my $vtable = $self->{vschema}->resultset('Table');
507 $vtable->search({}, { order_by => { -desc => 'installed' }, rows => 1 } )
508 ->get_column ('version')
511 return $version || 0;
514 =head2 schema_version
516 Returns the current schema class' $VERSION
522 This is an overwritable method which is called just before the upgrade, to
523 allow you to make a backup of the database. Per default this method attempts
524 to call C<< $self->storage->backup >>, to run the standard backup on each
527 This method should return the name of the backup file, if appropriate..
529 This method is disabled by default. Set $schema->do_backup(1) to enable it.
536 ## Make each ::DBI::Foo do this
537 $self->storage->backup($self->backup_directory());
542 Overloaded method. This checks the DBIC schema version against the DB version and
543 warns if they are not the same or if the DB is unversioned. It also provides
544 compatibility between the old versions table (SchemaVersions) and the new one
545 (dbix_class_schema_versions).
547 To avoid the checks on connect, set the environment var DBIC_NO_VERSION_CHECK or alternatively you can set the ignore_version attr in the forth argument like so:
549 my $schema = MyApp::Schema->connect(
553 { ignore_version => 1 },
560 $self->next::method(@_);
561 $self->_on_connect($_[3]);
567 my ($self, $args) = @_;
569 $args = {} unless $args;
571 $self->{vschema} = DBIx::Class::Version->connect(@{$self->storage->connect_info()});
572 my $vtable = $self->{vschema}->resultset('Table');
574 # useful when connecting from scripts etc
575 return if ($args->{ignore_version} || ($ENV{DBIC_NO_VERSION_CHECK} && !exists $args->{ignore_version}));
577 # check for legacy versions table and move to new if exists
578 my $vschema_compat = DBIx::Class::VersionCompat->connect(@{$self->storage->connect_info()});
579 unless ($self->_source_exists($vtable)) {
580 my $vtable_compat = $vschema_compat->resultset('TableCompat');
581 if ($self->_source_exists($vtable_compat)) {
582 $self->{vschema}->deploy;
583 map { $vtable->create({ installed => $_->Installed, version => $_->Version }) } $vtable_compat->all;
584 $self->storage->dbh->do("DROP TABLE " . $vtable_compat->result_source->from);
588 my $pversion = $self->get_db_version();
590 if($pversion eq $self->schema_version)
592 # carp "This version is already installed\n";
598 carp "Your DB is currently unversioned. Please call upgrade on your schema to sync the DB.\n";
602 carp "Versions out of sync. This is " . $self->schema_version .
603 ", your database contains version $pversion, please call upgrade on your Schema.\n";
606 # is this just a waste of time? if not then merge with DBI.pm
607 sub _create_db_to_schema_diff {
610 my %driver_to_db_map = (
614 my $db = $driver_to_db_map{$self->storage->dbh->{Driver}->{Name}};
616 print "Sorry, this is an unsupported DB\n";
620 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
621 $self->throw_exception("Unable to proceed without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
624 my $db_tr = SQL::Translator->new({
627 parser_args => { dbh => $self->storage->dbh }
630 $db_tr->producer($db);
631 my $dbic_tr = SQL::Translator->new;
632 $dbic_tr->parser('SQL::Translator::Parser::DBIx::Class');
633 $dbic_tr->data($self);
634 $dbic_tr->producer($db);
636 $db_tr->schema->name('db_schema');
637 $dbic_tr->schema->name('dbic_schema');
639 # is this really necessary?
640 foreach my $tr ($db_tr, $dbic_tr) {
641 my $data = $tr->data;
642 $tr->parser->($tr, $$data);
645 my $diff = SQL::Translator::Diff::schema_diff($db_tr->schema, $db,
646 $dbic_tr->schema, $db,
647 { ignore_constraint_names => 1, ignore_index_names => 1, caseopt => 1 });
649 my $filename = $self->ddl_filename(
651 $self->schema_version,
652 $self->upgrade_directory,
656 if(!open($file, ">$filename"))
658 $self->throw_exception("Can't open $filename for writing ($!)");
664 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";
668 sub _set_db_version {
673 my $version = $params->{version} ? $params->{version} : $self->schema_version;
674 my $vtable = $self->{vschema}->resultset('Table');
676 ##############################################################################
678 ##############################################################################
680 # The travesty below replaces the old nice timestamp format of %Y-%m-%d %H:%M:%S
681 # This is necessary since there are legitimate cases when upgrades can happen
682 # back to back within the same second. This breaks things since we relay on the
683 # ability to sort by the 'installed' value. The logical choice of an autoinc
684 # is not possible, as it will break multiple legacy installations. Also it is
685 # not possible to format the string sanely, as the column is a varchar(20).
686 # The 'v' character is added to the front of the string, so that any version
687 # formatted by this new function will sort _after_ any existing 200... strings.
688 my @tm = gettimeofday();
689 my @dt = gmtime ($tm[0]);
690 my $o = $vtable->create({
692 installed => sprintf("v%04d%02d%02d_%02d%02d%02d.%03.0f",
699 $tm[1] / 1000, # convert to millisecs, format as up/down rounded int above
706 my $file = shift || return;
708 open my $fh, '<', $file or carp("Can't open upgrade file, $file ($!)");
709 my @data = split /\n/, join '', <$fh>;
715 !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/m
724 my ($self, $rs) = @_;
727 $rs->search({ 1, 0 })->count;
729 return 0 if $@ || !defined $c;
739 Jess Robinson <castaway@desert-island.me.uk>
740 Luke Saunders <luke@shadowcatsystems.co.uk>
744 You may distribute this code under the same terms as Perl itself.