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.
101 L<DBIx::Class::DeploymentHandler> is a much more powerful alternative to this
102 module. Examples of things it can do that this module cannot do include
108 Downgrades in addition to upgrades
112 Multiple sql files per upgrade/downgrade/install
116 Perl scripts allowed for upgrade/downgrade/install
120 Just one set of files needed for upgrade, unlike this module where one might
121 need to generate C<factorial(scalar @versions)>
125 =head1 GETTING STARTED
127 Firstly you need to setup your schema class as per the L</SYNOPSIS>, make sure
128 you have specified an upgrade_directory and an initial $VERSION.
130 Then you'll need two scripts, one to create DDL files and diffs and another to perform
131 upgrades. Your creation script might look like a bit like this:
138 my ( $preversion, $help );
140 'p|preversion:s' => \$preversion,
143 my $schema = MyApp::Schema->connect(
148 my $sql_dir = './sql';
149 my $version = $schema->schema_version();
150 $schema->create_ddl_dir( 'MySQL', $version, $sql_dir, $preversion );
152 Then your upgrade script might look like so:
157 my $schema = MyApp::Schema->connect(
163 if (!$schema->get_db_version()) {
164 # schema is unversioned
170 The script above assumes that if the database is unversioned then it is empty
171 and we can safely deploy the DDL to it. However things are not always so simple.
173 if you want to initialise a pre-existing database where the DDL is not the same
174 as the DDL for your current schema version then you will need a diff which
175 converts the database's DDL to the current DDL. The best way to do this is
176 to get a dump of the database schema (without data) and save that in your
177 SQL directory as version 0.000 (the filename must be as with
178 L<DBIx::Class::Schema/ddl_filename>) then create a diff using your create DDL
179 script given above from version 0.000 to the current version. Then hand check
180 and if necessary edit the resulting diff to ensure that it will apply. Once you have
181 done all that you can do this:
183 if (!$schema->get_db_version()) {
184 # schema is unversioned
185 $schema->install("0.000");
188 # this will now apply the 0.000 to current version diff
191 In the case of an unversioned database the above code will create the
192 dbix_class_schema_versions table and write version 0.000 to it, then
193 upgrade will then apply the diff we talked about creating in the previous paragraph
194 and then you're good to go.
198 package DBIx::Class::Schema::Versioned;
202 use base 'DBIx::Class::Schema';
204 use DBIx::Class::Carp;
205 use Time::HiRes qw/gettimeofday/;
207 use Scalar::Util 'weaken';
208 use namespace::clean;
210 __PACKAGE__->mk_classdata('_filedata');
211 __PACKAGE__->mk_classdata('upgrade_directory');
212 __PACKAGE__->mk_classdata('backup_directory');
213 __PACKAGE__->mk_classdata('do_backup');
214 __PACKAGE__->mk_classdata('do_diff_on_init');
219 =head2 upgrade_directory
221 Use this to set the directory your upgrade files are stored in.
223 =head2 backup_directory
225 Use this to set the directory you want your backups stored in (note that backups
226 are disabled by default).
234 =item Arguments: $db_version
238 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.
240 Takes one argument which should be the version that the database is currently at. Defaults to the return value of L</schema_version>.
242 See L</GETTING STARTED> for more details.
248 my ($self, $new_version) = @_;
250 # must be called on a fresh database
251 if ($self->get_db_version()) {
252 $self->throw_exception("A versioned schema has already been deployed, try upgrade instead.\n");
255 # default to current version if none passed
256 $new_version ||= $self->schema_version();
259 # create versions table and version row
260 $self->{vschema}->deploy;
261 $self->_set_db_version({ version => $new_version });
267 Same as L<DBIx::Class::Schema/deploy> but also calls C<install>.
273 $self->next::method(@_);
277 =head2 create_upgrade_path
281 =item Arguments: { upgrade_file => $file }
285 Virtual method that should be overridden to create an upgrade file.
286 This is useful in the case of upgrading across multiple versions
287 to concatenate several files to create one upgrade file.
289 You'll probably want the db_version retrieved via $self->get_db_version
290 and the schema_version which is retrieved via $self->schema_version
294 sub create_upgrade_path {
295 ## override this method
298 =head2 ordered_schema_versions
302 =item Return Value: a list of version numbers, ordered from lowest to highest
306 Virtual method that should be overridden to return an ordered list
307 of schema versions. This is then used to produce a set of steps to
308 upgrade through to achieve the required schema version.
310 You may want the db_version retrieved via $self->get_db_version
311 and the schema_version which is retrieved via $self->schema_version
315 sub ordered_schema_versions {
316 ## override this method
321 Call this to attempt to upgrade your database from the version it
322 is at to the version this DBIC schema is at. If they are the same
325 It will call L</ordered_schema_versions> to retrieve an ordered
326 list of schema versions (if ordered_schema_versions returns nothing
327 then it is assumed you can do the upgrade as a single step). It
328 then iterates through the list of versions between the current db
329 version and the schema version applying one update at a time until
330 all relevant updates are applied.
332 The individual update steps are performed by using
333 L</upgrade_single_step>, which will apply the update and also
334 update the dbix_class_schema_versions table.
340 my $db_version = $self->get_db_version();
343 unless ($db_version) {
344 carp 'Upgrade not possible as database is unversioned. Please call install first.';
348 # db and schema at same version. do nothing
349 if ( $db_version eq $self->schema_version ) {
350 carp 'Upgrade not necessary';
354 my @version_list = $self->ordered_schema_versions;
356 # if nothing returned then we preload with min/max
357 @version_list = ( $db_version, $self->schema_version )
358 unless ( scalar(@version_list) );
360 # catch the case of someone returning an arrayref
361 @version_list = @{ $version_list[0] }
362 if ( ref( $version_list[0] ) eq 'ARRAY' );
364 # remove all versions in list above the required version
365 while ( scalar(@version_list)
366 && ( $version_list[-1] ne $self->schema_version ) )
371 # remove all versions in list below the current version
372 while ( scalar(@version_list) && ( $version_list[0] ne $db_version ) ) {
376 # check we have an appropriate list of versions
377 if ( scalar(@version_list) < 2 ) {
382 while ( scalar(@version_list) >= 2 ) {
383 $self->upgrade_single_step( $version_list[0], $version_list[1] );
388 =head2 upgrade_single_step
392 =item Arguments: db_version - the version currently within the db
394 =item Arguments: target_version - the version to upgrade to
398 Call this to attempt to upgrade your database from the
399 I<db_version> to the I<target_version>. If they are the same it
402 It requires an SQL diff file to exist in your I<upgrade_directory>,
403 normally you will have created this using L<DBIx::Class::Schema/create_ddl_dir>.
405 If successful the dbix_class_schema_versions table is updated with
406 the I<target_version>.
408 This method may be called repeatedly by the upgrade method to
409 upgrade through a series of updates.
413 sub upgrade_single_step
417 $target_version) = @_;
419 # db and schema at same version. do nothing
420 if ($db_version eq $target_version) {
421 carp 'Upgrade not necessary';
425 # strangely the first time this is called can
426 # differ to subsequent times. so we call it
429 $self->storage->sqlt_type;
431 my $upgrade_file = $self->ddl_filename(
432 $self->storage->sqlt_type,
434 $self->upgrade_directory,
438 $self->create_upgrade_path({ upgrade_file => $upgrade_file });
440 unless (-f $upgrade_file) {
441 carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one";
445 carp "DB version ($db_version) is lower than the schema version (".$self->schema_version."). Attempting upgrade.\n";
447 # backup if necessary then apply upgrade
448 $self->_filedata($self->_read_sql_file($upgrade_file));
449 $self->backup() if($self->do_backup);
450 $self->txn_do(sub { $self->do_upgrade() });
452 # set row in dbix_class_schema_versions table
453 $self->_set_db_version({version => $target_version});
458 This is an overwritable method used to run your upgrade. The freeform method
459 allows you to run your upgrade any way you please, you can call C<run_upgrade>
460 any number of times to run the actual SQL commands, and in between you can
461 sandwich your data upgrading. For example, first run all the B<CREATE>
462 commands, then migrate your data from old to new tables/formats, then
463 issue the DROP commands when you are finished. Will run the whole file as it is by default.
471 # just run all the commands (including inserts) in order
472 $self->run_upgrade(qr/.*?/);
477 $self->run_upgrade(qr/create/i);
479 Runs a set of SQL statements matching a passed in regular expression. The
480 idea is that this method can be called any number of times from your
481 C<do_upgrade> method, running whichever commands you specify via the
482 regex in the parameter. Probably won't work unless called from the overridable
489 my ($self, $stm) = @_;
491 return unless ($self->_filedata);
492 my @statements = grep { $_ =~ $stm } @{$self->_filedata};
493 $self->_filedata([ grep { $_ !~ /$stm/i } @{$self->_filedata} ]);
497 $self->storage->debugobj->query_start($_) if $self->storage->debug;
498 $self->apply_statement($_);
499 $self->storage->debugobj->query_end($_) if $self->storage->debug;
505 =head2 apply_statement
507 Takes an SQL statement and runs it. Override this if you want to handle errors
512 sub apply_statement {
513 my ($self, $statement) = @_;
515 $self->storage->dbh->do($_) or carp "SQL was: $_";
518 =head2 get_db_version
520 Returns the version that your database is currently at. This is determined by the values in the
521 dbix_class_schema_versions table that C<upgrade> and C<install> write to.
527 my ($self, $rs) = @_;
529 my $vtable = $self->{vschema}->resultset('Table');
531 $vtable->search({}, { order_by => { -desc => 'installed' }, rows => 1 } )
532 ->get_column ('version')
535 return $version || 0;
538 =head2 schema_version
540 Returns the current schema class' $VERSION
546 This is an overwritable method which is called just before the upgrade, to
547 allow you to make a backup of the database. Per default this method attempts
548 to call C<< $self->storage->backup >>, to run the standard backup on each
551 This method should return the name of the backup file, if appropriate..
553 This method is disabled by default. Set $schema->do_backup(1) to enable it.
560 ## Make each ::DBI::Foo do this
561 $self->storage->backup($self->backup_directory());
566 Overloaded method. This checks the DBIC schema version against the DB version and
567 warns if they are not the same or if the DB is unversioned. It also provides
568 compatibility between the old versions table (SchemaVersions) and the new one
569 (dbix_class_schema_versions).
571 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:
573 my $schema = MyApp::Schema->connect(
577 { ignore_version => 1 },
584 $self->next::method(@_);
585 $self->_on_connect();
593 weaken (my $w_self = $self );
595 $self->{vschema} = DBIx::Class::Version->connect(sub { $w_self->storage->dbh });
596 my $conn_attrs = $self->storage->_dbic_connect_attributes || {};
598 my $vtable = $self->{vschema}->resultset('Table');
600 # useful when connecting from scripts etc
601 return if ($conn_attrs->{ignore_version} || ($ENV{DBIC_NO_VERSION_CHECK} && !exists $conn_attrs->{ignore_version}));
603 # check for legacy versions table and move to new if exists
604 unless ($self->_source_exists($vtable)) {
605 my $vtable_compat = DBIx::Class::VersionCompat->connect(sub { $w_self->storage->dbh })->resultset('TableCompat');
606 if ($self->_source_exists($vtable_compat)) {
607 $self->{vschema}->deploy;
608 map { $vtable->new_result({ installed => $_->Installed, version => $_->Version })->insert } $vtable_compat->all;
609 $self->storage->_get_dbh->do("DROP TABLE " . $vtable_compat->result_source->from);
613 my $pversion = $self->get_db_version();
615 if($pversion eq $self->schema_version)
617 #carp "This version is already installed";
623 carp "Your DB is currently unversioned. Please call upgrade on your schema to sync the DB.";
627 carp "Versions out of sync. This is " . $self->schema_version .
628 ", your database contains version $pversion, please call upgrade on your Schema.";
631 # is this just a waste of time? if not then merge with DBI.pm
632 sub _create_db_to_schema_diff {
635 my %driver_to_db_map = (
639 my $db = $driver_to_db_map{$self->storage->dbh->{Driver}->{Name}};
641 print "Sorry, this is an unsupported DB\n";
645 unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
646 $self->throw_exception("Unable to proceed without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
649 my $db_tr = SQL::Translator->new({
652 parser_args => { dbh => $self->storage->dbh }
655 $db_tr->producer($db);
656 my $dbic_tr = SQL::Translator->new;
657 $dbic_tr->parser('SQL::Translator::Parser::DBIx::Class');
658 $dbic_tr->data($self);
659 $dbic_tr->producer($db);
661 $db_tr->schema->name('db_schema');
662 $dbic_tr->schema->name('dbic_schema');
664 # is this really necessary?
665 foreach my $tr ($db_tr, $dbic_tr) {
666 my $data = $tr->data;
667 $tr->parser->($tr, $$data);
670 my $diff = SQL::Translator::Diff::schema_diff($db_tr->schema, $db,
671 $dbic_tr->schema, $db,
672 { ignore_constraint_names => 1, ignore_index_names => 1, caseopt => 1 });
674 my $filename = $self->ddl_filename(
676 $self->schema_version,
677 $self->upgrade_directory,
681 if(!open($file, ">$filename"))
683 $self->throw_exception("Can't open $filename for writing ($!)");
689 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.";
693 sub _set_db_version {
698 my $version = $params->{version} ? $params->{version} : $self->schema_version;
699 my $vtable = $self->{vschema}->resultset('Table');
701 ##############################################################################
703 ##############################################################################
705 # The travesty below replaces the old nice timestamp format of %Y-%m-%d %H:%M:%S
706 # This is necessary since there are legitimate cases when upgrades can happen
707 # back to back within the same second. This breaks things since we relay on the
708 # ability to sort by the 'installed' value. The logical choice of an autoinc
709 # is not possible, as it will break multiple legacy installations. Also it is
710 # not possible to format the string sanely, as the column is a varchar(20).
711 # The 'v' character is added to the front of the string, so that any version
712 # formatted by this new function will sort _after_ any existing 200... strings.
713 my @tm = gettimeofday();
714 my @dt = gmtime ($tm[0]);
715 my $o = $vtable->new_result({
717 installed => sprintf("v%04d%02d%02d_%02d%02d%02d.%03.0f",
724 int($tm[1] / 1000), # convert to millisecs
731 my $file = shift || return;
733 open my $fh, '<', $file or carp("Can't open upgrade file, $file ($!)");
734 my @data = split /\n/, join '', <$fh>;
741 !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/mi }
749 my ($self, $rs) = @_;
752 $rs->search(\'1=0')->cursor->next;
762 =head1 AUTHOR AND CONTRIBUTORS
764 See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
768 You may distribute this code under the same terms as Perl itself.