Bio::EnsEMBL::Hive::DBSQL::BeekeeperAdaptor Class Reference

Inheritance diagram for Bio::EnsEMBL::Hive::DBSQL::BeekeeperAdaptor:

Public Member Functions
public	default_table_name ()
public	object_class ()
public Arrayref	find_live_beekeepers_in_my_meadow ()
public void	bury_other_beekeepers ()
public void	reload_beekeeper_is_blocked ()
public void	block_all_alive_beekeepers ()
Public Member Functions inherited from Bio::EnsEMBL::Hive::DBSQL::ObjectAdaptor
public	object_class ()
public	slicer ()
public	objectify ()
public	mark_stored ()
public	keys_to_columns ()
public The	refresh ()
Public Member Functions inherited from Bio::EnsEMBL::Hive::DBSQL::BaseAdaptor
public	default_table_name ()
public	default_insertion_method ()
public	default_overflow_limit ()
public	default_input_column_mapping ()
public	do_not_update_columns ()
public	new ()
public	db ()
public	dbc ()
public	prepare ()
public	overflow_limit ()
public	input_column_mapping ()
public	table_name ()
public	insertion_method ()
public	column_set ()
public	primary_key ()
public	updatable_column_list ()
public	autoinc_id ()
protected	_table_info_loader ()
public	count_all ()
public	fetch_all ()
public	primary_key_constraint ()
public	fetch_by_dbID ()
public	remove_all ()
public	remove ()
public	update ()
public	store_or_update_one ()
public	check_object_present_in_db_by_content ()
public	class_specific_execute ()
public	store ()
protected	_multi_column_filter ()
public	DESTROY ()
public	AUTOLOAD ()

Detailed Description

Description

    This is the adaptor for Bio::EnsEMBL::Hive::Beekeeper

    It contains all the beekeeper-management methods that are
    called by beekeeper.pl and requir the database.

Definition at line 13 of file BeekeeperAdaptor.pm.

Member Function Documentation

block_all_alive_beekeepers()

public void Bio::EnsEMBL::Hive::DBSQL::BeekeeperAdaptor::block_all_alive_beekeepers

(

)

  Example     :

$bk_adaptor->block_all_alive_beekeepers();

  Description : Set is_blocked for all beekeepers known to the
                pipeline which haven't died yet. Part of the "shut
                everything down" feature - as eHive stands we cannot
                tell other beekeepers to kill their respective active
                workers (unless said workers happen to belong to the
                same meadow, in which case we can essentially hijack
                them) but at least we can prevent them from spawning
                new workers.
  Returntype  : none
  Exception   : none
  Caller      : beekeeper.pl
  Status      : Stable

Code:

bury_other_beekeepers()

public void Bio::EnsEMBL::Hive::DBSQL::BeekeeperAdaptor::bury_other_beekeepers

(

)

  Arg[1]      : Bio::EnsEMBL::Hive::Beekeeper $ref_beekeeper
  Example     :

$bk_adaptor->bury_other_beekeepers($ref_beekeeper);

  Description : Calls find_live_beekeepers_in_my_meadow() and buries the beekeepers that
                are not running any more (not find with `ps`)
  Returntype  : none
  Exceptions  : none
  Caller      : general
  Status      : Stable

Code:

default_table_name()

public Bio::EnsEMBL::Hive::DBSQL::BeekeeperAdaptor::default_table_name

(

)

Undocumented method

Code:

find_live_beekeepers_in_my_meadow()

public Arrayref Bio::EnsEMBL::Hive::DBSQL::BeekeeperAdaptor::find_live_beekeepers_in_my_meadow

(

)

  Arg[1]      : Bio::EnsEMBL::Hive::Beekeeper $ref_beekeeper
  Example     :

my $live_beekeepers_in_my_meadow = $bk_adaptor->find_live_beekeepers_in_my_meadow($beekeeper);

  Description : Returns all the beekeepers registered on the same host as $ref_beekeeper that are still alive.
  Returntype  : Arrayref of Bio::EnsEMBL::Hive::Beekeeper
  Exceptions  : none
  Caller      : general
  Status      : Stable

Code:

object_class()

public Bio::EnsEMBL::Hive::DBSQL::BeekeeperAdaptor::object_class

(

)

Undocumented method

Code:

reload_beekeeper_is_blocked()

public void Bio::EnsEMBL::Hive::DBSQL::BeekeeperAdaptor::reload_beekeeper_is_blocked

(

)

  Arg[1]      : Bio::EnsEMBL::Hive::Beekeeper $beekeeper
  Example     :

my $is_blocked = $bk_adaptor->reload_beekeeper_is_blocked($beekeeper);

  Description : Updates the object with the freshest value of is_blocked coming from the database
                for this beekeeper, and return the new value.
  Returntype  : none
  Exceptions  : none
  Caller      : general
  Status      : Stable

Code:

---

The documentation for this class was generated from the following file:

• modules/Bio/EnsEMBL/Hive/DBSQL/BeekeeperAdaptor.pm