- AUTHOR - Yves Bastide
Bio::DB::DBI::Pg - 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.
email@example.com - General discussion http://bioperl.org/wiki/Mailing_lists - About the mailing lists
Please direct usage questions or support issues to the mailing list:
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.
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:
Email ybastide at irisa.fr
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 = Bio::DB::DBI::Pg->new(); Function: Builds a new Bio::DB::DBI::Pg object using the passed named parameters. Returns : an instance of Bio::DB::DBI::Pg 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(); Function: 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 primary key generating sequence. If omitted, the value returned by sequence_name() will be used.
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 does not need to know 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. Optionally, the name of the primary key generating sequence. If omitted, the value returned by sequence_name() will be used.
Title : ifnull_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
Title : build_dsn Usage : Function: Constructs the DSN string from the DBContextI object. Since this may be driver-specific, specific implementations may need to override this method. Example : Returns : a string (the DSN) Args : a Bio::DB::DBContextI implementing object
Title : new_connection Usage : Function: Obtains a new connection handle to the database represented by the the DBContextI object, passing additional args to the DBI->connect() method. We need to override this here in order to support setting a schema for PostgreSQL. Example : Returns : an open DBI database handle Args : A Bio::DB::DBContextI implementing object. Additional hashref parameter to pass to DBI->connect().