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
107 =head1 GETTING STARTED
114 =head2 upgrade_directory
116 Use this to set the directory your upgrade files are stored in.
118 =head2 backup_directory
120 Use this to set the directory you want your backups stored in.
124 package DBIx::Class::Schema::Versioned;
128 use base 'DBIx::Class';
129 use POSIX 'strftime';
132 __PACKAGE__->mk_classdata('_filedata');
133 __PACKAGE__->mk_classdata('upgrade_directory');
134 __PACKAGE__->mk_classdata('backup_directory');
135 __PACKAGE__->mk_classdata('do_backup');
136 __PACKAGE__->mk_classdata('do_diff_on_init');
142 =item Arguments: $db_version
146 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.
148 Takes one argument which should be the version that the database is currently at. Defaults to the return value of L</schema_version>.
150 See L</getting_started> for more details.
156 my ($self, $new_version) = @_;
158 # must be called on a fresh database
159 if ($self->get_db_version()) {
160 warn 'Install not possible as versions table already exists in database';
163 # default to current version if none passed
164 $new_version ||= $self->schema_version();
166 unless ($new_version) {
167 # create versions table and version row
168 $self->{vschema}->deploy;
169 $self->_set_db_version;
175 Call this to attempt to upgrade your database from the version it is at to the version
176 this DBIC schema is at.
178 It requires an SQL diff file to exist in $schema->upgrade_directory, normally you will
179 have created this using $schema->create_ddl_dir.
186 my $db_version = $self->get_db_version();
189 unless ($db_version) {
190 warn 'Upgrade not possible as database is unversioned. Please call install first.';
194 # db and schema at same version. do nothing
195 if ($db_version eq $self->schema_version) {
196 print "Upgrade not necessary\n";
200 # strangely the first time this is called can
201 # differ to subsequent times. so we call it
204 $self->storage->sqlt_type;
206 my $upgrade_file = $self->ddl_filename(
207 $self->storage->sqlt_type,
208 $self->schema_version,
209 $self->upgrade_directory,
213 unless (-f $upgrade_file) {
214 warn "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
218 # backup if necessary then apply upgrade
219 $self->_filedata($self->_read_sql_file($upgrade_file));
220 $self->backup() if($self->do_backup);
221 $self->txn_do(sub { $self->do_upgrade() });
223 # set row in dbix_class_schema_versions table
224 $self->_set_db_version;
229 This is an overwritable method used to run your upgrade. The freeform method
230 allows you to run your upgrade any way you please, you can call C<run_upgrade>
231 any number of times to run the actual SQL commands, and in between you can
232 sandwich your data upgrading. For example, first run all the B<CREATE>
233 commands, then migrate your data from old to new tables/formats, then
234 issue the DROP commands when you are finished. Will run the whole file as it is by default.
242 # just run all the commands (including inserts) in order
243 $self->run_upgrade(qr/.*?/);
248 $self->run_upgrade(qr/create/i);
250 Runs a set of SQL statements matching a passed in regular expression. The
251 idea is that this method can be called any number of times from your
252 C<upgrade> method, running whichever commands you specify via the
253 regex in the parameter. Probably won't work unless called from the overridable
260 my ($self, $stm) = @_;
262 return unless ($self->_filedata);
263 my @statements = grep { $_ =~ $stm } @{$self->_filedata};
264 $self->_filedata([ grep { $_ !~ /$stm/i } @{$self->_filedata} ]);
268 $self->storage->debugobj->query_start($_) if $self->storage->debug;
269 $self->storage->dbh->do($_) or warn "SQL was:\n $_";
270 $self->storage->debugobj->query_end($_) if $self->storage->debug;
276 =head2 get_db_version
278 Returns the version that your database is currently at. This is determined by the values in the
279 dbix_class_schema_versions table that $self->upgrade writes to.
285 my ($self, $rs) = @_;
287 my $vtable = $self->{vschema}->resultset('Table');
290 my $stamp = $vtable->get_column('installed')->max;
291 $version = $vtable->search({ installed => $stamp })->first->version;
296 =head2 schema_version
298 Returns the current schema class' $VERSION
304 This is an overwritable method which is called just before the upgrade, to
305 allow you to make a backup of the database. Per default this method attempts
306 to call C<< $self->storage->backup >>, to run the standard backup on each
309 This method should return the name of the backup file, if appropriate..
311 This method is disabled by default. Set $schema->do_backup(1) to enable it.
318 ## Make each ::DBI::Foo do this
319 $self->storage->backup($self->backup_directory());
324 Overloaded method. This checks the DBIC schema version against the DB version and
325 warns if they are not the same or if the DB is unversioned. It also provides
326 compatibility between the old versions table (SchemaVersions) and the new one
327 (dbix_class_schema_versions).
329 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 arg like so:
331 my $schema = MyApp::Schema->connect(
335 { ignore_version => 1 },
342 $self->next::method(@_);
343 $self->_on_connect($_[3]);
349 my ($self, $args) = @_;
351 $args = {} unless $args;
352 $self->{vschema} = DBIx::Class::Version->connect(@{$self->storage->connect_info()});
353 my $vtable = $self->{vschema}->resultset('Table');
355 # check for legacy versions table and move to new if exists
356 my $vschema_compat = DBIx::Class::VersionCompat->connect(@{$self->storage->connect_info()});
357 unless ($self->_source_exists($vtable)) {
358 my $vtable_compat = $vschema_compat->resultset('TableCompat');
359 if ($self->_source_exists($vtable_compat)) {
360 $self->{vschema}->deploy;
361 map { $vtable->create({ installed => $_->Installed, version => $_->Version }) } $vtable_compat->all;
362 $self->storage->dbh->do("DROP TABLE " . $vtable_compat->result_source->from);
366 # useful when connecting from scripts etc
367 return if ($args->{ignore_version} || ($ENV{DBIC_NO_VERSION_CHECK} && !exists $args->{ignore_version}));
368 my $pversion = $self->get_db_version();
370 if($pversion eq $self->schema_version)
372 # warn "This version is already installed\n";
378 warn "Your DB is currently unversioned. Please call upgrade on your schema to sync the DB.\n";
382 warn "Versions out of sync. This is " . $self->schema_version .
383 ", your database contains version $pversion, please call upgrade on your Schema.\n";
386 # is this just a waste of time? if not then merge with DBI.pm
387 sub _create_db_to_schema_diff {
390 my %driver_to_db_map = (
394 my $db = $driver_to_db_map{$self->storage->dbh->{Driver}->{Name}};
396 print "Sorry, this is an unsupported DB\n";
400 eval 'require SQL::Translator "0.09"';
402 $self->throw_exception("SQL::Translator 0.09 required");
405 my $db_tr = SQL::Translator->new({
408 parser_args => { dbh => $self->storage->dbh }
411 $db_tr->producer($db);
412 my $dbic_tr = SQL::Translator->new;
413 $dbic_tr->parser('SQL::Translator::Parser::DBIx::Class');
414 $dbic_tr = $self->storage->configure_sqlt($dbic_tr, $db);
415 $dbic_tr->data($self);
416 $dbic_tr->producer($db);
418 $db_tr->schema->name('db_schema');
419 $dbic_tr->schema->name('dbic_schema');
421 # is this really necessary?
422 foreach my $tr ($db_tr, $dbic_tr) {
423 my $data = $tr->data;
424 $tr->parser->($tr, $$data);
427 my $diff = SQL::Translator::Diff::schema_diff($db_tr->schema, $db,
428 $dbic_tr->schema, $db,
429 { ignore_constraint_names => 1, ignore_index_names => 1, caseopt => 1 });
431 my $filename = $self->ddl_filename(
433 $self->schema_version,
434 $self->upgrade_directory,
438 if(!open($file, ">$filename"))
440 $self->throw_exception("Can't open $filename for writing ($!)");
446 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";
450 sub _set_db_version {
453 my $vtable = $self->{vschema}->resultset('Table');
454 $vtable->create({ version => $self->schema_version,
455 installed => strftime("%Y-%m-%d %H:%M:%S", gmtime())
462 my $file = shift || return;
465 open $fh, "<$file" or warn("Can't open upgrade file, $file ($!)");
466 my @data = split(/\n/, join('', <$fh>));
467 @data = grep(!/^--/, @data);
468 @data = split(/;/, join('', @data));
470 @data = grep { $_ && $_ !~ /^-- / } @data;
471 @data = grep { $_ !~ /^(BEGIN|BEGIN TRANSACTION|COMMIT)/m } @data;
477 my ($self, $rs) = @_;
480 $rs->search({ 1, 0 })->count;
482 return 0 if $@ || !defined $c;
492 Jess Robinson <castaway@desert-island.demon.co.uk>
493 Luke Saunders <luke@shadowcatsystems.co.uk>
497 You may distribute this code under the same terms as Perl itself.