1 package DBIx::Class::Version::Table;
2 use base 'DBIx::Class';
6 __PACKAGE__->load_components(qw/ Core/);
7 __PACKAGE__->table('SchemaVersions');
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 DBIx::Class::Version;
32 use base 'DBIx::Class::Schema';
36 __PACKAGE__->register_class('Table', 'DBIx::Class::Version::Table');
39 # ---------------------------------------------------------------------------
40 package DBIx::Class::Schema::Versioned;
44 use base 'DBIx::Class';
48 __PACKAGE__->mk_classdata('_filedata');
49 __PACKAGE__->mk_classdata('upgrade_directory');
50 __PACKAGE__->mk_classdata('backup_directory');
51 __PACKAGE__->mk_classdata('do_backup');
55 my $class = ref($self)||$self;
59 $version = ${"${class}::VERSION"};
66 $self->next::method(@_);
74 $self->{vschema} = DBIx::Class::Version->connect(@{$self->storage->connect_info()});
76 my $pversion = $self->get_db_version();
78 if($pversion eq $self->schema_version)
80 warn "This version is already installed\n";
86 warn "Your DB is currently unversioned. Please call upgrade on your schema to sync the DB.\n";
90 my $file = $self->ddl_filename(
91 $self->storage->sqlt_type,
92 $self->upgrade_directory,
97 # No upgrade path between these two versions
102 ## Don't do this yet, do only on command?
103 ## If we do this later, where does the Version table get updated??
104 warn "Versions out of sync. This is " . $self->schema_version .
105 ", your database contains version $pversion, please call upgrade on your Schema.\n";
110 my ($self, $rs) = @_;
112 my $vtable = $self->{vschema}->resultset('Table');
113 return 0 unless ($self->_source_exists($vtable));
115 my $psearch = $vtable->search(undef,
117 { 'max' => 'Installed' },
119 as => ['maxinstall'],
121 my $pversion = $vtable->search({ Installed => $psearch->get_column('maxinstall'),
123 $pversion = $pversion->Version if($pversion);
129 my ($self, $rs) = @_;
132 $rs->search({ 1, 0 })->count;
134 return 0 if $@ || !defined $c;
142 ## Make each ::DBI::Foo do this
143 $self->storage->backup($self->backup_directory());
146 # TODO: some of this needs to be merged with ->create_ddl_dir
150 my $db_version = $self->get_db_version();
152 my %driver_to_db_map = (
156 my $db = $driver_to_db_map{$self->storage->dbh->{Driver}->{Name}};
158 print "Sorry, this is an unsupported DB\n";
162 require SQL::Translator;
163 require SQL::Translator::Diff;
164 my $db_tr = SQL::Translator->new({
167 parser_args => { dbh => $self->storage->dbh }
170 $db_tr->producer($db);
171 my $dbic_tr = SQL::Translator->new;
172 $dbic_tr->parser('SQL::Translator::Parser::DBIx::Class');
173 $dbic_tr = $self->storage->configure_sqlt($dbic_tr, $db);
174 $dbic_tr->data($self);
175 $dbic_tr->producer($db);
177 $db_tr->schema->name('db_schema');
178 $dbic_tr->schema->name('dbic_schema');
180 # is this really necessary?
181 foreach my $tr ($db_tr, $dbic_tr) {
182 my $data = $tr->data;
183 $tr->parser->($tr, $$data);
186 my $diff = SQL::Translator::Diff::schema_diff($db_tr->schema, $db,
187 $dbic_tr->schema, $db,
190 my $filename = $self->ddl_filename(
192 $self->upgrade_directory,
193 $self->schema_version,
197 if(!open($file, ">$filename"))
199 $self->throw_exception("Can't open $filename for writing ($!)");
205 # create versions table
206 $self->{vschema}->deploy;
208 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";
210 if ($db_version eq $self->schema_version) {
211 print "Upgrade not necessary\n";
215 my $file = $self->ddl_filename(
216 $self->storage->sqlt_type,
217 $self->upgrade_directory,
218 $self->schema_version,
224 warn "Upgrade not possible, no upgrade file found ($file)\n";
229 open $fh, "<$file" or warn("Can't open upgrade file, $file ($!)");
230 my @data = split(/\n/, join('', <$fh>));
231 @data = grep(!/^--/, @data);
232 @data = split(/;/, join('', @data));
234 @data = grep { $_ && $_ !~ /^-- / } @data;
235 @data = grep { $_ !~ /^(BEGIN TRANACTION|COMMIT)/m } @data;
237 $self->_filedata(\@data);
238 $self->backup() if($self->do_backup);
245 my $vtable = $self->{vschema}->resultset('Table');
246 $vtable->create({ Version => $self->schema_version,
247 Installed => strftime("%Y-%m-%d %H:%M:%S", gmtime())
256 ## overridable sub, per default just run all the commands.
257 $self->run_upgrade(qr/create/i);
258 $self->run_upgrade(qr/alter table .*? add/i);
259 $self->run_upgrade(qr/alter table .*? (?!drop)/i);
260 $self->run_upgrade(qr/alter table .*? drop/i);
261 $self->run_upgrade(qr/drop/i);
266 my ($self, $stm) = @_;
267 # print "Reg: $stm\n";
268 my @statements = grep { $_ =~ $stm } @{$self->_filedata};
269 # print "Statements: ", join("\n", @statements), "\n";
270 $self->_filedata([ grep { $_ !~ /$stm/i } @{$self->_filedata} ]);
274 $self->storage->debugobj->query_start($_) if $self->storage->debug;
275 $self->storage->dbh->do($_) or warn "SQL was:\n $_";
276 $self->storage->debugobj->query_end($_) if $self->storage->debug;
286 DBIx::Class::Schema::Versioned - DBIx::Class::Schema plugin for Schema upgrades
290 package Library::Schema;
291 use base qw/DBIx::Class::Schema/;
292 # load Library::Schema::CD, Library::Schema::Book, Library::Schema::DVD
293 __PACKAGE__->load_classes(qw/CD Book DVD/);
295 __PACKAGE__->load_components(qw/+DBIx::Class::Schema::Versioned/);
296 __PACKAGE__->upgrade_directory('/path/to/upgrades/');
297 __PACKAGE__->backup_directory('/path/to/backups/');
302 # my special backup process
309 ## overridable sub, per default just runs all the commands.
311 $self->run_upgrade(qr/create/i);
312 $self->run_upgrade(qr/alter table .*? add/i);
313 $self->run_upgrade(qr/alter table .*? (?!drop)/i);
314 $self->run_upgrade(qr/alter table .*? drop/i);
315 $self->run_upgrade(qr/drop/i);
316 $self->run_upgrade(qr//i);
321 This module is a component designed to extend L<DBIx::Class::Schema>
322 classes, to enable them to upgrade to newer schema layouts. To use this
323 module, you need to have called C<create_ddl_dir> on your Schema to
324 create your upgrade files to include with your delivery.
326 A table called I<SchemaVersions> is created and maintained by the
327 module. This contains two fields, 'Version' and 'Installed', which
328 contain each VERSION of your Schema, and the date+time it was installed.
330 If you would like to influence which levels of version change need
331 upgrades in your Schema, you can override the method C<ddl_filename>
332 in L<DBIx::Class::Schema>. Return a false value if there is no upgrade
333 path between the two versions supplied. By default, every change in
334 your VERSION is regarded as needing an upgrade.
336 The actual upgrade is called manually by calling C<upgrade> on your
337 schema object. Code is run at connect time to determine whether an
338 upgrade is needed, if so, a warning "Versions out of sync" is
341 NB: At the moment, SQLite upgrading is rather spotty, as SQL::Translator::Diff
342 returns SQL statements that SQLite does not support.
349 This is an overwritable method which is called just before the upgrade, to
350 allow you to make a backup of the database. Per default this method attempts
351 to call C<< $self->storage->backup >>, to run the standard backup on each
354 This method should return the name of the backup file, if appropriate..
358 This is the main upgrade method which calls the overridable do_upgrade and
359 also handles the backups and updating of the SchemaVersion table.
363 This is an overwritable method used to run your upgrade. The freeform method
364 allows you to run your upgrade any way you please, you can call C<run_upgrade>
365 any number of times to run the actual SQL commands, and in between you can
366 sandwich your data upgrading. For example, first run all the B<CREATE>
367 commands, then migrate your data from old to new tables/formats, then
368 issue the DROP commands when you are finished.
372 $self->run_upgrade(qr/create/i);
374 Runs a set of SQL statements matching a passed in regular expression. The
375 idea is that this method can be called any number of times from your
376 C<upgrade> method, running whichever commands you specify via the
377 regex in the parameter.
379 =head2 upgrade_directory
381 Use this to set the directory your upgrade files are stored in.
383 =head2 backup_directory
385 Use this to set the directory you want your backups stored in.
387 =head2 schema_version
389 Returns the current schema class' $VERSION; does -not- use $schema->VERSION
390 since that varies in results depending on if version.pm is installed, and if
391 so the perl or XS versions. If you want this to change, bug the version.pm
392 author to make vpp and vxs behave the same.
396 Jess Robinson <castaway@desert-island.demon.co.uk>