use base 'DBIx::Class';
use POSIX 'strftime';
use Data::Dumper;
-# use DBIx::Class::Version;
__PACKAGE__->mk_classdata('_filedata');
__PACKAGE__->mk_classdata('upgrade_directory');
+__PACKAGE__->mk_classdata('backup_directory');
+__PACKAGE__->mk_classdata('do_backup');
-sub on_connect
+sub schema_version {
+ my ($self) = @_;
+ my $class = ref($self)||$self;
+ my $version;
+ {
+ no strict 'refs';
+ $version = ${"${class}::VERSION"};
+ }
+ return $version;
+}
+
+sub connection {
+ my $self = shift;
+ $self->next::method(@_);
+ $self->_on_connect;
+ return $self;
+}
+
+sub _on_connect
{
my ($self) = @_;
-# print "on_connect\n";
- my $vschema = DBIx::Class::Version->connect(@{$self->storage->connect_info()});
- my $vtable = $vschema->resultset('Table');
+ $self->{vschema} = DBIx::Class::Version->connect(@{$self->storage->connect_info()});
+ my $vtable = $self->{vschema}->resultset('Table');
my $pversion;
- if(!$self->exists($vtable))
+
+ if(!$self->_source_exists($vtable))
{
-# print "deploying.. \n";
- $vschema->storage->debug(1);
- $vschema->storage->ensure_connected();
-# print "Debugging is: ", $vschema->storage->debug, "\n";
- $vschema->deploy();
+# $self->{vschema}->storage->debug(1);
+ $self->{vschema}->storage->ensure_connected();
+ $self->{vschema}->deploy();
$pversion = 0;
}
else
{
- my $psearch = $vtable->search(undef,
- { select => [
- { 'max' => 'Installed' },
- ],
- as => ['maxinstall'],
- })->first;
- $pversion = $vtable->search({ Installed => $psearch->get_column('maxinstall'),
- })->first;
- $pversion = $pversion->Version if($pversion);
+ $pversion = $self->get_db_version();
}
# warn("Previous version: $pversion\n");
- if($pversion eq $self->VERSION)
+ if($pversion eq $self->schema_version)
{
warn "This version is already installed\n";
return 1;
}
-
- $vtable->create({ Version => $self->VERSION,
- Installed => strftime("%Y-%m-%d %H:%M:%S", gmtime())
- });
+## use IC::DT?
if(!$pversion)
{
- warn "No previous version found, skipping upgrade\n";
+ $vtable->create({ Version => $self->schema_version,
+ Installed => strftime("%Y-%m-%d %H:%M:%S", gmtime())
+ });
+ ## If we let the user do this, where does the Version table get updated?
+ warn "No previous version found, calling deploy to install this version.\n";
+ $self->deploy();
return 1;
}
-# $self->create_upgrades($self->upgrade_directoy, $pversion, $self->VERSION);
-
- my $file = $self->ddl_filename($self->upgrade_directory,
+ my $file = $self->ddl_filename(
$self->storage->sqlt_type,
- $self->VERSION
+ $self->upgrade_directory,
+ $self->schema_version
);
if(!$file)
{
return 1;
}
- $file =~ s/@{[ $self->VERSION ]}/"${pversion}-" . $self->VERSION/e;
+ $file = $self->ddl_filename(
+ $self->storage->sqlt_type,
+ $self->upgrade_directory,
+ $self->schema_version,
+ $pversion,
+ );
+# $file =~ s/@{[ $self->schema_version ]}/"${pversion}-" . $self->schema_version/e;
if(!-f $file)
{
warn "Upgrade not possible, no upgrade file found ($file)\n";
return;
}
-# print "Found Upgrade file: $file\n";
+
my $fh;
open $fh, "<$file" or warn("Can't open upgrade file, $file ($!)");
- my @data = split(/;\n/, join('', <$fh>));
+ my @data = split(/[;\n]/, join('', <$fh>));
close($fh);
@data = grep { $_ && $_ !~ /^-- / } @data;
@data = grep { $_ !~ /^(BEGIN TRANACTION|COMMIT)/m } @data;
-# print "Commands: ", join("\n", @data), "\n";
+
$self->_filedata(\@data);
- $self->backup();
- $self->upgrade($pversion, $self->VERSION);
+ ## Don't do this yet, do only on command?
+ ## If we do this later, where does the Version table get updated??
+ warn "Versions out of sync. This is " . $self->schema_version .
+ ", your database contains version $pversion, please call upgrade on your Schema.\n";
+# $self->upgrade($pversion, $self->schema_version);
+}
+sub get_db_version
+{
+ my ($self, $rs) = @_;
+
+ my $vtable = $self->{vschema}->resultset('Table');
+ my $psearch = $vtable->search(undef,
+ { select => [
+ { 'max' => 'Installed' },
+ ],
+ as => ['maxinstall'],
+ })->first;
+ my $pversion = $vtable->search({ Installed => $psearch->get_column('maxinstall'),
+ })->first;
+ $pversion = $pversion->Version if($pversion);
+ return $pversion;
}
-sub exists
+sub _source_exists
{
my ($self, $rs) = @_;
- eval {
+ my $c = eval {
$rs->search({ 1, 0 })->count;
};
- return 0 if $@;
+ return 0 if $@ || !defined $c;
return 1;
}
{
my ($self) = @_;
## Make each ::DBI::Foo do this
- $self->storage->backup();
+ $self->storage->backup($self->backup_directory());
}
sub upgrade
{
my ($self) = @_;
- ## overridable sub, per default just run all the commands.
+ $self->backup() if($self->do_backup);
+
+ $self->txn_do(sub {
+ $self->do_upgrade();
+ });
+
+ my $vtable = $self->{vschema}->resultset('Table');
+ $vtable->create({ Version => $self->schema_version,
+ Installed => strftime("%Y-%m-%d %H:%M:%S", gmtime())
+ });
+
+}
+
+sub do_upgrade
+{
+ my ($self) = @_;
+ ## overridable sub, per default just run all the commands.
$self->run_upgrade(qr/create/i);
$self->run_upgrade(qr/alter table .*? add/i);
$self->run_upgrade(qr/alter table .*? (?!drop)/i);
$self->run_upgrade(qr/alter table .*? drop/i);
$self->run_upgrade(qr/drop/i);
- $self->run_upgrade(qr//i);
}
-
sub run_upgrade
{
my ($self, $stm) = @_;
for (@statements)
{
- $self->storage->debugfh->print("$_\n") if $self->storage->debug;
-# print "Running \n>>$_<<\n";
+ $self->storage->debugobj->query_start($_) if $self->storage->debug;
$self->storage->dbh->do($_) or warn "SQL was:\n $_";
+ $self->storage->debugobj->query_end($_) if $self->storage->debug;
}
return 1;
}
+1;
+
=head1 NAME
-DBIx::Class::Versioning - DBIx::Class::Schema plugin for Schema upgrades
+DBIx::Class::Schema::Versioned - DBIx::Class::Schema plugin for Schema upgrades
=head1 SYNOPSIS
__PACKAGE__->load_components(qw/+DBIx::Class::Schema::Versioned/);
__PACKAGE__->upgrade_directory('/path/to/upgrades/');
+ __PACKAGE__->backup_directory('/path/to/backups/');
sub backup
{
path between the two versions supplied. By default, every change in
your VERSION is regarded as needing an upgrade.
+The actual upgrade is called manually by calling C<upgrade> on your
+schema object. Code is run at connect time to determine whether an
+upgrade is needed, if so, a warning "Versions out of sync" is
+produced.
+
NB: At the moment, SQLite upgrading is rather spotty, as SQL::Translator::Diff
returns SQL statements that SQLite does not support.
to call C<< $self->storage->backup >>, to run the standard backup on each
database type.
-This method should return the name of the backup file, if appropriate.
+This method should return the name of the backup file, if appropriate..
=head2 upgrade
+This is the main upgrade method which calls the overridable do_upgrade and
+also handles the backups and updating of the SchemaVersion table.
+
+=head2 do_upgrade
+
This is an overwritable method used to run your upgrade. The freeform method
allows you to run your upgrade any way you please, you can call C<run_upgrade>
any number of times to run the actual SQL commands, and in between you can
C<upgrade> method, running whichever commands you specify via the
regex in the parameter.
+=head2 upgrade_directory
+
+Use this to set the directory your upgrade files are stored in.
+
+=head2 backup_directory
+
+Use this to set the directory you want your backups stored in.
+
+=head2 schema_version
+
+Returns the current schema class' $VERSION; does -not- use $schema->VERSION
+since that varies in results depending on if version.pm is installed, and if
+so the perl or XS versions. If you want this to change, bug the version.pm
+author to make vpp and vxs behave the same.
+
=head1 AUTHOR
Jess Robinson <castaway@desert-island.demon.co.uk>
projects / dbsrgits/DBIx-Class.git / blobdiff