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 MyApp::Schema;
74 use base qw/DBIx::Class::Schema/;
78 # load MyApp::Schema::CD, MyApp::Schema::Book, MyApp::Schema::DVD
79 __PACKAGE__->load_classes(qw/CD Book DVD/);
81 __PACKAGE__->load_components(qw/Schema::Versioned/);
82 __PACKAGE__->upgrade_directory('/path/to/upgrades/');
87 This module provides methods to apply DDL changes to your database using SQL
88 diff files. Normally these diff files would be created using
89 L<DBIx::Class::Schema/create_ddl_dir>.
91 A table called I<dbix_class_schema_versions> is created and maintained by the
92 module. This is used to determine which version your database is currently at.
93 Similarly the $VERSION in your DBIC schema class is used to determine the
94 current DBIC schema version.
96 The upgrade is initiated manually by calling C<upgrade> on your schema object,
97 this will attempt to upgrade the database from its current version to the current
98 schema version using a diff from your I<upgrade_directory>. If a suitable diff is
99 not found then no upgrade is possible.
101 NB: At the moment, only SQLite and MySQL are supported. This is due to
102 spotty behaviour in the SQL::Translator producers, please help us by
103 enhancing them. Ask on the mailing list or IRC channel for details (community details
106 =head1 GETTING STARTED
108 Firstly you need to setup your schema class as per the L</SYNOPSIS>, make sure
109 you have specified an upgrade_directory and an initial $VERSION.
111 Then you'll need two scripts, one to create DDL files and diffs and another to perform
112 upgrades. Your creation script might look like a bit like this:
119 my ( $preversion, $help );
121 'p|preversion:s' => \$preversion,
124 my $schema = MyApp::Schema->connect(
129 my $sql_dir = './sql';
130 my $version = $schema->schema_version();
131 $schema->create_ddl_dir( 'MySQL', $version, $sql_dir, $preversion );
133 Then your upgrade script might look like so:
138 my $schema = MyApp::Schema->connect(
144 if (!$schema->get_db_version()) {
145 # schema is unversioned
151 The script above assumes that if the database is unversioned then it is empty
152 and we can safely deploy the DDL to it. However things are not always so simple.
154 if you want to initialise a pre-existing database where the DDL is not the same
155 as the DDL for your current schema version then you will need a diff which
156 converts the database's DDL to the current DDL. The best way to do this is
157 to get a dump of the database schema (without data) and save that in your
158 SQL directory as version 0.000 (the filename must be as with
159 L<DBIx::Class::Schema/ddl_filename>) then create a diff using your create DDL
160 script given above from version 0.000 to the current version. Then hand check
161 and if necessary edit the resulting diff to ensure that it will apply. Once you have
162 done all that you can do this:
164 if (!$schema->get_db_version()) {
165 # schema is unversioned
166 $schema->install("0.000");
169 # this will now apply the 0.000 to current version diff
172 In the case of an unversioned database the above code will create the
173 dbix_class_schema_versions table and write version 0.000 to it, then
174 upgrade will then apply the diff we talked about creating in the previous paragraph
175 and then you're good to go.
179 package DBIx::Class::Schema::Versioned;
183 use base 'DBIx::Class';
185 use Carp::Clan qw/^DBIx::Class/;
186 use POSIX 'strftime';
188 __PACKAGE__->mk_classdata('_filedata');
189 __PACKAGE__->mk_classdata('upgrade_directory');
190 __PACKAGE__->mk_classdata('backup_directory');
191 __PACKAGE__->mk_classdata('do_backup');
192 __PACKAGE__->mk_classdata('do_diff_on_init');
197 =head2 upgrade_directory
199 Use this to set the directory your upgrade files are stored in.
201 =head2 backup_directory
203 Use this to set the directory you want your backups stored in (note that backups
204 are disabled by default).
212 =item Arguments: $db_version
216 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.
218 Takes one argument which should be the version that the database is currently at. Defaults to the return value of L</schema_version>.
220 See L</getting_started> for more details.
226 my ($self, $new_version) = @_;
228 # must be called on a fresh database
229 if ($self->get_db_version()) {
230 carp 'Install not possible as versions table already exists in database';
233 # default to current version if none passed
234 $new_version ||= $self->schema_version();
237 # create versions table and version row
238 $self->{vschema}->deploy;
239 $self->_set_db_version({ version => $new_version });
245 Same as L<DBIx::Class::Schema/deploy> but also calls C<install>.
251 $self->next::method(@_);
255 =head2 create_upgrade_path
259 =item Arguments: { upgrade_file => $file }
263 Virtual method that should be overriden to create an upgrade file.
264 This is useful in the case of upgrading across multiple versions
265 to concatenate several files to create one upgrade file.
267 You'll probably want the db_version retrieved via $self->get_db_version
268 and the schema_version which is retrieved via $self->schema_version
272 sub create_upgrade_path {
273 ## override this method
278 Call this to attempt to upgrade your database from the version it is at to the version
279 this DBIC schema is at. If they are the same it does nothing.
281 It requires an SQL diff file to exist in you I<upgrade_directory>, normally you will
282 have created this using L<DBIx::Class::Schema/create_ddl_dir>.
284 If successful the dbix_class_schema_versions table is updated with the current
292 my $db_version = $self->get_db_version();
295 unless ($db_version) {
296 carp 'Upgrade not possible as database is unversioned. Please call install first.';
300 # db and schema at same version. do nothing
301 if ($db_version eq $self->schema_version) {
302 carp "Upgrade not necessary\n";
306 # strangely the first time this is called can
307 # differ to subsequent times. so we call it
310 $self->storage->sqlt_type;
312 my $upgrade_file = $self->ddl_filename(
313 $self->storage->sqlt_type,
314 $self->schema_version,
315 $self->upgrade_directory,
319 $self->create_upgrade_path({ upgrade_file => $upgrade_file });
321 unless (-f $upgrade_file) {
322 carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
326 carp "\nDB version ($db_version) is lower than the schema version (".$self->schema_version."). Attempting upgrade.\n";
328 # backup if necessary then apply upgrade
329 $self->_filedata($self->_read_sql_file($upgrade_file));
330 $self->backup() if($self->do_backup);
331 $self->txn_do(sub { $self->do_upgrade() });
333 # set row in dbix_class_schema_versions table
334 $self->_set_db_version;
339 This is an overwritable method used to run your upgrade. The freeform method
340 allows you to run your upgrade any way you please, you can call C<run_upgrade>
341 any number of times to run the actual SQL commands, and in between you can
342 sandwich your data upgrading. For example, first run all the B<CREATE>
343 commands, then migrate your data from old to new tables/formats, then
344 issue the DROP commands when you are finished. Will run the whole file as it is by default.
352 # just run all the commands (including inserts) in order
353 $self->run_upgrade(qr/.*?/);
358 $self->run_upgrade(qr/create/i);
360 Runs a set of SQL statements matching a passed in regular expression. The
361 idea is that this method can be called any number of times from your
362 C<do_upgrade> method, running whichever commands you specify via the
363 regex in the parameter. Probably won't work unless called from the overridable
370 my ($self, $stm) = @_;
372 return unless ($self->_filedata);
373 my @statements = grep { $_ =~ $stm } @{$self->_filedata};
374 $self->_filedata([ grep { $_ !~ /$stm/i } @{$self->_filedata} ]);
378 $self->storage->debugobj->query_start($_) if $self->storage->debug;
379 $self->apply_statement($_);
380 $self->storage->debugobj->query_end($_) if $self->storage->debug;
386 =head2 apply_statement
388 Takes an SQL statement and runs it. Override this if you want to handle errors
393 sub apply_statement {
394 my ($self, $statement) = @_;
396 $self->storage->dbh->do($_) or carp "SQL was:\n $_";
399 =head2 get_db_version
401 Returns the version that your database is currently at. This is determined by the values in the
402 dbix_class_schema_versions table that C<upgrade> and C<install> write to.
408 my ($self, $rs) = @_;
410 my $vtable = $self->{vschema}->resultset('Table');
413 my $stamp = $vtable->get_column('installed')->max;
414 $version = $vtable->search({ installed => $stamp })->first->version;
419 =head2 schema_version
421 Returns the current schema class' $VERSION
427 This is an overwritable method which is called just before the upgrade, to
428 allow you to make a backup of the database. Per default this method attempts
429 to call C<< $self->storage->backup >>, to run the standard backup on each
432 This method should return the name of the backup file, if appropriate..
434 This method is disabled by default. Set $schema->do_backup(1) to enable it.
441 ## Make each ::DBI::Foo do this
442 $self->storage->backup($self->backup_directory());
447 Overloaded method. This checks the DBIC schema version against the DB version and
448 warns if they are not the same or if the DB is unversioned. It also provides
449 compatibility between the old versions table (SchemaVersions) and the new one
450 (dbix_class_schema_versions).
452 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 argument like so:
454 my $schema = MyApp::Schema->connect(
458 { ignore_version => 1 },
465 $self->next::method(@_);
466 $self->_on_connect($_[3]);
472 my ($self, $args) = @_;
474 $args = {} unless $args;
475 $self->{vschema} = DBIx::Class::Version->connect(@{$self->storage->connect_info()});
476 my $vtable = $self->{vschema}->resultset('Table');
478 # check for legacy versions table and move to new if exists
479 my $vschema_compat = DBIx::Class::VersionCompat->connect(@{$self->storage->connect_info()});
480 unless ($self->_source_exists($vtable)) {
481 my $vtable_compat = $vschema_compat->resultset('TableCompat');
482 if ($self->_source_exists($vtable_compat)) {
483 $self->{vschema}->deploy;
484 map { $vtable->create({ installed => $_->Installed, version => $_->Version }) } $vtable_compat->all;
485 $self->storage->dbh->do("DROP TABLE " . $vtable_compat->result_source->from);
489 # useful when connecting from scripts etc
490 return if ($args->{ignore_version} || ($ENV{DBIC_NO_VERSION_CHECK} && !exists $args->{ignore_version}));
491 my $pversion = $self->get_db_version();
493 if($pversion eq $self->schema_version)
495 # carp "This version is already installed\n";
501 carp "Your DB is currently unversioned. Please call upgrade on your schema to sync the DB.\n";
505 carp "Versions out of sync. This is " . $self->schema_version .
506 ", your database contains version $pversion, please call upgrade on your Schema.\n";
509 # is this just a waste of time? if not then merge with DBI.pm
510 sub _create_db_to_schema_diff {
513 my %driver_to_db_map = (
517 my $db = $driver_to_db_map{$self->storage->dbh->{Driver}->{Name}};
519 print "Sorry, this is an unsupported DB\n";
523 $self->throw_exception($self->storage->_sqlt_version_error)
524 if (not $self->storage->_sqlt_version_ok);
526 my $db_tr = SQL::Translator->new({
529 parser_args => { dbh => $self->storage->dbh }
532 $db_tr->producer($db);
533 my $dbic_tr = SQL::Translator->new;
534 $dbic_tr->parser('SQL::Translator::Parser::DBIx::Class');
535 $dbic_tr->data($self);
536 $dbic_tr->producer($db);
538 $db_tr->schema->name('db_schema');
539 $dbic_tr->schema->name('dbic_schema');
541 # is this really necessary?
542 foreach my $tr ($db_tr, $dbic_tr) {
543 my $data = $tr->data;
544 $tr->parser->($tr, $$data);
547 my $diff = SQL::Translator::Diff::schema_diff($db_tr->schema, $db,
548 $dbic_tr->schema, $db,
549 { ignore_constraint_names => 1, ignore_index_names => 1, caseopt => 1 });
551 my $filename = $self->ddl_filename(
553 $self->schema_version,
554 $self->upgrade_directory,
558 if(!open($file, ">$filename"))
560 $self->throw_exception("Can't open $filename for writing ($!)");
566 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.\n";
570 sub _set_db_version {
575 my $version = $params->{version} ? $params->{version} : $self->schema_version;
576 my $vtable = $self->{vschema}->resultset('Table');
577 $vtable->create({ version => $version,
578 installed => strftime("%Y-%m-%d %H:%M:%S", gmtime())
585 my $file = shift || return;
588 open $fh, "<$file" or carp("Can't open upgrade file, $file ($!)");
589 my @data = split(/\n/, join('', <$fh>));
590 @data = grep(!/^--/, @data);
591 @data = split(/;/, join('', @data));
593 @data = grep { $_ && $_ !~ /^-- / } @data;
594 @data = grep { $_ !~ /^(BEGIN|BEGIN TRANSACTION|COMMIT)/m } @data;
600 my ($self, $rs) = @_;
603 $rs->search({ 1, 0 })->count;
605 return 0 if $@ || !defined $c;
615 Jess Robinson <castaway@desert-island.me.uk>
616 Luke Saunders <luke@shadowcatsystems.co.uk>
620 You may distribute this code under the same terms as Perl itself.