Registry.pm 65.1 KB
Newer Older
Ian Longden's avatar
Ian Longden committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
#
# Ensembl module for Registry
#
# Copyright EMBL/EBI
##
# You may distribute this module under the same terms as perl itself

# POD documentation - main docs before the code

=head1 NAME

Bio::EnsEMBL::Registry

=head1 SYNOPSIS

16
17
Bio::EnsEMBL::Registry->load_all("configuration_file");

18
19
$gene_adaptor =
  Bio::EnsEMBL::Registry->get_adaptor( "human", "core", "gene" );
Ian Longden's avatar
Ian Longden committed
20
21
22
23


=head1 DESCRIPTION

24
25
All Adaptors are stored/registered using this module. This module should
then be used to get the adaptors needed.
Ian Longden's avatar
Ian Longden committed
26

27
28
The registry can be loaded from a configuration file using the load_all
method.
Ian Longden's avatar
Ian Longden committed
29

30
31
32
33
If a filename is passed to load_all then this is used.  Else if the
enviroment variable ENSEMBL_REGISTRY is set to the name on an existing
configuration file, then this is used.  Else if the file .ensembl_init
in your home directory exist, it is used.
Ian Longden's avatar
Ian Longden committed
34

35
36
For the Web server ENSEMBL_REGISTRY should be set in SiteDefs.pm.  This
will then be passed on to load_all.
37
38


39
40
41
42
43
The registry can also be loaded via the method load_registry_from_db
which given a database host will load the latest versions of the Ensembl
databases from it.

The four types of registries are for db adaptors, dba adaptors, dna adaptors
Ian Longden's avatar
Ian Longden committed
44
45
46
47
and the standard type.

=head2 db

48
These are registries for backwards compatibility and enable the subroutines
49
to add other adaptors to connections. 
Ian Longden's avatar
Ian Longden committed
50
51
52
53
54

e.g. get_all_db_adaptors, get_db_adaptor, add_db_adaptor, remove_db_adaptor
are the old DBAdaptor subroutines which are now redirected to the Registry.

So if before we had
55
56

    my $sfa = $self->adaptor()->db()->get_db_adaptor('blast');
Ian Longden's avatar
Ian Longden committed
57
58

We now want to change this to
59
60
61

    my $sfa =
      Bio::EnsEMBL::Registry->get_adaptor( "human", "core", "blast" );
Ian Longden's avatar
Ian Longden committed
62
63
64
65
66
67
68
69
70


=head2 DBA

These are the stores for the DBAdaptors

The Registry will create all the DBConnections needed now if you set up the
configuration correctly. So instead of the old commands like

71
72
    my $db           = Bio::EnsEMBL::DBSQL::DBAdaptor->new(...);
    my $exon_adaptor = $db->get_ExonAdaptor;
Ian Longden's avatar
Ian Longden committed
73
74
75

we should now have just

76
77
    my $exon_adaptor =
      Bio::EnsEMBL::Registry->get_adaptor( "human", "core", "exon" );
Ian Longden's avatar
Ian Longden committed
78
79
80
81
82


=head2 DNA

This is an internal Registry and allows the configuration of a dnadb. 
Steve Trevanion's avatar
Steve Trevanion committed
83
An example here is to set the est database to get its dna data from the core database.
Ian Longden's avatar
Ian Longden committed
84

85
86
87
    ## set the est db to use the core for getting dna data.
    # Bio::EnsEMBL::Utils::ConfigRegistry->dnadb_add(
    #         "Homo Sapiens", "core", "Homo Sapiens", "est" );
Ian Longden's avatar
Ian Longden committed
88
89
90
91
92
93
94
95
96


=head2 adaptors

This is the registry for all the general types of adaptors like GeneAdaptor, ExonAdaptor, 
Slice Adaptor etc.

These are accessed by the get_adaptor subroutine i.e.

97
98
    my $exon_adaptor =
      Bio::EnsEMBL::Registry->get_adaptor( "human", "core", "exon" );
Ian Longden's avatar
Ian Longden committed
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

=head1 CONTACT

Post questions to the Ensembl developer list: <ensembl-dev@ebi.ac.uk>


=head1 METHODS

=cut


package Bio::EnsEMBL::Registry;

use strict;

114
use Bio::EnsEMBL::DBSQL::DBAdaptor;
Ian Longden's avatar
Ian Longden committed
115
116
use Bio::EnsEMBL::Utils::Exception qw( deprecate throw warning );
use Bio::EnsEMBL::Utils::Argument qw(rearrange);
117
use Bio::EnsEMBL::Utils::ConfigRegistry;
118
use DBI;
Ian Longden's avatar
Ian Longden committed
119
120
121

use vars qw(%registry_register);

Glenn Proctor's avatar
Glenn Proctor committed
122
my $API_VERSION = 50;
Ian Longden's avatar
Ian Longden committed
123
124

=head2 load_all
125

126
127
128
129
130
131
132
133
 Will load the registry with the configuration file which is obtained
 from the first in the following and in that order.

  1) If an argument is passed to this method, this is used as the name
     of the configuration file to read.

  2) If the enviroment variable ENSEMBL_REGISTRY is set, this is used as
     the name of the configuration file to read.
Ian Longden's avatar
Ian Longden committed
134

135
136
  3) If the file .ensembl_init exist in the home directory, it is used
     as the configuration file.
Ian Longden's avatar
Ian Longden committed
137

138
139
140
141
142
143
144
145
  Arg [1]    : (optional) string
               Name of file to load the registry from.
  Arg [2]    : (optional) integer
               If not 0, will print out all information.
  Arg [3]    : (optional) integer
               If not 0, the db connection will not be cleared, if 0 or
               if not set the db connections will be cleared (this is
               the default).
Ian Longden's avatar
Ian Longden committed
146
147
148
  Example    : Bio::EnsEMBL::Registry->load_all();
  Returntype : none
  Exceptions : none
149
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
150
151

=cut
152

153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
sub load_all {
    my $class = shift;
    my ( $config_file, $verbose, $no_clear ) = @_;

    $config_file ||= $ENV{ENSEMBL_REGISTRY}
      || $ENV{HOME} . "/.ensembl_init";

    $verbose  ||= 0;
    $no_clear ||= 0;

    if ( !defined($config_file) ) {
        if ($verbose) {
            print( STDERR
                   "No default registry configuration to load.\n" );
        }
    } elsif ( !-e $config_file ) {
        if ($verbose) {
            printf( STDERR "Configuration file '%s' does not exist. "
                      . "Registry configuration not loaded.\n",
                    $config_file );
        }
    } else {
        if ( defined( $registry_register{'seen'} ) ) {
            if ( !$no_clear ) {
                if ($verbose) {
                    print( STDERR "Clearing previously loaded "
                           . "registry configuration\n" );
                }
                $class->clear();
            }
        }
        $registry_register{'seen'} = 1;

        if ($verbose) {
            printf( STDERR
                      "Loading registry configuration from '%s'.\n",
                    $config_file );
        }

192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
        my $cfg;

        eval { require Config::IniFiles };
        if ($@) {
          # The user does not have the 'Config::IniFiles' module.
          if ($verbose) {
            print( STDERR "No Config::IniFiles module found, "
                   . "assuming this is not an ini-file\n" );
          }
          # If the configuration file *is* an ini-file, we can expect a
          # load of compilation errors from the next eval...
        } else {
          # The user has the 'Config::IniFiles' module installed.  See
          # if this is an ini-file or not...
          $cfg = Config::IniFiles->new( -file => $config_file );
        }
208

209
        if ( defined $cfg ) {
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
            # This is a map from group names to Ensembl DB adaptors.
            my %group2adaptor = (
                 'blast'   => 'Bio::EnsEMBL::External::BlastAdaptor',
                 'compara' => 'Bio::EnsEMBL::Compara::DBSQL::DBAdaptor',
                 'core'    => 'Bio::EnsEMBL::DBSQL::DBAdaptor',
                 'estgene' => 'Bio::EnsEMBL::DBSQL::DBAdaptor',
                 'funcgen' => 'Bio::EnsEMBL::Funcgen::DBSQL::DBAdaptor',
                 'haplotype' =>
                   'Bio::EnsEMBL::ExternalData::Haplotype::DBAdaptor',
                 'hive' => 'Bio::EnsEMBL::Hive::DBSQL::DBAdaptor',
                 'lite' => 'Bio::EnsEMBL::Lite::DBAdaptor',
                 'otherfeatures' => 'Bio::EnsEMBL::DBSQL::DBAdaptor',
                 'pipeline' =>
                   'Bio::EnsEMBL::Pipeline::DBSQL::DBAdaptor',
                 'snp' =>
                   'Bio::EnsEMBL::ExternalData::SNPSQL::DBAdaptor',
                 'variation' =>
                   'Bio::EnsEMBL::Variation::DBSQL::DBAdaptor',
                 'vega' => 'Bio::EnsEMBL::DBSQL::DBAdaptor' );

            my %default_adaptor_args = ();

            if ( $cfg->SectionExists('default') ) {
                # The 'default' section is special.  It contain default
                # values that should be implicit to all other section in
235
236
237
238
239
240
241
242
243
244
245
246
247
                # this configuration file.  Aliases are added if there
                # is also a 'species' setting.

                my $alias = $cfg->val( 'default', 'alias' );
                $cfg->delval( 'default', 'alias' );

                my $species = $cfg->val( 'default', 'species' );

                if ( defined($alias) && defined($species) ) {
                    Bio::EnsEMBL::Utils::ConfigRegistry->add_alias(
                                     -species => $species,
                                     -alias => [ split( /\n/, $alias ) ]
                    );
248
                }
249

250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
                %default_adaptor_args =
                  map { '-' . $_ => $cfg->val( 'default', $_ ) }
                  $cfg->Parameters('default');
            }

            foreach my $section ( $cfg->Sections() ) {
                if ( $section eq 'default' )
                {    # We have already done the 'default' section.
                    next;
                }

                my $group = $cfg->val( $section, 'group' )
                  || $cfg->val( 'default', 'group' );

                if ( !defined($group) ) {
                    printf( STDERR "Key 'group' is undefined "
                              . "for configuration section '%s', "
                              . "skipping this section.\n",
                            $section );
                    next;
                }

                my $adaptor = $group2adaptor{ lc($group) };
                if ( !defined($adaptor) ) {
                    printf( STDERR "Unknown group '%s' "
                              . "for configuration section '%s', "
                              . "skipping this section.\n",
                            $group, $section );
                    next;
                }

281
282
283
284
285
                # Handle aliases.  A section must have both an 'alias'
                # setting and a 'species' setting for aliases to be
                # added.  The 'species' setting might be inherited from
                # the 'default' section.

286
287
288
                my $alias = $cfg->val( $section, 'alias' );
                $cfg->delval( $section, 'alias' );

289
290
291
292
293
294
295
296
297
298
299
                my $species = $cfg->val( $section, 'species' )
                  || $cfg->val( 'default', 'species' );

                if ( defined($alias) && defined($species) ) {
                    Bio::EnsEMBL::Utils::ConfigRegistry->add_alias(
                                     -species => $species,
                                     -alias => [ split( /\n/, $alias ) ]
                    );
                }

                # Fill in the adaptor initialization arguments.
300
301
302
303
304
305
306
307
308
309
310
311
312
                # We trust the user to provide sensible key-value pairs.
                my %adaptor_args = %default_adaptor_args;
                foreach my $parameter ( $cfg->Parameters($section) ) {
                    $adaptor_args{ '-' . $parameter } =
                      $cfg->val( $section, $parameter );
                }

                if ($verbose) {
                    printf( "Configuring adaptor '%s' "
                              . "for configuration section '%s'...\n",
                            $adaptor, $section );
                }

313
314
315
                eval "require $adaptor";
                if ($@) { die($@) }

316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
                $adaptor->new(%adaptor_args);

            } ## end foreach my $section ( $cfg->Sections...
        } else {
            # This is probably no ini-file but an old style piece
            # of configuration written in Perl.  We need to try to
            # require() it.

            eval { require($config_file) };
            if ($@) { die($@) }

            # To make the web code avoid doing this again:
            delete $INC{$config_file};
        }
    } ## end else [ if ( !defined($config_file...
331
} ## end sub load_all
332
333

=head2 clear
334

335
336
337
338
339
 Will clear the registry and disconnect from all databases.

  Example    : Bio::EnsEMBL::Registry->clear();
  Returntype : none
  Exceptions : none
340
  Status     : Stable
341
342
343
344
345
346
347
348
349
350
351

=cut

sub clear{
  my ($self);
  
  foreach my $dba (@{$registry_register{'_DBA'}}){
    if($dba->dbc->connected){
      $dba->dbc->db_handle->disconnect();
    }
  }
Ian Longden's avatar
Ian Longden committed
352
  %registry_register = ();
Ian Longden's avatar
Ian Longden committed
353
354
355
}

#
356
# db adaptors. (for backwards compatibility)
Ian Longden's avatar
Ian Longden committed
357
358
359
360
#

=head2 add_db

361
  Arg [1]    : db (DBAdaptor) to add adaptor to.
Ian Longden's avatar
Ian Longden committed
362
363
364
365
366
  Arg [2]    : name of the name to add the adaptor to in the registry.
  Arg [3]    : The adaptor to be added to the registry.
  Example    : Bio::EnsEMBL::Registry->add_db($db, "lite", $dba);
  Returntype : none
  Exceptions : none
367
  Status     : At Risk.
368
             : This is here for backwards compatibility only and may be removed 
369
370
371
             : eventually. Solution is to make sure the db and the adaptor have
             : the same species and the call is then no longer needed.
             
Ian Longden's avatar
Ian Longden committed
372
373
374
375
376
377
=cut

sub add_db{
  my ($class, $db, $name, $adap) = @_;


378
379
  if(lc($db->species()) ne lc($adap->species)){
    $registry_register{lc($db->species())}{lc($db->group())}{'_special'}{lc($name)} = $adap;
380
  }
Ian Longden's avatar
Ian Longden committed
381
382
383
384
}

=head2 remove_db

385
  Arg [1]    : db (DBAdaptor) to remove adaptor from.
Ian Longden's avatar
Ian Longden committed
386
387
388
389
  Arg [2]    : name to remove the adaptor from in the registry.
  Example    : my $db = Bio::EnsEMBL::Registry->remove_db($db, "lite");
  Returntype : adaptor
  Exceptions : none
390
  Status     : At Risk.
391
             : This is here for backwards compatibility only and may be removed 
392
393
             : eventually. Solution is to make sure the db and the adaptor have
             : the same species and the call is then no longer needed.
Ian Longden's avatar
Ian Longden committed
394
395
396
397
398
399

=cut

sub remove_db{
  my ($class, $db, $name) = @_;

400
401
  my $ret = $registry_register{lc($db->species())}{lc($db->group())}{'_special'}{lc($name)};
  $registry_register{lc($db->species())}{lc($db->group())}{'_special'}{lc($name)} = undef;
Ian Longden's avatar
Ian Longden committed
402
403
404
405
406
407

  return $ret;
}

=head2 get_db

408
  Arg [1]    : db (DBAdaptor) to get adaptor from.
Ian Longden's avatar
Ian Longden committed
409
410
411
412
  Arg [2]    : name to get the adaptor for in the registry.
  Example    : my $db = Bio::EnsEMBL::Registry->get_db("Human", "core", "lite");
  Returntype : adaptor
  Exceptions : none
413
  Status     : At Risk.
414
             : This is here for backwards compatibility only and may be removed 
415
416
             : eventually. Solution is to make sure the db and the adaptor have
             : the same species then call get_DBAdaptor instead.
Ian Longden's avatar
Ian Longden committed
417
418
419
420
421
422

=cut

sub get_db{
  my ($class, $db, $name) = @_;

423
  my $ret = Bio::EnsEMBL::Registry->get_DBAdaptor(lc($db->species),lc($name));
424
425
426
427

  if(defined($ret)){
    return $ret;
  }
428
  return $registry_register{lc($db->species())}{lc($db->group())}{'_special'}{lc($name)};
Ian Longden's avatar
Ian Longden committed
429
430
431
432
}

=head2 get_all_db_adaptors

433
  Arg [1]    : db (DBAdaptor) to get all the adaptors from.
Ian Longden's avatar
Ian Longden committed
434
435
436
  Example    : my $db = Bio::EnsEMBL::Registry->get_all_db_adaptors($db);
  Returntype : adaptor
  Exceptions : none
437
  Status     : At Risk.
438
             : This is here for backwards compatibility only and may be removed 
439
440
441
             : eventually. Solution is to make sure the dbs all have
             : the same species then call get_all_DBAdaptors(-species => "human");

Ian Longden's avatar
Ian Longden committed
442
443
444
445
446
447
448

=cut

sub get_all_db_adaptors{
  my ($class,$db) = @_;
  my %ret=();

Ian Longden's avatar
Ian Longden committed
449
450
451
452
# we now also want to add all the DBAdaptors for the same species.
# as add_db_adaptor does not add if it is from the same species.

  foreach my $dba (@{$registry_register{'_DBA'}}){
453
    if(lc($dba->species()) eq lc($db->species())){
Ian Longden's avatar
Ian Longden committed
454
455
456
457
      $ret{$dba->group()} = $dba;
    } 
  }

458
 foreach my $key (keys %{$registry_register{$class->get_alias($db->species())}{lc($db->group())}{'_special'}}){
459
   $ret{$key} = $registry_register{$class->get_alias($db->species())}{lc($db->group())}{'_special'}{$key};
Ian Longden's avatar
Ian Longden committed
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 }

  return \%ret;
}


#
# DBAdaptors
#

=head2 add_DBAdaptor

  Arg [1]    : name of the species to add the adaptor to in the registry.
  Arg [2]    : name of the group to add the adaptor to in the registry.
  Arg [3]    : The DBAaptor to be added to the registry.
  Example    : Bio::EnsEMBL::Registry->add_DBAdaptor("Human", "core", $dba);
  Returntype : none
  Exceptions : none
478
479
  caller     : internal
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
480
481
482
483
484
485

=cut

sub add_DBAdaptor{
  my ($class, $species, $group, $adap) = @_;

486
487
488
489
490
  if(!($class->alias_exists($species))){
    $class->add_alias($species,$species);
  }
  

Ian Longden's avatar
Ian Longden committed
491
492
  $species = $class->get_alias($species);

493
  $registry_register{$species}{lc($group)}{'_DB'} = $adap;
Ian Longden's avatar
Ian Longden committed
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514

  if(!defined($registry_register{'_DBA'})){
    my @list =();
    push(@list,$adap);
    $registry_register{'_DBA'}= \@list;
  }
  else{
    push(@{$registry_register{'_DBA'}},$adap);
  }

}



=head2 get_DBAdaptor

  Arg [1]    : name of the species to get the adaptor for in the registry.
  Arg [2]    : name of the group to get the adaptor for in the registry.
  Example    : $dba = Bio::EnsEMBL::Registry->get_DBAdaptor("Human", "core");
  Returntype : DBAdaptor
  Exceptions : none
515
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
516
517
518
519
520
521
522
523

=cut

sub get_DBAdaptor{
  my ($class, $species, $group) = @_;

  $species = $class->get_alias($species);

524
525
  return  $registry_register{$species}{lc($group)}{'_DB'};

Ian Longden's avatar
Ian Longden committed
526
527
528
529
}

=head2 get_all_DBAdaptors

530
531
532
533
534
535
536
537
  Arg [SPECIES]: (optional) string 
                  species name to get adaptors for
  Arg [GROUP]  : (optional) string 
                  group name to get adaptors for
  Example      : @dba = @{Bio::EnsEMBL::Registry->get_all_DBAdaptors()};
               : @human_dbas = @{Bio::EnsEMBL::Registry->get_all_DBAdaptors(-species => 'human')};
  Returntype   : list of DBAdaptors
  Exceptions   : none
538
  Status       : Stable
Ian Longden's avatar
Ian Longden committed
539
540
541
542

=cut

sub get_all_DBAdaptors{
543
544
  my ($class,@args)=@_;
  my @ret;
Ian Longden's avatar
Ian Longden committed
545

546
547
548
549
550
551
  my ($species, $group) = 
    rearrange([qw(SPECIES GROUP)], @args);
  if(defined($species)){
    $species = $class->get_alias($species);
  }
  foreach my $dba (@{$registry_register{'_DBA'}}){
552
    if(!defined($species) || lc($species) eq lc($dba->species)){
553
554
555
556
557
558
559
560
      if(!defined($group) || lc($group) eq lc($dba->group)){
	push @ret, $dba;
      }
    }
  }


  return \@ret;
Ian Longden's avatar
Ian Longden committed
561
562
}

563
564
565
566
567
568
=head2 get_all_DBAdaptors_by_connection

  Arg [1]    :dbconnection to use to find DBAdaptors
  Returntype : reference to list of DBAdaptors
  Exceptions : none.
  Example    : @dba = @{Bio::EnsEMBL::Registry->get_all_DBAdaptors_by_connection($dbc);
569
  Status     : Stable
570
571
572
573
574
575
576
577
578

=cut

sub get_all_DBAdaptors_by_connection{
  my ($self, $dbc_orig) = @_;
  my @return;

  foreach my $dba ( @{$registry_register{'_DBA'}}){
    my $dbc = $dba->dbc;
Web Admin's avatar
Web Admin committed
579
    if($dbc && $dbc->can('equals') && $dbc->equals($dbc_orig)){
580
581
582
583
584
585
      push @return, $dba;
    }
  }
  return \@return;
}

586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
=head2 remove_DBAdaptor

  Arg [1]    : name of the species to get the adaptor for in the registry.
  Arg [2]    : name of the group to get the adaptor for in the registry.
  Example    : $dba = Bio::EnsEMBL::Registry->remove_DBAdaptor("Human", "core");
  Returntype : none
  Exceptions : none
  Status     : At risk

=cut

sub remove_DBAdaptor{
  my ($class, $species, $group) = @_;

  $species = $class->get_alias($species);
Nathan Johnson's avatar
Nathan Johnson committed
601
602
  
 
603
  delete $registry_register{$species}{$group};
604
  # This will remove the DBAdaptor and all the other adaptors
605

606
  # Now remove if from the _DBA array
607
608
  my $index;

Nathan Johnson's avatar
Nathan Johnson committed
609

610
611
  foreach my $i(0..$#{$registry_register{'_DBA'}}){
    my $dba = $registry_register{'_DBA'}->[$i];
Nathan Johnson's avatar
Nathan Johnson committed
612

613
614
615
    if(($dba->species eq $species) &&
       $dba->group eq $group){
      $index = $i;
Nathan Johnson's avatar
Nathan Johnson committed
616

617
618
619
620
      last;
    }
  }
  
621
  # Now remove from _DBA cache
Nathan Johnson's avatar
Nathan Johnson committed
622
623
  splice(@{$registry_register{'_DBA'}}, $index, 1);

624
625
626
  return;
}

627

Nathan Johnson's avatar
Nathan Johnson committed
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646

=head2 reset_DBAdaptor

  Arg [1]:     string - species e.g. homo_sapiens
  Arg [2]:     string - DB group e.g. core
  Arg [3]:     string - new dbname
  Args [4-7]:  string - optional DB parameters, defaults to current db params if omitted
  Usage :      $reg->reset_registry_db('homo_sapiens', 'core', 'homo_sapiens_core_37_35j');
  Description: Resets a DB within the registry.
  Exceptions:  Throws if mandatory params not supplied
               Throws if species name is not already seen by the registry
               Throws if no current DB for species/group available
  Status :     At risk

=cut

sub reset_DBAdaptor{
  my ($self, $species, $group, $dbname, $host, $port, $user, $pass) = @_;

647
  # Check mandatory params
Nathan Johnson's avatar
Nathan Johnson committed
648
649
650
651
  if(! (defined $species && defined $group && defined $dbname)){
	throw('Must provide at least a species, group and dbname parmeter to redefine a DB in the registry');
  }
  
652
  # Validate species here
Nathan Johnson's avatar
Nathan Johnson committed
653
654
655
656
  my $alias = $self->get_alias($species);
  throw("Could not find registry alias for species:\t$species") if(! defined $alias);
 

657
  # Get all current defaults if not defined
Nathan Johnson's avatar
Nathan Johnson committed
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
  my $current_db = $self->get_DBAdaptor($alias, $group);
  
  if(! defined $current_db){
	throw("There is not current registry DB for:\t${alias}\t${group}");
  }


  $host ||= $current_db->dbc->host;
  $port ||= $current_db->dbc->port;
  $user ||= $current_db->dbc->username;
  $pass ||= $current_db->dbc->password;
  my $class = ref($current_db);

  $self->remove_DBAdaptor($alias, $group);
  
Nathan Johnson's avatar
Nathan Johnson committed
673
674
  my @adaptors = @{$self->get_all_adaptors};

Nathan Johnson's avatar
Nathan Johnson committed
675

676
  # ConfigRegistry should automatically add this to the Registry
Nathan Johnson's avatar
Nathan Johnson committed
677
678
679
680
681
682
683
684
685
686
687
688
689
690
  my $db = $class->new(
					   -user => $user,
					   -host => $host,
					   -port => $port,
					   -pass => $pass,
					   -dbname => $dbname,
					   -species => $alias,
					   -group    => $group,
					  );

  return $db;
}


Ian Longden's avatar
Ian Longden committed
691
692
693
694
695
696
697
698
#
# DNA Adaptors
#

=head2 add_DNAAdaptor

  Arg [1]    : name of the species to add the adaptor to in the registry.
  Arg [2]    : name of the group to add the adaptor to in the registry.
699
700
701
  Arg [3]    : name of the species to get the dna from
  Arg [4]    : name of the group to get the dna from
  Example    : Bio::EnsEMBL::Registry->add_DNAAdaptor("Human", "estgene", "Human", "core");
Ian Longden's avatar
Ian Longden committed
702
703
  Returntype : none
  Exceptions : none
704
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
705
706
707
708

=cut

sub add_DNAAdaptor{
Ian Longden's avatar
Ian Longden committed
709
  my ($class, $species, $group, $dnadb_species, $dnadb_group) = @_;
Ian Longden's avatar
Ian Longden committed
710
711

  $species = $class->get_alias($species);
712
  $dnadb_species = $class->get_alias($dnadb_species);
713
  if($dnadb_group->isa('Bio::EnsEMBL::DBSQL::DBAdaptor')){
Ian Longden's avatar
Ian Longden committed
714
    deprecated("");
715
716
  }
  else{
717
718
    $registry_register{$species}{lc($group)}{'_DNA'} = $dnadb_group;
    $registry_register{$species}{lc($group)}{'_DNA2'} = $dnadb_species;
719
  }
Ian Longden's avatar
Ian Longden committed
720
721
722
723
724
725
726
727
728
}

=head2 get_DNAAdaptor

  Arg [1]    : name of the species to get the adaptor for in the registry.
  Arg [2]    : name of the group to get the adaptor for in the registry.
  Example    : $dnaAdap = Bio::EnsEMBL::Registry->get_DNAAdaptor("Human", "core");
  Returntype : adaptor
  Exceptions : none
729
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
730
731
732
733
734
735
736

=cut

sub get_DNAAdaptor{
  my ($class, $species, $group) = @_;

  $species = $class->get_alias($species);
737
738
  my $new_group = $registry_register{$species}{lc($group)}{'_DNA'};
  my $new_species = $registry_register{$species}{lc($group)}{'_DNA2'};
739
  if( defined $new_group ) {
Ian Longden's avatar
Ian Longden committed
740
    return  $class->get_DBAdaptor($new_species,$new_group);
741
742
743
  } else {
    return undef;
  }
Ian Longden's avatar
Ian Longden committed
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
}

#
# General Adaptors
#

=head2 add_adaptor

  Arg [1]    : name of the species to add the adaptor to in the registry.
  Arg [2]    : name of the group to add the adaptor to in the registry.
  Arg [3]    : name of the type to add the adaptor to in the registry.
  Arg [4]    : The DBAaptor to be added to the registry.
  Arg [5]    : (optional) if set okay to overwrite.
  Example    : Bio::EnsEMBL::Registry->add_adaptor("Human", "core", "Gene", $adap);
  Returntype : none
  Exceptions : none
760
761
  Caller     : internal
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
762
763
764
765


=cut

766
767
sub add_adaptor {
  my ( $class, $species, $group, $type, $adap, $reset ) = @_;
Ian Longden's avatar
Ian Longden committed
768
769
770

  $species = $class->get_alias($species);

771
772
773
774
775
  # Since the adaptors are not stored initially, only their class paths
  # when the adaptors are obtained, we need to store these instead.  It
  # is not necessarily an error if the registry is overwritten without
  # the reset set but it is an indication that we are overwriting a
  # database which should be a warning for now
Ian Longden's avatar
Ian Longden committed
776

777
778
779
  if ( defined($reset) )
  {    # JUST REST THE HASH VALUE NO MORE PROCESSING NEEDED
    $registry_register{$species}{ lc($group) }{ lc($type) } = $adap;
Ian Longden's avatar
Ian Longden committed
780
781
    return;
  }
782
783
784
785
786
787
788
  if (
    defined( $registry_register{$species}{ lc($group) }{ lc($type) } ) )
  {
  # print STDERR (
  #      "Overwriting Adaptor in Registry for $species $group $type\n");
    $registry_register{$species}{ lc($group) }{ lc($type) } = $adap;
    return;
Ian Longden's avatar
Ian Longden committed
789
  }
790
  $registry_register{$species}{ lc($group) }{ lc($type) } = $adap;
Ian Longden's avatar
Ian Longden committed
791

792
793
794
795
  if ( !defined( $registry_register{$species}{'list'} ) ) {
    $registry_register{$species}{'list'} = [$type];
  } else {
    push( @{ $registry_register{$species}{'list'} }, $type );
Ian Longden's avatar
Ian Longden committed
796
797
  }

798
799
800
801
  if ( !defined( $registry_register{ lc($type) }{$species} ) ) {
    $registry_register{ lc($type) }{$species} = [$type];
  } else {
    push( @{ $registry_register{ lc($type) }{$species} }, $adap );
Ian Longden's avatar
Ian Longden committed
802
803
  }

804
} ## end sub add_adaptor
Ian Longden's avatar
Ian Longden committed
805
806
807
808
809
810
811
812
813
814


=head2 get_adaptor

  Arg [1]    : name of the species to add the adaptor to in the registry.
  Arg [2]    : name of the group to add the adaptor to in the registry.
  Arg [3]    : name of the type to add the adaptor to in the registry.
  Example    : $adap = Bio::EnsEMBL::Registry->get_adaptor("Human", "core", "Gene");
  Returntype : adaptor
  Exceptions : none
815
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
816
817
818
819
820
821

=cut

sub get_adaptor{
  my ($class,$species,$group,$type)= @_;
 
822
  $species = $class->get_alias($species);
823
  my %dnadb_adaptors = qw(sequence  1 assemblymapper 1  karyotypeband 1 repeatfeature 1 coordsystem 1  assemblyexceptionfeature 1 );
824

825
  my $dnadb_group =  $registry_register{$species}{lc($group)}{_DNA};
826

827
828
  if( defined($dnadb_group) && defined($dnadb_adaptors{lc($type)}) ) {
      $species = $registry_register{$species}{lc($group)}{'_DNA2'};
829
      $group = $dnadb_group;
Ian Longden's avatar
Ian Longden committed
830
831
  }

832
833
834
  my $ret = $registry_register{$species}{ lc($group) }{ lc($type) };
  if ( !defined($ret) ) { return undef; }

Ian Longden's avatar
Ian Longden committed
835
  if(!ref($ret)){ # not instantiated yet
836
    my $dba = $registry_register{$species}{lc($group)}{'_DB'};
Ian Longden's avatar
Ian Longden committed
837
838
839
840
841
842
843
    my $module = $ret;
    eval "require $module";

    if($@) {
      warning("$module cannot be found.\nException $@\n");
      return undef;
    }
844
845
846
847
    if(!defined($registry_register{$species}{lc($group)}{'CHECKED'})){
      $registry_register{$species}{lc($group)}{'CHECKED'} = 1;
      $class->version_check($dba);
    }
Ian Longden's avatar
Ian Longden committed
848
849
850
851
852
853
854
855
856
857
    my $adap = "$module"->new($dba);
    Bio::EnsEMBL::Registry->add_adaptor($species, $group, $type, $adap, "reset");
    $ret = $adap;
  }

  return $ret;
}

=head2 get_all_adaptors

858
859
860
861
862
863
  Arg [SPECIES] : (optional) string 
                  species name to get adaptors for
  Arg [GROUP] : (optional) string 
                  group name to get adaptors for
  Arg [TYPE] : (optional) string 
                  type to get adaptors for
Ian Longden's avatar
Ian Longden committed
864
  Example    : @adaps = @{Bio::EnsEMBL::Registry->get_all_adaptors()};
865
  Returntype : ref to list of adaptors
Ian Longden's avatar
Ian Longden committed
866
  Exceptions : none
867
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
868
869
870
871

=cut

sub get_all_adaptors{
872
873
874
875
  my ($class,@args)= @_;
  my ($species, $group, $type);
  my @ret=();
  my (%species_hash, %group_hash, %type_hash);
Ian Longden's avatar
Ian Longden committed
876

877

878
  if(@args == 1){ # Old species only one parameter
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
    warn("-SPECIES argument should now be used to get species adaptors");
    $species = $args[0];
  }
  else{
    # new style -SPECIES, -GROUP, -TYPE
    ($species, $group, $type) =
      rearrange([qw(SPECIES GROUP TYPE)], @args);
  }

  if(defined($species)){
    $species_hash{$species} = 1;
  }
  else{
    # get list of species
    foreach my $dba (@{$registry_register{'_DBA'}}){
      $species_hash{lc($dba->species())} = 1;
    }
  }
  if(defined($group)){
    $group_hash{$group} = 1;
  }
  else{
    foreach my $dba (@{$registry_register{'_DBA'}}){
      $group_hash{lc($dba->group())} = 1;
    }
  }
  if(defined($type)){
    $type_hash{$type} =1;
  }
  else{
    foreach my $dba (@{$registry_register{'_DBA'}}){ 
910
	foreach my $ty (@{$registry_register{lc($dba->species)}{'list'}}){
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
	  $type_hash{lc($ty)} = 1;
	}
      }
  }
  
  ### NOW NEED TO INSTANTIATE BY CALLING get_adaptor
  foreach my $sp (keys %species_hash){
    foreach my $gr (keys %group_hash){
      foreach my $ty (keys %type_hash){
	my $temp = $class->get_adaptor($sp,$gr,$ty);
	if(defined($temp)){
	  push @ret, $temp;
	}
      }
    }
  }
  return (\@ret);
Ian Longden's avatar
Ian Longden committed
928
929
930
931
932
933
934
935
936
937
938
}


=head2 add_alias

  Arg [1]    : name of the species to add alias for
  Arg [2]    : name of the alias
  Example    : Bio::EnsEMBL::Registry->add_alias("Homo Sapiens","Human");
  Description: add alternative name for the species.
  Returntype : none
  Exceptions : none
939
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
940
941
942
943
944
945

=cut

sub add_alias{
  my ($class, $species,$key) = @_;

946
  $registry_register{'_ALIAS'}{lc($key)} = lc($species);
Ian Longden's avatar
Ian Longden committed
947
948
949
950
951
952
953
954
}

=head2 get_alias

  Arg [1]    : name of the possible alias to get species for
  Example    : Bio::EnsEMBL::Registry->get_alias("Human");
  Description: get proper species name.
  Returntype : species name
955
  Exceptions : none
956
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
957
958
959
960

=cut

sub get_alias{
961
  my ($class, $key) = @_;
Ian Longden's avatar
Ian Longden committed
962

963
  if(!defined($registry_register{'_ALIAS'}{lc($key)})){
964
    return $key;
Ian Longden's avatar
Ian Longden committed
965
  }
966
  return $registry_register{'_ALIAS'}{lc($key)};
Ian Longden's avatar
Ian Longden committed
967
}
968
969
970
971

=head2 alias_exists

  Arg [1]    : name of the possible alias to get species for
Ian Longden's avatar
Ian Longden committed
972
  Example    : Bio::EnsEMBL::Registry->alias_exists("Human");
973
974
975
  Description: does the species name exist.
  Returntype : 1 if exists else 0
  Exceptions : none
976
  Status     : Stable
977
978
979
980
981
982

=cut

sub alias_exists{
  my ($class, $key) = @_;

983
  if(defined($registry_register{'_ALIAS'}{lc($key)})){
984
985
986
987
    return 1;
  }
  return 0;
}
988

989
990
991
992
993
994
995
=head2 set_disconnect_when_inactive

  Example    : Bio::EnsEMBL::Registry->set_disconnect_when_inactive();
  Description: Set the flag to make sure that the database connection is dropped if
               not being used on each database.
  Returntype : none
  Exceptions : none
996
  Status     : Stable
997
998
999

=cut

1000
sub set_disconnect_when_inactive{
1001
  foreach my $dba ( @{get_all_DBAdaptors()}){
1002
    my $dbc = $dba->dbc;
1003
    # Disconnect if connected
1004
    $dbc->disconnect_if_idle() if $dbc->connected();
1005
1006
1007
    $dbc->disconnect_when_inactive(1);
  }
}
Ian Longden's avatar
Ian Longden committed
1008

1009
1010
1011
1012
1013
1014
1015

=head2 disconnect_all

  Example    : Bio::EnsEMBL::Registry->disconnect_all();
  Description: disconnect from all the databases.
  Returntype : none
  Exceptions : none
1016
  Status     : Stable
1017
1018
1019

=cut

1020
sub disconnect_all {
Web Admin's avatar
fixed  
Web Admin committed
1021
  foreach my $dba ( @{get_all_DBAdaptors()||[]} ){
1022
    my $dbc = $dba->dbc;
Web Admin's avatar
Web Admin committed
1023
    next unless $dbc;
1024
    # Disconnect if connected
1025
1026
1027
    $dbc->disconnect_if_idle() if $dbc->connected();
  }
}
1028

1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
=head2 change_access

  Will change the username and password for a set of databases.
  if host,user or database names are missing then these are not checked.
  So for example if you do not specify a database then ALL databases on
  the specified  host and port will be changed.

  Arg [1]    : name of the host to change access on
  Arg [2]    : port number to change access on
  Arg [3]    : name of the user to change access on
  Arg [4]    : name of the database to change access on
  Arg [5]    : name of the new user
  Arg [6]    : new password

  Example    : Bio::EnsEMBL::Registry->get_alias("Human");
  Description: change username and password on one or more databases
  Returntype : none
  Exceptions : none
1047
  Status     : Stable
1048
1049
1050
1051

=cut

sub change_access{
Steve Trevanion's avatar
Steve Trevanion committed
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
my $self = shift;
    my ($host,$port,$user,$dbname,$new_user,$new_pass) = @_;
    foreach my $dba ( @{$registry_register{'_DBA'}}){
	my $dbc = $dba->dbc;
	if((!defined($host) or $host eq $dbc->host) and
	   (!defined($port) or $port eq $dbc->port) and
	   (!defined($user) or $user eq $dbc->username) and
	   (!defined($dbname) or $dbname eq $dbc->dbname)){
	    if($dbc->connected()){
		$dbc->db_handle->disconnect();
		$dbc->connected(undef);
	    }
	    # over write the username and password
	    $dbc->username($new_user);
	    $dbc->password($new_pass);
	}
1068
1069
1070
    }
}

1071
1072


1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
=head2 load_registry_from_url

  Arg [1]    : string $url
  Example : load_registry_from_url("mysql://anonymous@ensembldb.ensembl.org:3306");
  Description: Will load the correct versions of the ensembl databases for the
               software release it can find on a database instance into the 
               registry. Also adds a set of standard aliases. The url format is:
               mysql://[[username][:password]@]hostname[:port].
               You can also request a specific version for the databases by adding
               a slash and the version number but your script may crash as the API
               version won't match the DB version.
  Exceptions : None.
  Status     : Stable
 
=cut

sub load_registry_from_url {
  my ($self, $url, $verbose) = @_;

  if ($url =~ /mysql\:\/\/([^\@]+\@)?([^\:\/]+)(\:\d+)?(\/\d+)?/) {
    my $user_pass = $1;
    my $host = $2;
    my $port = $3;
    my $version = $4;

    $user_pass =~ s/\@$//;
    my ($user, $pass) = $user_pass =~ m/([^\:]+)(\:.+)?/;
    $pass =~ s/^\:// if ($pass);
    $port =~ s/^\:// if ($port);
    $version =~ s/^\/// if ($version);

    $self->load_registry_from_db(
        -host=> $host,
        -user => $user,
        -pass => $pass,
        -port => $port,
        -db_version => $version,
        -verbose => $verbose);
  } else {
    throw("Only MySQL URLs are accepted at the moment");
  }
}


1117
=head2 load_registry_from_db
1118

1119
1120
1121
1122
1123
1124
1125
1126
1127
  Arg [HOST] : The domain name of the database host to connect to.
               
  Arg [USER] : string
               The name of the database user to connect with
  Arg [PASS] : (optional) string
               The password to be used to connect to the database
  Arg [PORT] : int
               The port to use when connecting to the database
  Arg [VERBOSE]: (optional) Wether to print database messages 
1128
1129
1130
1131
1132
1133
  Arg [DB_VERSION]: (optional) By default, only databases corresponding
               to this API version are loaded. This allows the script to
               use databases from another version although it might not
               work properly. This option should only be used for
               production or testing purposes and if you really know what
               you are doing.
1134
1135
1136
1137
1138
  Arg [WAIT_TIMEOUT]: (optional) integer
                 Time in seconds for the wait timeout to happen. Time after which
                 the connection is deleted if not used. By default this is 28800 (8 hours)
                 So set this to greater than this if your connection are getting deleted.
                 Only set this if you are having problems and know what you are doing.
1139
1140
1141
1142
1143

  Example : load_registry_from_db( -host => 'ensembldb.ensembl.org',
				   -user => 'anonymous',
				   -verbose => "1" );

1144
  Description: Will load the correct versions of the ensembl databases for the
1145
               software release it can find on a database instance into the 
1146
               registry. Also adds a set of standard aliases.
1147
1148

  Exceptions : None.
1149
  Status     : Stable
1150
1151
 
=cut
1152

1153
sub load_registry_from_db {
1154
1155
1156
1157
1158
1159
1160
  my ( $self, @args ) = @_;

  my ( $host, $port, $user, $pass, $verbose, $db_version,
       $wait_timeout ) =
    rearrange(
             [qw(HOST PORT USER PASS VERBOSE DB_VERSION WAIT_TIMEOUT )],
             @args );
1161
1162
1163

  my $go_version = 0;
  my $compara_version =0;
1164
  my $ancestral_version =0;
1165
1166

  $user ||= "ensro";
1167
1168
1169
1170
1171
  if ( !defined($port) ) {
    $port = 3306;
    if ( $host eq "ensembldb.ensembl.org" ) {
      if ( !defined($db_version) or $db_version >= 48 ) {
        $port = 5306;
1172
1173
1174
1175
      }
    }
  }

1176
  $wait_timeout ||= 0;
1177

1178
1179
1180
1181
1182
  my $dbh =
    DBI->connect( "DBI:mysql:host=$host;port=$port", $user, $pass );

  my $res = $dbh->selectall_arrayref("show databases");
  my @dbnames = map { $_->[0] } @$res;
1183

1184
  my %temp;
1185
  my $software_version = $self->software_version();
1186
1187

  if ( defined($db_version) ) {
1188
1189
    $software_version = $db_version;
  }
1190
1191
1192
1193
1194
1195

  if ($verbose) {
    printf( "Will only load v%d databases\n", $software_version );
  }

  for my $db (@dbnames) {
1196
    if ( $db =~ /^(\w+)_collection_core_(\w+)/ ) { # NEEDS TO BE FIRST
1197
1198
      if ( $2 eq $software_version ) {
        $temp{$1} = 'collection_core_' . $2;
1199
      }
1200
1201
1202
    } elsif ( $db =~ /^([a-z]+_[a-z]+_[a-z]+)_(\d+)_(\d+[a-z]*)/ ) {
      if ( $2 eq $software_version ) {
        $temp{$1} = $2 . "_" . $3;
1203
      }
1204
1205
1206
1207
1208
    } elsif ( $db =~ /^(.+)_(userdata)$/ ) {
      $temp{$1} = $2;
    } elsif ( $db =~ /^ensembl_compara_(\d+)/ ) {
      if ( $1 eq $software_version ) {
        $compara_version = $1;
1209
      }
1210
1211
1212
1213
1214
1215
1216
    } elsif ( $db =~ /^ensembl_ancestral_(\d+)/ ) {
      if ( $1 eq $software_version ) {
        $ancestral_version = $1;
      }
    } elsif ( $db =~ /^ensembl_go_(\d+)/ ) {
      if ( $1 eq $software_version ) {
        $go_version = $1;
1217
1218
      }
    }
1219
1220
1221
1222
1223
1224
  } ## end for my $db (@dbnames)

  @dbnames = ();

  foreach my $key ( keys %temp ) {
    push @dbnames, $key . "_" . $temp{$key};
1225
  }
1226
1227
1228

  # Register Core databases

1229
  my @core_dbs = grep { /^[a-z]+_[a-z]+_core_\d+_/ } @dbnames;
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243

  foreach my $coredb (@core_dbs) {
    my ( $species, $num ) =
      ( $coredb =~ /(^[a-z]+_[a-z]+)_core_(\d+)/ );

    my $dba =
      Bio::EnsEMBL::DBSQL::DBAdaptor->new(-group        => "core",
                                          -species      => $species,
                                          -host         => $host,
                                          -user         => $user,
                                          -pass         => $pass,
                                          -port         => $port,
                                          -dbname       => $coredb,
                                          -wait_timeout => $wait_timeout
1244
      );
1245
1246

    ( my $sp = $species ) =~ s/_/ /g;
1247
    $self->add_alias( $species, $sp );
1248
1249
1250
1251
1252

    if ($verbose) {
      printf( "Species '%s' loaded from database '%s'\n",
              $species, $coredb );
    }
1253
  }
1254

1255
  # Register multi-species databases
1256
  my @multi_dbs = grep { /_collection_core_\w+$/ } @dbnames;
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292

  foreach my $multidb (@multi_dbs) {
    my $sth =
      $dbh->prepare(
         sprintf( 'SELECT species_id, meta_value FROM %s.species_meta ',
                  $dbh->quote_identifier($multidb) )
           . "WHERE meta_key = 'species.db_name'" );
    $sth->execute();

    my ( $species_id, $species );
    $sth->bind_columns( \( $species_id, $species ) );

    while ( $sth->fetch() ) {
      my $dba =
        Bio::EnsEMBL::DBSQL::DBAdaptor->new(
                                          -group        => "core",
                                          -species      => $species,
                                          -species_id   => $species_id,
                                          -host         => $host,
                                          -user         => $user,
                                          -pass         => $pass,
                                          -port         => $port,
                                          -dbname       => $multidb,
                                          -wait_timeout => $wait_timeout
        );

      ( my $sp = $species ) =~ s/_/ /g;
      $self->add_alias( $species, $sp );

      if ($verbose) {
        printf( "Species '%s' (id:%d) loaded from database '%s'\n",
                $species, $species_id, $multidb );
      }
    }
  } ## end foreach my $multidb (@multi_dbs)

1293
  # register cdna databases
1294

1295
  my @cdna_dbs = grep { /^[a-z]+_[a-z]+_cdna_\d+_/ } @dbnames;
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308

  for my $cdnadb (@cdna_dbs) {
    my ( $species, $num ) =
      ( $cdnadb =~ /(^[a-z]+_[a-z]+)_cdna_(\d+)/ );
    my $dba =
      Bio::EnsEMBL::DBSQL::DBAdaptor->new(-group        => "cdna",
                                          -species      => $species,
                                          -host         => $host,
                                          -user         => $user,
                                          -pass         => $pass,
                                          -port         => $port,
                                          -dbname       => $cdnadb,
                                          -wait_timeout => $wait_timeout
1309
      );
1310
    ( my $sp = $species ) =~ s/_/ /g;
1311
    $self->add_alias( $species, $sp );
1312
    print $cdnadb. " loaded\n" if ($verbose);
1313
1314
  }

1315
  my @vega_dbs = grep { /^[a-z]+_[a-z]+_vega_\d+_/ } @dbnames;