/ 
BioPerl-DB-1.006900
River stage zero No dependents
/ Bio::DB::SimpleDBContext

NAME

Bio::DB::SimpleDBContext - a base implementation of Bio::DB::DBContextI

SYNOPSIS

# See Bio::DB::DBContextI.

DESCRIPTION

See Bio::DB::DBContextI.

FEEDBACK

Mailing Lists

User feedback is an integral part of the evolution of this and other Bioperl modules. Send your comments and suggestions preferably to the Bioperl mailing list. Your participation is much appreciated.

bioperl-l@bioperl.org                  - General discussion
http://bioperl.org/wiki/Mailing_lists  - About the mailing lists

Support

Please direct usage questions or support issues to the mailing list:

bioperl-l@bioperl.org

rather than to the module maintainer directly. Many experienced and reponsive experts will be able look at the problem and quickly address it. Please include a thorough description of the problem with code and data examples if at all possible.

Reporting Bugs

Report bugs to the Bioperl bug tracking system to help us keep track of the bugs and their resolution. Bug reports can be submitted via the web:

http://redmine.open-bio.org/projects/bioperl/

AUTHOR - Hilmar Lapp

Email hlapp at gmx.net

Describe contact details here

CONTRIBUTORS

Additional contributors names and emails here

APPENDIX

The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _

new

Title   : new
Usage   : my $obj = Bio::DB::SimpleDBContext->new();
Function: Builds a new Bio::DB::SimpleDBContext object 
Returns : an instance of Bio::DB::SimpleDBContext
Args    : Named parameters. Currently recognized are
            -dbname    the name of the schema
            -host      the database host (to which to connect)
            -port      the port on the host to which to connect (optional)
            -driver    the DBI driver name for the RDBMS (e.g., mysql,
                       oracle, or Pg)
            -user      the username for connecting
            -pass      the password for the user
            -dsn       the DSN string to use verbatim for connecting;
                       if supplied, other parameters will not change
                       or add to the value (see method dsn())
            -schema    the schema under which the database tables
                       reside, if the driver needs this (for example,
                       for PostgreSQL)

dsn

Title   : dsn
Usage   : $obj->dsn($newval)
Function: Get/set the DSN for the database connection. 

          The DSN typically contains all non-credential information
          necessary to connect to the database, like driver, database
          or instance name, host, etc. Therefore, setting the DSN
          overrides any other individual properties set before. We
          make an attempt to parse those properties out of the DSN
          string, but, in accordance with the interface contract,
          advise any client to use the dsn verbatim for connecting if
          set and not try to rebuild it from the parsed out
          properties.

          I.e., if you set this property, setting any other
          individual properties will not alter the DSN used for
          connecting to the database. If you query the property, a
          value will not be automatically constructed if only
          individual properties have been set.

Example : 
Returns : value of dsn (a scalar)
Args    : on set, new value (a scalar or undef, optional)

dbname

Title   : dbname
Usage   : $obj->dbname($newval)
Function: 
Example : 
Returns : value of dbname (a scalar)
Args    : new value (a scalar, optional)

driver

Title   : driver
Usage   : $obj->driver($newval)
Function: 
Example : 
Returns : value of driver (a scalar)
Args    : new value (a scalar, optional)

username

Title   : username
Usage   : $obj->username($newval)
Function: 
Example : 
Returns : value of username (a scalar)
Args    : new value (a scalar, optional)

password

Title   : password
Usage   : $obj->password($newval)
Function: 
Example : 
Returns : value of password (a scalar)
Args    : new value (a scalar, optional)

host

Title   : host
Usage   : $obj->host($newval)
Function: 
Example : 
Returns : value of host (a scalar)
Args    : new value (a scalar, optional)

port

Title   : port
Usage   : $obj->port($newval)
Function: 
Example : 
Returns : value of port (a scalar)
Args    : new value (a scalar, optional)

dbadaptor

Title   : get_adaptor
Usage   : $dbadp = $dbc->dbadaptor();
Function:
Example :
Returns : An Bio::DB::DBAdaptorI implementing object (an object adaptor
          factory).
Args    : Optionally, on set an Bio::DB::DBAdaptorI implementing object (to
          be used as the object adaptor factory for the respective database)

dbi

Title   : dbi
Usage   :
Function:
Example :
Returns : A Bio::DB::DBI implementing object
Args    : Optionally, on set a Bio::DB::DBI implementing object

schema

Title   : schema
Usage   : $dbc->schema($newval)
Function: Get/set the schema in which the database tables reside.
Example : 
Returns : value of schema (a scalar)
Args    : on set, new value (a scalar or undef, optional)