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 sub _generate_db_schema
159 my $db_version = $self->get_db_version();
162 my %driver_to_db_map = (
164 'Pg' => 'PostgreSQL',
167 my $db = $driver_to_db_map{$self->storage->dbh->{Driver}->{Name}};
169 print "Sorry, this is an unsupported DB\n";
173 require SQL::Translator;
174 require SQL::Translator::Diff;
176 my $db_tr = SQL::Translator->new({
180 dsn => 'dbi:mysql:dbname=takkle_test',
181 db_user => 'newtakkle',
182 db_password => 'takkle123'
186 $db_tr->producer($db);
187 my $dbic_tr = SQL::Translator->new;
188 $dbic_tr->parser('SQL::Translator::Parser::DBIx::Class');
189 $dbic_tr = $self->storage->configure_sqlt($dbic_tr, $db);
190 $dbic_tr->data($self);
191 $dbic_tr->producer($db);
193 $db_tr->schema->name('1');
194 $dbic_tr->schema->name('2');
197 # is this really necessary?
198 foreach my $tr ($db_tr, $dbic_tr) {
199 my $data = $tr->data;
200 $tr->parser->($tr, $$data);
203 my $diff = SQL::Translator::Diff::schema_diff($db_tr->schema, $db,
204 $dbic_tr->schema, $db,
205 { ignore_constraint_names => 1, ignore_index_names => 1, caseopt => 1 });
207 my $filename = $self->ddl_filename(
208 $self->storage->sqlt_type,
209 $self->upgrade_directory,
210 $self->schema_version,
214 if(!open($file, ">$filename"))
216 $self->throw_exception("Can't open $filename for writing ($!)");
222 print "WARNING: There may be differences between your DB and your DBIC schema. Please review and if necessary run the SQL $filename to sync your DB.\n";
224 my $file = $self->ddl_filename(
225 $self->storage->sqlt_type,
226 $self->upgrade_directory,
227 $self->schema_version,
233 warn "Upgrade not possible, no upgrade file found ($file)\n";
238 open $fh, "<$file" or warn("Can't open upgrade file, $file ($!)");
239 my @data = split(/[;\n]/, join('', <$fh>));
241 @data = grep { $_ && $_ !~ /^-- / } @data;
242 @data = grep { $_ !~ /^(BEGIN TRANACTION|COMMIT)/m } @data;
244 $self->_filedata(\@data);
245 $self->backup() if($self->do_backup);
252 my $vtable = $self->{vschema}->resultset('Table');
253 $vtable->create({ Version => $self->schema_version,
254 Installed => strftime("%Y-%m-%d %H:%M:%S", gmtime())
263 ## overridable sub, per default just run all the commands.
264 $self->run_upgrade(qr/create/i);
265 $self->run_upgrade(qr/alter table .*? add/i);
266 $self->run_upgrade(qr/alter table .*? (?!drop)/i);
267 $self->run_upgrade(qr/alter table .*? drop/i);
268 $self->run_upgrade(qr/drop/i);
273 my ($self, $stm) = @_;
274 # print "Reg: $stm\n";
275 my @statements = grep { $_ =~ $stm } @{$self->_filedata};
276 # print "Statements: ", join("\n", @statements), "\n";
277 $self->_filedata([ grep { $_ !~ /$stm/i } @{$self->_filedata} ]);
281 $self->storage->debugobj->query_start($_) if $self->storage->debug;
282 $self->storage->dbh->do($_) or warn "SQL was:\n $_";
283 $self->storage->debugobj->query_end($_) if $self->storage->debug;
293 DBIx::Class::Schema::Versioned - DBIx::Class::Schema plugin for Schema upgrades
297 package Library::Schema;
298 use base qw/DBIx::Class::Schema/;
299 # load Library::Schema::CD, Library::Schema::Book, Library::Schema::DVD
300 __PACKAGE__->load_classes(qw/CD Book DVD/);
302 __PACKAGE__->load_components(qw/+DBIx::Class::Schema::Versioned/);
303 __PACKAGE__->upgrade_directory('/path/to/upgrades/');
304 __PACKAGE__->backup_directory('/path/to/backups/');
309 # my special backup process
316 ## overridable sub, per default just runs all the commands.
318 $self->run_upgrade(qr/create/i);
319 $self->run_upgrade(qr/alter table .*? add/i);
320 $self->run_upgrade(qr/alter table .*? (?!drop)/i);
321 $self->run_upgrade(qr/alter table .*? drop/i);
322 $self->run_upgrade(qr/drop/i);
323 $self->run_upgrade(qr//i);
328 This module is a component designed to extend L<DBIx::Class::Schema>
329 classes, to enable them to upgrade to newer schema layouts. To use this
330 module, you need to have called C<create_ddl_dir> on your Schema to
331 create your upgrade files to include with your delivery.
333 A table called I<SchemaVersions> is created and maintained by the
334 module. This contains two fields, 'Version' and 'Installed', which
335 contain each VERSION of your Schema, and the date+time it was installed.
337 If you would like to influence which levels of version change need
338 upgrades in your Schema, you can override the method C<ddl_filename>
339 in L<DBIx::Class::Schema>. Return a false value if there is no upgrade
340 path between the two versions supplied. By default, every change in
341 your VERSION is regarded as needing an upgrade.
343 The actual upgrade is called manually by calling C<upgrade> on your
344 schema object. Code is run at connect time to determine whether an
345 upgrade is needed, if so, a warning "Versions out of sync" is
348 NB: At the moment, SQLite upgrading is rather spotty, as SQL::Translator::Diff
349 returns SQL statements that SQLite does not support.
356 This is an overwritable method which is called just before the upgrade, to
357 allow you to make a backup of the database. Per default this method attempts
358 to call C<< $self->storage->backup >>, to run the standard backup on each
361 This method should return the name of the backup file, if appropriate..
365 This is the main upgrade method which calls the overridable do_upgrade and
366 also handles the backups and updating of the SchemaVersion table.
370 This is an overwritable method used to run your upgrade. The freeform method
371 allows you to run your upgrade any way you please, you can call C<run_upgrade>
372 any number of times to run the actual SQL commands, and in between you can
373 sandwich your data upgrading. For example, first run all the B<CREATE>
374 commands, then migrate your data from old to new tables/formats, then
375 issue the DROP commands when you are finished.
379 $self->run_upgrade(qr/create/i);
381 Runs a set of SQL statements matching a passed in regular expression. The
382 idea is that this method can be called any number of times from your
383 C<upgrade> method, running whichever commands you specify via the
384 regex in the parameter.
386 =head2 upgrade_directory
388 Use this to set the directory your upgrade files are stored in.
390 =head2 backup_directory
392 Use this to set the directory you want your backups stored in.
394 =head2 schema_version
396 Returns the current schema class' $VERSION; does -not- use $schema->VERSION
397 since that varies in results depending on if version.pm is installed, and if
398 so the perl or XS versions. If you want this to change, bug the version.pm
399 author to make vpp and vxs behave the same.
403 Jess Robinson <castaway@desert-island.demon.co.uk>