ensembl-hive  2.6
Bio::EnsEMBL::DBLoader Class Reference

Public Member Functions

public The new ()
 
protected _load_module ()
 

Detailed Description

Synopsis

$db =
Bio::EnsEMBL::DBLoader->new( "Bio::EnsEMBL::DBSQL::DBAdaptor/"
. "host=localhost;"
. "dbname=homo_sapiens_core_19_34a;"
. "user=ensro;" );
# $db is a database object
$db = Bio::EnsEMBL::DBLoader->standard();
# equivalent to
# Bio::EnsEMBL::DBLoader->new( $ENV{'ENSEMBL_DATABASE'} );

Description

This system provides a run-time loading of the database for ensembl,
allowing two things

    a) Only "using" the database module which is required for a
       particular implementation

    b) Providing a simple string method to indicate where the database
       is, allowing per sites defaults and other things as such


The string is parsed as follows:

Before the / is the Perl database object to load, after are the
parameters to pass to that database.  The parameters are series of
key=values separated by semi-colons.  These are passed as a hash to the
new method of the database object

Definition at line 39 of file DBLoader.pm.

Member Function Documentation

◆ _load_module()

protected Bio::EnsEMBL::DBLoader::_load_module ( )

Undocumented method

Code:
click to view

◆ new()

public The Bio::EnsEMBL::DBLoader::new ( )
  Arg [1]    : string $string
               An Ensembl database locator string.
  Example    :
Bio::EnsEMBL::DBSQL::DBLoader->new("Bio::EnsEMBL::DBSQL::DBAdaptor/host=localhost;dbname=homo_sapiens_core_19_34a;user=ensro;"
  Description: Connects to an Ensembl database using the module specified in
               the locator string.
  Returntype : The module specified in the load string is returned.
  Exceptions : thrown if the specified module cannot be instantiated or the
               locator string cannot be parsed
  Caller     : ?
  Status     : Stable
 
Code:
click to view

The documentation for this class was generated from the following file:
Bio::EnsEMBL::DBLoader::_load_module
protected _load_module()
Bio::EnsEMBL::DBLoader
Definition: DBLoader.pm:39
Bio::EnsEMBL::DBLoader::new
public The new()