DBAdaptor.pm 10.9 KB
Newer Older
1
=pod
2 3 4

=head1 NAME

5
    Bio::EnsEMBL::Hive::DBSQL::DBAdaptor
6 7 8

=head1 SYNOPSIS

9
    my $db = Bio::EnsEMBL::Hive::DBSQL::DBAdaptor->new( -url => 'mysql://my_username:my_password@my_hostname:3306/my_hive_database' );
10 11

=head1 DESCRIPTION
12

13 14 15 16
    This object represents the handle for a Hive system enabled database

=head1 LICENSE

17
    Copyright [1999-2015] Wellcome Trust Sanger Institute and the EMBL-European Bioinformatics Institute
nwillhoft's avatar
nwillhoft committed
18
    Copyright [2016-2021] EMBL-European Bioinformatics Institute
19 20 21 22 23 24 25 26 27

    Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

         http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software distributed under the License
    is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and limitations under the License.
28 29 30

=head1 CONTACT

31
    Please subscribe to the Hive mailing list:  http://listserver.ebi.ac.uk/mailman/listinfo/ehive-users  to discuss Hive-related questions or to be notified of our updates
32 33 34 35 36 37 38

=cut


package Bio::EnsEMBL::Hive::DBSQL::DBAdaptor;

use strict;
39
use warnings;
40

41 42
use Scalar::Util qw(weaken);

43
use Bio::EnsEMBL::Hive;
44
use Bio::EnsEMBL::Hive::HivePipeline;
45
use Bio::EnsEMBL::Hive::DBSQL::DBConnection;
46
use Bio::EnsEMBL::Hive::DBSQL::SqlSchemaAdaptor;
47
use Bio::EnsEMBL::Hive::Utils ('throw');
48

49 50 51 52
use Bio::EnsEMBL::Hive::MetaParameters;
use Bio::EnsEMBL::Hive::PipelineWideParameters;
use Bio::EnsEMBL::Hive::ResourceClass;
use Bio::EnsEMBL::Hive::ResourceDescription;
53
use Bio::EnsEMBL::Hive::Analysis;
54 55 56
use Bio::EnsEMBL::Hive::AnalysisStats;
use Bio::EnsEMBL::Hive::AnalysisCtrlRule;
use Bio::EnsEMBL::Hive::DataflowRule;
57
use Bio::EnsEMBL::Hive::DataflowTarget;
58

59

60
sub new {
61 62
    my $class = shift @_;
    my %flags = @_;
63

64
    my ($dbc, $url, $reg_conf, $reg_type, $reg_alias, $species, $no_sql_schema_version_check)
65
        = delete @flags{qw(-dbconn -url -reg_conf -reg_type -reg_alias -species -no_sql_schema_version_check)};
66

67 68 69 70 71
    if ($url && $no_sql_schema_version_check) {
        #check to see if the url has been quoted. If so, move the quote
        #after the no_sql_schema_version_check
        $url =~ s/([\'\"]?)$/;no_sql_schema_version_check=1$1/;
    }
72

73 74 75 76 77
    if($reg_conf or $reg_alias) {   # need to initialize Registry even if $reg_conf is not really given
        require Bio::EnsEMBL::Registry;
        Bio::EnsEMBL::Registry->load_all($reg_conf);    # if undefined, default reg_conf will be used
    }

78 79 80
    my $self;

    if($url) {
81
        $dbc = Bio::EnsEMBL::Hive::DBSQL::DBConnection->new(-url => $url, %flags)
82 83
            or die "Unable to create a DBC using url='$url'";

84
    } elsif($reg_alias) {
85

86 87 88
        if($reg_alias=~/^(\w+):(\w+)$/) {
            ($reg_type, $reg_alias) = ($1, $2);
        }
89

90 91
        unless($reg_type) {     # if no $reg_type explicitly given, try to guess:
            my $dbas = Bio::EnsEMBL::Registry->get_all_DBAdaptors(-species => $reg_alias);
92

93 94 95
            if( scalar(@$dbas) == 1 ) {
                $self = $dbas->[0];
            } elsif( @$dbas ) {
96
                warn "The registry contains multiple entries for '$reg_alias', please prepend the reg_alias with the desired type\n";
97 98 99 100 101 102 103 104 105 106
            }
        }

        unless($self) {         # otherwise (or if not found) try a specific $reg_type
            $reg_type ||= 'hive';
            $self = Bio::EnsEMBL::Registry->get_DBAdaptor($reg_alias, $reg_type)
                or die "Unable to connect to DBA using reg_conf='$reg_conf', reg_type='$reg_type', reg_alias='$reg_alias'\n";
        }

        if( $self and !$self->isa($class) ) {   # if we found a non-Hive Registry entry, detach the $dbc and build a Hive dba around it:
107
            $dbc = $self->dbc;
108
            $self = undef;
109
        }
110 111
    }

112
    if($dbc && !$self) {
113
        $self = bless {}, $class;
114
        $self->dbc( $dbc );
115
    }
116 117

    unless($no_sql_schema_version_check) {
118 119

        my $dbc = $self->dbc();
120 121 122 123

        # Make a safe URL without affecting EHIVE_PASS, which could have been set by the user
        my $safe_url = $dbc->url('EHIVE_TMP_PASSWORD');
        $safe_url =~ s/EHIVE_TMP_PASSWORD/EHIVE_PASS/;
124 125

        my $code_sql_schema_version = Bio::EnsEMBL::Hive::DBSQL::SqlSchemaAdaptor->get_code_sql_schema_version()
126
            || die "DB($safe_url) Could not establish code_sql_schema_version, please check that 'EHIVE_ROOT_DIR' environment variable is set correctly";
127

128 129
        my $db_sql_schema_version   = eval { $self->get_MetaAdaptor->fetch_by_meta_key( 'hive_sql_schema_version' )->{'meta_value'}; };

130
        if($@) {
131
            if($@ =~ /hive_meta.*doesn't exist/) {
132

133
                die "\nDB($safe_url) The 'hive_meta' table does not seem to exist in the database yet.\nPlease patch the database up to sql_schema_version '$code_sql_schema_version' and try again.\n";
134 135 136

            } else {

137
                die "DB($safe_url) $@";
138
            }
139 140 141

        } elsif(!$db_sql_schema_version) {

142
            die "\nDB($safe_url) The 'hive_meta' table does not contain 'hive_sql_schema_version' entry.\nPlease investigate.\n";
143 144 145

        } elsif($db_sql_schema_version < $code_sql_schema_version) {

146
            my $new_patches = Bio::EnsEMBL::Hive::DBSQL::SqlSchemaAdaptor->get_sql_schema_patches( $db_sql_schema_version, $dbc->driver )
147
                || die "DB($safe_url) sql_schema_version mismatch: the database's version is '$db_sql_schema_version' but the code is already '$code_sql_schema_version'.\n"
148 149
                      ."Unfortunately we cannot patch the database; you may have to create a new database or agree to run older code\n";

150
            my $sql_patcher_command = "$ENV{'EHIVE_ROOT_DIR'}/scripts/db_cmd.pl -url $safe_url";
151

152
            die "DB($safe_url) sql_schema_version mismatch: the database's version is '$db_sql_schema_version' but the code is already '$code_sql_schema_version'.\n"
153 154 155
               ."Please upgrade the database by applying the following patches:\n\n"
               .join("\n", map { ($_=~/\.\w*sql\w*$/) ? "\t$sql_patcher_command < $_" : "$_ -url $safe_url" } @$new_patches)
               ."\n\nand try again.\n";
156 157 158

        } elsif($code_sql_schema_version < $db_sql_schema_version) {

159
            die "DB($safe_url) sql_schema_version mismatch: the database's version is '$db_sql_schema_version', but your code is still '$code_sql_schema_version'.\n"
160
               ."Please update the code and try again.\n";
161
        }
162
    }
163

164 165 166 167 168
    if($species) {      # [compatibility with core code] store the DBAdaptor in Registry:
        require Bio::EnsEMBL::Registry;
        Bio::EnsEMBL::Registry->add_DBAdaptor( $species, 'hive', $self );
    }

169
    return $self;
170 171 172
}


173 174 175 176
sub species {   # a stub to please Registry code
    return @_;
}

177 178 179 180
sub group {     # a stub to please Registry code
    return 'hive';
}

181

182
sub dbc {
183
    my $self = shift;
184

185
    $self->{'_dbc'} = bless shift, 'Bio::EnsEMBL::Hive::DBSQL::DBConnection' if(@_);
186

187
    return $self->{'_dbc'};
188 189 190
}


191 192 193 194 195 196
sub hive_pipeline {
    my $self = shift @_;
    if (@_) {
        $self->{'_hive_pipeline'} = shift @_;
    }
    unless ($self->{'_hive_pipeline'}) {
197
        $self->{'_hive_pipeline'} = Bio::EnsEMBL::Hive::HivePipeline->new( -dba => $self );     # ToDo: this lazy-loaded object is not registered in TheApiary (yet)
198 199 200 201 202
    }
    return $self->{'_hive_pipeline'};
}


203 204 205 206 207 208 209
our %adaptor_type_2_package_name = (
    'Accumulator'           => 'Bio::EnsEMBL::Hive::DBSQL::AccumulatorAdaptor',
    'Analysis'              => 'Bio::EnsEMBL::Hive::DBSQL::AnalysisAdaptor',
    'AnalysisCtrlRule'      => 'Bio::EnsEMBL::Hive::DBSQL::AnalysisCtrlRuleAdaptor',
    'AnalysisData'          => 'Bio::EnsEMBL::Hive::DBSQL::AnalysisDataAdaptor',
    'AnalysisJob'           => 'Bio::EnsEMBL::Hive::DBSQL::AnalysisJobAdaptor',
    'AnalysisStats'         => 'Bio::EnsEMBL::Hive::DBSQL::AnalysisStatsAdaptor',
210
    'Beekeeper'             => 'Bio::EnsEMBL::Hive::DBSQL::BeekeeperAdaptor',
211
    'DataflowRule'          => 'Bio::EnsEMBL::Hive::DBSQL::DataflowRuleAdaptor',
212
    'DataflowTarget'        => 'Bio::EnsEMBL::Hive::DBSQL::DataflowTargetAdaptor',
213 214
    'LogMessage'            => 'Bio::EnsEMBL::Hive::DBSQL::LogMessageAdaptor',
    'Meta'                  => 'Bio::EnsEMBL::Hive::DBSQL::MetaAdaptor',
215
    'PipelineWideParameters'=> 'Bio::EnsEMBL::Hive::DBSQL::PipelineWideParametersAdaptor',
216 217 218
    'NakedTable'            => 'Bio::EnsEMBL::Hive::DBSQL::NakedTableAdaptor',
    'ResourceClass'         => 'Bio::EnsEMBL::Hive::DBSQL::ResourceClassAdaptor',
    'ResourceDescription'   => 'Bio::EnsEMBL::Hive::DBSQL::ResourceDescriptionAdaptor',
219
    'Role'                  => 'Bio::EnsEMBL::Hive::DBSQL::RoleAdaptor',
220
    'Semaphore'             => 'Bio::EnsEMBL::Hive::DBSQL::SemaphoreAdaptor',
221 222 223 224 225
    'Queen'                 => 'Bio::EnsEMBL::Hive::Queen',

        # aliases:
    'Job'                   => 'Bio::EnsEMBL::Hive::DBSQL::AnalysisJobAdaptor',
    'Worker'                => 'Bio::EnsEMBL::Hive::Queen',
226
    'MetaParameters'        => 'Bio::EnsEMBL::Hive::DBSQL::MetaAdaptor',
227 228 229
);


Leo Gordon's avatar
Leo Gordon committed
230
sub get_available_adaptors {
231 232

    return \%adaptor_type_2_package_name;
233
}
234

235

236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
sub parse_underscored_id_name {
    my ($self, $underscored_id_name) = @_;

    my ($is_an_id, $foo_id_method_name, $foo_obj_method_name);

    my @syll = split(/_/, $underscored_id_name);
    if($syll[scalar(@syll)-1] eq 'id') {
        pop @syll;
        ($is_an_id, $foo_id_method_name, $foo_obj_method_name) = ( 1, $underscored_id_name, join('_', @syll) );
    } else {
        ($is_an_id, $foo_id_method_name, $foo_obj_method_name) = ( 0, $underscored_id_name .'_id' , $underscored_id_name );
    }

    my $AdaptorType = '';   # will be growing from right to left
    while(@syll) {
        $AdaptorType = ucfirst(pop @syll) . $AdaptorType;
        if(exists( $self->get_available_adaptors->{ $AdaptorType })) {
            return ($AdaptorType, $is_an_id, $foo_id_method_name, $foo_obj_method_name);
        }
    }
    return;   # could not parse
}


260 261
sub get_adaptor {
    my $self = shift;
262 263 264 265
    my $AdaptorType = shift;

    my $adaptor_package_name = $self->get_available_adaptors()->{$AdaptorType}
        or throw("Could not find a module corresponding to '$AdaptorType'");
266

267
    my $signature = join(':', $adaptor_package_name, @_);
268 269 270 271

    unless( $self->{'_cached_adaptor'}{$signature} ) {

        eval "require $adaptor_package_name"
272
        or throw("Could not load or compile module '$adaptor_package_name' because $@");
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291

        $self->{'_cached_adaptor'}{$signature} = $adaptor_package_name->new( $self, @_ );
    }

    return $self->{'_cached_adaptor'}{$signature};
}


sub DESTROY { }   # to simplify AUTOLOAD

sub AUTOLOAD {
    our $AUTOLOAD;

    my $type;
    if ( $AUTOLOAD =~ /^.*::get_(\w+)Adaptor$/ ) {
        $type = $1;
    } elsif ( $AUTOLOAD =~ /^.*::get_(\w+)$/ ) {
        $type = $1;
    } else {
292
        throw( "DBAdaptor::AUTOLOAD: Could not interpret the method: $AUTOLOAD" );
293 294 295 296 297 298 299
    }

    my $self = shift;

    return $self->get_adaptor($type, @_);
}

300

301
1;