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 =head1 GETTING STARTED
101 Firstly you need to setup your schema class as per the L</SYNOPSIS>, make sure
102 you have specified an upgrade_directory and an initial $VERSION.
104 Then you'll need two scripts, one to create DDL files and diffs and another to perform
105 upgrades. Your creation script might look like a bit like this:
112 my ( $preversion, $help );
114 'p|preversion:s' => \$preversion,
117 my $schema = MyApp::Schema->connect(
122 my $sql_dir = './sql';
123 my $version = $schema->schema_version();
124 $schema->create_ddl_dir( 'MySQL', $version, $sql_dir, $preversion );
126 Then your upgrade script might look like so:
131 my $schema = MyApp::Schema->connect(
137 if (!$schema->get_db_version()) {
138 # schema is unversioned
144 The script above assumes that if the database is unversioned then it is empty
145 and we can safely deploy the DDL to it. However things are not always so simple.
147 if you want to initialise a pre-existing database where the DDL is not the same
148 as the DDL for your current schema version then you will need a diff which
149 converts the database's DDL to the current DDL. The best way to do this is
150 to get a dump of the database schema (without data) and save that in your
151 SQL directory as version 0.000 (the filename must be as with
152 L<DBIx::Class::Schema/ddl_filename>) then create a diff using your create DDL
153 script given above from version 0.000 to the current version. Then hand check
154 and if necessary edit the resulting diff to ensure that it will apply. Once you have
155 done all that you can do this:
157 if (!$schema->get_db_version()) {
158 # schema is unversioned
159 $schema->install("0.000");
162 # this will now apply the 0.000 to current version diff
165 In the case of an unversioned database the above code will create the
166 dbix_class_schema_versions table and write version 0.000 to it, then
167 upgrade will then apply the diff we talked about creating in the previous paragraph
168 and then you're good to go.
172 package DBIx::Class::Schema::Versioned;
176 use base 'DBIx::Class::Schema';
178 use Carp::Clan qw/^DBIx::Class/;
179 use Time::HiRes qw/gettimeofday/;
181 use namespace::clean;
183 __PACKAGE__->mk_classdata('_filedata');
184 __PACKAGE__->mk_classdata('upgrade_directory');
185 __PACKAGE__->mk_classdata('backup_directory');
186 __PACKAGE__->mk_classdata('do_backup');
187 __PACKAGE__->mk_classdata('do_diff_on_init');
192 =head2 upgrade_directory
194 Use this to set the directory your upgrade files are stored in.
196 =head2 backup_directory
198 Use this to set the directory you want your backups stored in (note that backups
199 are disabled by default).
207 =item Arguments: $db_version
211 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.
213 Takes one argument which should be the version that the database is currently at. Defaults to the return value of L</schema_version>.
215 See L</getting_started> for more details.
221 my ($self, $new_version) = @_;
223 # must be called on a fresh database
224 if ($self->get_db_version()) {
225 $self->throw_exception("A versioned schema has already been deployed, try upgrade instead.\n");
228 # default to current version if none passed
229 $new_version ||= $self->schema_version();
232 # create versions table and version row
233 $self->{vschema}->deploy;
234 $self->_set_db_version({ version => $new_version });
240 Same as L<DBIx::Class::Schema/deploy> but also calls C<install>.
246 $self->next::method(@_);
250 =head2 create_upgrade_path
254 =item Arguments: { upgrade_file => $file }
258 Virtual method that should be overridden to create an upgrade file.
259 This is useful in the case of upgrading across multiple versions
260 to concatenate several files to create one upgrade file.
262 You'll probably want the db_version retrieved via $self->get_db_version
263 and the schema_version which is retrieved via $self->schema_version
267 sub create_upgrade_path {
268 ## override this method
271 =head2 ordered_schema_versions
275 =item Returns: a list of version numbers, ordered from lowest to highest
279 Virtual method that should be overridden to return an ordered list
280 of schema versions. This is then used to produce a set of steps to
281 upgrade through to achieve the required schema version.
283 You may want the db_version retrieved via $self->get_db_version
284 and the schema_version which is retrieved via $self->schema_version
288 sub ordered_schema_versions {
289 ## override this method
294 Call this to attempt to upgrade your database from the version it
295 is at to the version this DBIC schema is at. If they are the same
298 It will call L</ordered_schema_versions> to retrieve an ordered
299 list of schema versions (if ordered_schema_versions returns nothing
300 then it is assumed you can do the upgrade as a single step). It
301 then iterates through the list of versions between the current db
302 version and the schema version applying one update at a time until
303 all relevant updates are applied.
305 The individual update steps are performed by using
306 L</upgrade_single_step>, which will apply the update and also
307 update the dbix_class_schema_versions table.
313 my $db_version = $self->get_db_version();
316 unless ($db_version) {
317 carp 'Upgrade not possible as database is unversioned. Please call install first.';
321 # db and schema at same version. do nothing
322 if ( $db_version eq $self->schema_version ) {
323 carp "Upgrade not necessary\n";
327 my @version_list = $self->ordered_schema_versions;
329 # if nothing returned then we preload with min/max
330 @version_list = ( $db_version, $self->schema_version )
331 unless ( scalar(@version_list) );
333 # catch the case of someone returning an arrayref
334 @version_list = @{ $version_list[0] }
335 if ( ref( $version_list[0] ) eq 'ARRAY' );
337 # remove all versions in list above the required version
338 while ( scalar(@version_list)
339 && ( $version_list[-1] ne $self->schema_version ) )
344 # remove all versions in list below the current version
345 while ( scalar(@version_list) && ( $version_list[0] ne $db_version ) ) {
349 # check we have an appropriate list of versions
350 if ( scalar(@version_list) < 2 ) {
355 while ( scalar(@version_list) >= 2 ) {
356 $self->upgrade_single_step( $version_list[0], $version_list[1] );
361 =head2 upgrade_single_step
365 =item Arguments: db_version - the version currently within the db
367 =item Arguments: target_version - the version to upgrade to
371 Call this to attempt to upgrade your database from the
372 I<db_version> to the I<target_version>. If they are the same it
375 It requires an SQL diff file to exist in your I<upgrade_directory>,
376 normally you will have created this using L<DBIx::Class::Schema/create_ddl_dir>.
378 If successful the dbix_class_schema_versions table is updated with
379 the I<target_version>.
381 This method may be called repeatedly by the upgrade method to
382 upgrade through a series of updates.
386 sub upgrade_single_step
390 $target_version) = @_;
392 # db and schema at same version. do nothing
393 if ($db_version eq $target_version) {
394 carp "Upgrade not necessary\n";
398 # strangely the first time this is called can
399 # differ to subsequent times. so we call it
402 $self->storage->sqlt_type;
404 my $upgrade_file = $self->ddl_filename(
405 $self->storage->sqlt_type,
407 $self->upgrade_directory,
411 $self->create_upgrade_path({ upgrade_file => $upgrade_file });
413 unless (-f $upgrade_file) {
414 carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
418 carp "DB version ($db_version) is lower than the schema version (".$self->schema_version."). Attempting upgrade.\n";
420 # backup if necessary then apply upgrade
421 $self->_filedata($self->_read_sql_file($upgrade_file));
422 $self->backup() if($self->do_backup);
423 $self->txn_do(sub { $self->do_upgrade() });
425 # set row in dbix_class_schema_versions table
426 $self->_set_db_version({version => $target_version});
431 This is an overwritable method used to run your upgrade. The freeform method
432 allows you to run your upgrade any way you please, you can call C<run_upgrade>
433 any number of times to run the actual SQL commands, and in between you can
434 sandwich your data upgrading. For example, first run all the B<CREATE>
435 commands, then migrate your data from old to new tables/formats, then
436 issue the DROP commands when you are finished. Will run the whole file as it is by default.
444 # just run all the commands (including inserts) in order
445 $self->run_upgrade(qr/.*?/);
450 $self->run_upgrade(qr/create/i);
452 Runs a set of SQL statements matching a passed in regular expression. The
453 idea is that this method can be called any number of times from your
454 C<do_upgrade> method, running whichever commands you specify via the
455 regex in the parameter. Probably won't work unless called from the overridable
462 my ($self, $stm) = @_;
464 return unless ($self->_filedata);
465 my @statements = grep { $_ =~ $stm } @{$self->_filedata};
466 $self->_filedata([ grep { $_ !~ /$stm/i } @{$self->_filedata} ]);
470 $self->storage->debugobj->query_start($_) if $self->storage->debug;
471 $self->apply_statement($_);
472 $self->storage->debugobj->query_end($_) if $self->storage->debug;
478 =head2 apply_statement
480 Takes an SQL statement and runs it. Override this if you want to handle errors
485 sub apply_statement {
486 my ($self, $statement) = @_;
488 $self->storage->dbh->do($_) or carp "SQL was: $_";
491 =head2 get_db_version
493 Returns the version that your database is currently at. This is determined by the values in the
494 dbix_class_schema_versions table that C<upgrade> and C<install> write to.
500 my ($self, $rs) = @_;
502 my $vtable = $self->{vschema}->resultset('Table');
504 $vtable->search({}, { order_by => { -desc => 'installed' }, rows => 1 } )
505 ->get_column ('version')
508 return $version || 0;
511 =head2 schema_version
513 Returns the current schema class' $VERSION
519 This is an overwritable method which is called just before the upgrade, to
520 allow you to make a backup of the database. Per default this method attempts
521 to call C<< $self->storage->backup >>, to run the standard backup on each
524 This method should return the name of the backup file, if appropriate..
526 This method is disabled by default. Set $schema->do_backup(1) to enable it.
533 ## Make each ::DBI::Foo do this
534 $self->storage->backup($self->backup_directory());
539 Overloaded method. This checks the DBIC schema version against the DB version and
540 warns if they are not the same or if the DB is unversioned. It also provides
541 compatibility between the old versions table (SchemaVersions) and the new one
542 (dbix_class_schema_versions).
544 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:
546 my $schema = MyApp::Schema->connect(
550 { ignore_version => 1 },
557 $self->next::method(@_);
558 $self->_on_connect();
566 my $conn_info = $self->storage->connect_info;
567 $self->{vschema} = DBIx::Class::Version->connect(@$conn_info);
568 my $conn_attrs = $self->{vschema}->storage->_dbic_connect_attributes || {};
570 my $vtable = $self->{vschema}->resultset('Table');
572 # useful when connecting from scripts etc
573 return if ($conn_attrs->{ignore_version} || ($ENV{DBIC_NO_VERSION_CHECK} && !exists $conn_attrs->{ignore_version}));
575 # check for legacy versions table and move to new if exists
576 unless ($self->_source_exists($vtable)) {
577 my $vtable_compat = DBIx::Class::VersionCompat->connect(@$conn_info)->resultset('TableCompat');
578 if ($self->_source_exists($vtable_compat)) {
579 $self->{vschema}->deploy;
580 map { $vtable->create({ installed => $_->Installed, version => $_->Version }) } $vtable_compat->all;
581 $self->storage->_get_dbh->do("DROP TABLE " . $vtable_compat->result_source->from);
585 my $pversion = $self->get_db_version();
587 if($pversion eq $self->schema_version)
589 # carp "This version is already installed\n";
595 carp "Your DB is currently unversioned. Please call upgrade on your schema to sync the DB.\n";
599 carp "Versions out of sync. This is " . $self->schema_version .
600 ", your database contains version $pversion, please call upgrade on your Schema.\n";
603 # is this just a waste of time? if not then merge with DBI.pm
604 sub _create_db_to_schema_diff {
607 my %driver_to_db_map = (
611 my $db = $driver_to_db_map{$self->storage->dbh->{Driver}->{Name}};
613 print "Sorry, this is an unsupported DB\n";
617 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
618 $self->throw_exception("Unable to proceed without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
621 my $db_tr = SQL::Translator->new({
624 parser_args => { dbh => $self->storage->dbh }
627 $db_tr->producer($db);
628 my $dbic_tr = SQL::Translator->new;
629 $dbic_tr->parser('SQL::Translator::Parser::DBIx::Class');
630 $dbic_tr->data($self);
631 $dbic_tr->producer($db);
633 $db_tr->schema->name('db_schema');
634 $dbic_tr->schema->name('dbic_schema');
636 # is this really necessary?
637 foreach my $tr ($db_tr, $dbic_tr) {
638 my $data = $tr->data;
639 $tr->parser->($tr, $$data);
642 my $diff = SQL::Translator::Diff::schema_diff($db_tr->schema, $db,
643 $dbic_tr->schema, $db,
644 { ignore_constraint_names => 1, ignore_index_names => 1, caseopt => 1 });
646 my $filename = $self->ddl_filename(
648 $self->schema_version,
649 $self->upgrade_directory,
653 if(!open($file, ">$filename"))
655 $self->throw_exception("Can't open $filename for writing ($!)");
661 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";
665 sub _set_db_version {
670 my $version = $params->{version} ? $params->{version} : $self->schema_version;
671 my $vtable = $self->{vschema}->resultset('Table');
673 ##############################################################################
675 ##############################################################################
677 # The travesty below replaces the old nice timestamp format of %Y-%m-%d %H:%M:%S
678 # This is necessary since there are legitimate cases when upgrades can happen
679 # back to back within the same second. This breaks things since we relay on the
680 # ability to sort by the 'installed' value. The logical choice of an autoinc
681 # is not possible, as it will break multiple legacy installations. Also it is
682 # not possible to format the string sanely, as the column is a varchar(20).
683 # The 'v' character is added to the front of the string, so that any version
684 # formatted by this new function will sort _after_ any existing 200... strings.
685 my @tm = gettimeofday();
686 my @dt = gmtime ($tm[0]);
687 my $o = $vtable->create({
689 installed => sprintf("v%04d%02d%02d_%02d%02d%02d.%03.0f",
696 $tm[1] / 1000, # convert to millisecs, format as up/down rounded int above
703 my $file = shift || return;
705 open my $fh, '<', $file or carp("Can't open upgrade file, $file ($!)");
706 my @data = split /\n/, join '', <$fh>;
713 !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/mi }
721 my ($self, $rs) = @_;
724 $rs->search(\'1=0')->cursor->next;
736 Jess Robinson <castaway@desert-island.me.uk>
737 Luke Saunders <luke@shadowcatsystems.co.uk>
741 You may distribute this code under the same terms as Perl itself.