Bio::DB::DBI::mysql - DESCRIPTION of Object
Give standard usage here
Describe the object here
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
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://bugzilla.open-bio.org/
Email hlapp at gmx.net
Describe contact details here
Additional contributors names and emails here
The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _
Title : new
Usage : my $obj = new Bio::DB::DBI::mysql();
Function: Builds a new Bio::DB::DBI::mysql object using the passed named
parameters.
Returns : an instance of Bio::DB::DBI::mysql
Args : named parameters with tags -dbcontext (a Bio::DB::DBContextI
implementing object) and -sequence_name (the name of the sequence
for PK generation)
Title : next_id_value
Usage : $pk = $obj->next_id_value("bioentry");
Function: This implementation uses standard MySQL only and hence cannot
implement this method. It will throw an exception if called.
Example :
Returns : a value suitable for use as a primary key
Args : The database connection handle to use for retrieving the next primary
key value.
Optionally, the name of the table. The driver is not required to
honor the argument if present.
Title : last_id_value
Usage :
Function: Returns the last unique primary key value
allocated. Depending on the argument and the driver, the
value may be specific to a table, or independent of the
table.
This implementation will ignore the table.
Example :
Returns : a value suitable for use as a primary key
Args : The database connection handle to use for retrieving the primary
key from the last insert.
Title : nvl_sqlfunc
Usage :
Function: Get the name of the SQL function that takes two arguments
and returns the first if it is not null, and the second
otherwise.
Most RDBMSs will have such a function, but unfortunately
the naming is different between them. E.g., in MySQL the
name is IFNULL(), whereas in Oracle it is NVL().
Example :
Returns : the name of the function as a string, without parentheses
Args : none
