Bio::DB::DBI::Transaction - 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
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.
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/
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 : Function: This method throws an exception. Use get_Transaction() to get a Transaction object. Returns : Args :
Title : _new Usage : my $obj = Bio::DB::DBI::Transaction->_new(); Function: Builds a new Bio::DB::DBI::Transaction object This is a private method. If you call this method from outside you are on your own. Call get_Transaction() to obtain an instance of this class. Returns : an instance of Bio::DB::DBI::Transaction Args :
Title : dbh Usage : Function: Get/set the database connection handle for this transaction. Transactions are connection-specific. You should not need to call this method from outside. If you do, call yourself bold, but you're on your own ... Example : Returns : A DBI database connection handle Args : on set, the new DBI database connection handle
Title : commit Usage : Function: Commit this transaction. Read the DBI perldoc for $dbh->commit about possible return values and behaviour. Committing the transaction will also notify all listeners before and after the actual commit. Listeners have the opportunity to veto a transaction commit by returning false from their before_commit() method. Example : Returns : The return value from $dbh->commit() Args : none
Title : rollback Usage : Function: Rollback this transaction. Read the DBI perldoc for $dbh->rollback about possible return values and behaviour. Rolling back the transaction will also notify all listeners before and after the actual rollback. Listeners cannot veto a transaction rollback. Example : Returns : The return value from $dbh->rollback() Args : none
Title : get_TransactionListeners Usage : @arr = get_TransactionListeners() Function: Get the list of TransactionListener(s) for this object. We currently do not enforce the listener objects to literally be Bio::DB::DBI::TransactionListener implementing objects. This object can handle this; use $obj->can() for every listener-specific call you invoke yourself on the returned objects. Example : Returns : An array of Bio::DB::DBI::TransactionListener objects Args :
Title : add_TransactionListener Usage : Function: Add one or more TransactionListener(s) to this object. We currently do not enforce the listener objects to literally be Bio::DB::DBI::TransactionListener implementing objects. Example : Returns : Args : One or more Bio::DB::DBI::TransactionListener objects.
Title : remove_TransactionListeners Usage : Function: Remove all TransactionListeners for this class. We currently do not enforce the listener objects to literally be Bio::DB::DBI::TransactionListener implementing objects. This object can handle this; use $obj->can() for every listener-specific call you invoke yourself on the returned objects. Example : Returns : The list of previous TransactionListeners as an array of Bio::DB::DBI::TransactionListener objects. Args :
Title : remove_TransactionListener Usage : Function: Remove one TransactionListener for this class. We currently do not enforce the listener objects to literally be Bio::DB::DBI::TransactionListener implementing objects. This object can handle this; use $obj->can() for every listener-specific call you invoke yourself on the returned objects. Example : Returns : void Args : A Bio::DB::DBI::TransactionListener object
Title : get_Transaction Usage : Function: Get the Transaction for a particular connection. This is a class method. Example : Returns : an instance of this class Args : a DBI database connection handle for which to obtain the transaction All other arguments are passed on to new() if a new Transaction needs to be created.
To install Bio::BioEntry, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Bio::BioEntry
CPAN shell
perl -MCPAN -e shell install Bio::BioEntry
For more information on module installation, please visit the detailed CPAN module installation guide.