1 package # Hide from PAUSE
2 DBIx::Class::Version::Table;
3 use base 'DBIx::Class';
7 __PACKAGE__->load_components(qw/ Core/);
8 __PACKAGE__->table('dbix_class_schema_versions');
10 __PACKAGE__->add_columns
12 'data_type' => 'VARCHAR',
13 'is_auto_increment' => 0,
14 'default_value' => undef,
15 'is_foreign_key' => 0,
21 'data_type' => 'VARCHAR',
22 'is_auto_increment' => 0,
23 'default_value' => undef,
24 'is_foreign_key' => 0,
25 'name' => 'installed',
30 __PACKAGE__->set_primary_key('version');
32 package # Hide from PAUSE
33 DBIx::Class::Version::TableCompat;
34 use base 'DBIx::Class';
35 __PACKAGE__->load_components(qw/ Core/);
36 __PACKAGE__->table('SchemaVersions');
38 __PACKAGE__->add_columns
40 'data_type' => 'VARCHAR',
43 'data_type' => 'VARCHAR',
46 __PACKAGE__->set_primary_key('Version');
48 package # Hide from PAUSE
50 use base 'DBIx::Class::Schema';
54 __PACKAGE__->register_class('Table', 'DBIx::Class::Version::Table');
56 package # Hide from PAUSE
57 DBIx::Class::VersionCompat;
58 use base 'DBIx::Class::Schema';
62 __PACKAGE__->register_class('TableCompat', 'DBIx::Class::Version::TableCompat');
65 # ---------------------------------------------------------------------------
69 DBIx::Class::Schema::Versioned - DBIx::Class::Schema plugin for Schema upgrades
73 package Library::Schema;
74 use base qw/DBIx::Class::Schema/;
75 # load Library::Schema::CD, Library::Schema::Book, Library::Schema::DVD
76 __PACKAGE__->load_classes(qw/CD Book DVD/);
78 __PACKAGE__->load_components(qw/+DBIx::Class::Schema::Versioned/);
79 __PACKAGE__->upgrade_directory('/path/to/upgrades/');
80 __PACKAGE__->backup_directory('/path/to/backups/');
85 This module is a component designed to extend L<DBIx::Class::Schema>
86 classes, to enable them to upgrade to newer schema layouts. To use this
87 module, you need to have called C<create_ddl_dir> on your Schema to
88 create your upgrade files to include with your delivery.
90 A table called I<dbix_class_schema_versions> is created and maintained by the
91 module. This contains two fields, 'Version' and 'Installed', which
92 contain each VERSION of your Schema, and the date+time it was installed.
94 The actual upgrade is called manually by calling C<upgrade> on your
95 schema object. Code is run at connect time to determine whether an
96 upgrade is needed, if so, a warning "Versions out of sync" is
99 So you'll probably want to write a script which generates your DDLs and diffs
100 and another which executes the upgrade.
102 NB: At the moment, only SQLite and MySQL are supported. This is due to
103 spotty behaviour in the SQL::Translator producers, please help us by
108 =head2 upgrade_directory
110 Use this to set the directory your upgrade files are stored in.
112 =head2 backup_directory
114 Use this to set the directory you want your backups stored in.
118 package DBIx::Class::Schema::Versioned;
122 use base 'DBIx::Class';
123 use POSIX 'strftime';
126 __PACKAGE__->mk_classdata('_filedata');
127 __PACKAGE__->mk_classdata('upgrade_directory');
128 __PACKAGE__->mk_classdata('backup_directory');
129 __PACKAGE__->mk_classdata('do_backup');
130 __PACKAGE__->mk_classdata('do_diff_on_init');
132 =head2 schema_version
134 Returns the current schema class' $VERSION; does -not- use $schema->VERSION
135 since that varies in results depending on if version.pm is installed, and if
136 so the perl or XS versions. If you want this to change, bug the version.pm
137 author to make vpp and vxs behave the same.
143 my $class = ref($self)||$self;
147 $version = ${"${class}::VERSION"};
152 =head2 get_db_version
154 Returns the version that your database is currently at. This is determined by the values in the
155 dbix_class_schema_versions table that $self->upgrade writes to.
161 my ($self, $rs) = @_;
163 my $vtable = $self->{vschema}->resultset('Table');
166 my $stamp = $vtable->get_column('installed')->max;
167 $version = $vtable->search({ installed => $stamp })->first->version;
174 my ($self, $rs) = @_;
177 $rs->search({ 1, 0 })->count;
179 return 0 if $@ || !defined $c;
186 This is an overwritable method which is called just before the upgrade, to
187 allow you to make a backup of the database. Per default this method attempts
188 to call C<< $self->storage->backup >>, to run the standard backup on each
191 This method should return the name of the backup file, if appropriate..
198 ## Make each ::DBI::Foo do this
199 $self->storage->backup($self->backup_directory());
202 # is this just a waste of time? if not then merge with DBI.pm
203 sub _create_db_to_schema_diff {
206 my %driver_to_db_map = (
210 my $db = $driver_to_db_map{$self->storage->dbh->{Driver}->{Name}};
212 print "Sorry, this is an unsupported DB\n";
216 eval 'require SQL::Translator "0.09"';
218 $self->throw_exception("SQL::Translator 0.09 required");
221 my $db_tr = SQL::Translator->new({
224 parser_args => { dbh => $self->storage->dbh }
227 $db_tr->producer($db);
228 my $dbic_tr = SQL::Translator->new;
229 $dbic_tr->parser('SQL::Translator::Parser::DBIx::Class');
230 $dbic_tr = $self->storage->configure_sqlt($dbic_tr, $db);
231 $dbic_tr->data($self);
232 $dbic_tr->producer($db);
234 $db_tr->schema->name('db_schema');
235 $dbic_tr->schema->name('dbic_schema');
237 # is this really necessary?
238 foreach my $tr ($db_tr, $dbic_tr) {
239 my $data = $tr->data;
240 $tr->parser->($tr, $$data);
243 my $diff = SQL::Translator::Diff::schema_diff($db_tr->schema, $db,
244 $dbic_tr->schema, $db,
245 { ignore_constraint_names => 1, ignore_index_names => 1, caseopt => 1 });
247 my $filename = $self->ddl_filename(
249 $self->upgrade_directory,
250 $self->schema_version,
254 if(!open($file, ">$filename"))
256 $self->throw_exception("Can't open $filename for writing ($!)");
262 print "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";
267 Call this to attempt to upgrade your database from the version it is at to the version
268 this DBIC schema is at.
270 It requires an SQL diff file to exist in $schema->upgrade_directory, normally you will
271 have created this using $schema->create_ddl_dir.
278 my $db_version = $self->get_db_version();
281 unless ($db_version) {
282 # set version in dbix_class_schema_versions table, can't actually upgrade as we don 't know what version the DB is at
283 $self->_create_db_to_schema_diff() if ($self->do_diff_on_init);
285 # create versions table and version row
286 $self->{vschema}->deploy;
287 $self->_set_db_version;
291 # db and schema at same version. do nothing
292 if ($db_version eq $self->schema_version) {
293 print "Upgrade not necessary\n";
297 # strangely the first time this is called can
298 # differ to subsequent times. so we call it
301 $self->storage->sqlt_type;
303 my $upgrade_file = $self->ddl_filename(
304 $self->storage->sqlt_type,
305 $self->upgrade_directory,
306 $self->schema_version,
310 unless (-f $upgrade_file) {
311 warn "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
315 # backup if necessary then apply upgrade
316 $self->_filedata($self->_read_sql_file($upgrade_file));
317 $self->backup() if($self->do_backup);
318 $self->txn_do(sub { $self->do_upgrade() });
320 # set row in dbix_class_schema_versions table
321 $self->_set_db_version;
324 sub _set_db_version {
327 my $vtable = $self->{vschema}->resultset('Table');
328 $vtable->create({ version => $self->schema_version,
329 installed => strftime("%Y-%m-%d %H:%M:%S", gmtime())
336 my $file = shift || return;
339 open $fh, "<$file" or warn("Can't open upgrade file, $file ($!)");
340 my @data = split(/\n/, join('', <$fh>));
341 @data = grep(!/^--/, @data);
342 @data = split(/;/, join('', @data));
344 @data = grep { $_ && $_ !~ /^-- / } @data;
345 @data = grep { $_ !~ /^(BEGIN TRANSACTION|COMMIT)/m } @data;
351 This is an overwritable method used to run your upgrade. The freeform method
352 allows you to run your upgrade any way you please, you can call C<run_upgrade>
353 any number of times to run the actual SQL commands, and in between you can
354 sandwich your data upgrading. For example, first run all the B<CREATE>
355 commands, then migrate your data from old to new tables/formats, then
356 issue the DROP commands when you are finished. Will run the whole file as it is by default.
364 # just run all the commands (including inserts) in order
365 $self->run_upgrade(qr/.*?/);
370 $self->run_upgrade(qr/create/i);
372 Runs a set of SQL statements matching a passed in regular expression. The
373 idea is that this method can be called any number of times from your
374 C<upgrade> method, running whichever commands you specify via the
375 regex in the parameter. Probably won't work unless called from the overridable
382 my ($self, $stm) = @_;
384 return unless ($self->_filedata);
385 my @statements = grep { $_ =~ $stm } @{$self->_filedata};
386 $self->_filedata([ grep { $_ !~ /$stm/i } @{$self->_filedata} ]);
390 $self->storage->debugobj->query_start($_) if $self->storage->debug;
391 $self->storage->dbh->do($_) or warn "SQL was:\n $_";
392 $self->storage->debugobj->query_end($_) if $self->storage->debug;
400 Overloaded method. This checks the DBIC schema version against the DB version and
401 warns if they are not the same or if the DB is unversioned. It also provides
402 compatibility between the old versions table (SchemaVersions) and the new one
403 (dbix_class_schema_versions).
405 To avoid the checks on connect, set the env var DBIC_NO_VERSION_CHECK. This can be
412 $self->next::method(@_);
420 $self->{vschema} = DBIx::Class::Version->connect(@{$self->storage->connect_info()});
421 my $vtable = $self->{vschema}->resultset('Table');
423 # check for legacy versions table and move to new if exists
424 my $vschema_compat = DBIx::Class::VersionCompat->connect(@{$self->storage->connect_info()});
425 unless ($self->_source_exists($vtable)) {
426 my $vtable_compat = $vschema_compat->resultset('TableCompat');
427 if ($self->_source_exists($vtable_compat)) {
428 $self->{vschema}->deploy;
429 map { $vtable->create({ installed => $_->Installed, version => $_->Version }) } $vtable_compat->all;
430 $self->storage->dbh->do("DROP TABLE " . $vtable_compat->result_source->from);
434 # useful when connecting from scripts etc
435 return if ($ENV{DBIC_NO_VERSION_CHECK});
437 my $pversion = $self->get_db_version();
439 if($pversion eq $self->schema_version)
441 # warn "This version is already installed\n";
447 warn "Your DB is currently unversioned. Please call upgrade on your schema to sync the DB.\n";
451 warn "Versions out of sync. This is " . $self->schema_version .
452 ", your database contains version $pversion, please call upgrade on your Schema.\n";
460 Jess Robinson <castaway@desert-island.demon.co.uk>
461 Luke Saunders <luke@shadowcatsystems.co.uk>
465 You may distribute this code under the same terms as Perl itself.