Bio::D...ailover(3pm)

πŸ“¦
version 1.7.8 Β· 3 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble

✨ NAME ✨

ok so Bio::DB::Failover is literally a Bio::DB::RandomAccessI-compliant class that wraps a whole prioritized list of DBs πŸ’… like it's the friend who knows a guy who knows a guy. it's from the perl docs, user-contributed, and bestie, it's giving backup-plan energy 🫢


🌸 SYNOPSIS 🌸

$failover = Bio::DB::Failover->new();

$failover->add_database($db);

# fail over Bio::DB::RandomAccessI.pm

# this will check each database in priority, returning when
# the first one succeeds

$seq = $failover->get_Seq_by_id($id);

πŸ’– DESCRIPTION πŸ’–

This module provides fail over access to a set of Bio::DB::RandomAccessI objects. no cap β€” it's the group chat of databases and somebody's always gonna answer πŸ”₯


πŸ¦‹ CONTACT πŸ¦‹

Ewan Birney <birney@ebi.ac.uk> originally wrote this class. iconic behavior, we love to see it πŸ‘‘

πŸ’Œ 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.

(ok so fr fr: ask the group chat first, not the one main character dev. the collective brain cell is stronger πŸ’€ and pls bring receipts β€” code and data examples, the whole vibe check.)

πŸ› Reporting Bugs πŸ›

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

https://github.com/bioperl/bioperl-live/issues

🌈 APPENDIX 🌈

The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _ (so if you see an underscore, that's a private thing, mind ya business πŸ™ˆ).

⭐ add_database ⭐

  • Title : add_database
  • Usage : add_database(%db)
  • Function: Adds a database to the Failover object
  • Returns : Count of number of databases
  • Args : Array of db resources
  • Throws : Not a RandomAccessI exception

πŸ’œ get_Seq_by_id πŸ’œ

  • Title : get_Seq_by_id
  • Usage : $seq = $db->get_Seq_by_id('ROA1_HUMAN')
  • Function: Gets a Bio::Seq object by its name
  • Returns : a Bio::Seq object
  • Args : the id (as a string) of a sequence
  • Throws : "no id" exception

πŸŽ€ get_Seq_by_acc πŸŽ€

  • Title : get_Seq_by_acc
  • Usage : $seq = $db->get_Seq_by_acc('X77802');
  • Function: Gets a Bio::Seq object by accession number
  • Returns : A Bio::Seq object
  • Args : accession number (as a string)
  • Throws : "no id" exception

🧚 get_Seq_by_version 🧚

  • Title : get_Seq_by_version
  • Usage : $seq = $db->get_Seq_by_acc('X77802.2');
  • Function: Gets a Bio::Seq object by versioned accession number
  • Returns : A Bio::Seq object
  • Args : accession number (as a string)
  • Throws : "acc does not exist" exception

lowkey the whole point: check each database in priority, return when the first one succeeds. first one to text back wins 🫢

ok that's the page bestie, periodt πŸ’…βœ¨ this was perl v5.32.1, dated 2021-08-15, and yeah the manual name got folded up top like a cute lil hair clip πŸŽ€ mwah, go read your sequences πŸ‘‘

πŸ“¦ where this page comes from