ensembl-hive  2.5
Bio::EnsEMBL::Hive::HivePipeline Class Reference

Public Member Functions

public hive_dba ()
 
public display_name ()
 
public unambig_key ()
 
public collection_of ()
 
public find_by_query ()
 
public test_connections ()
 
public new ()
 
public invalidate_collections ()
 
public save_collections ()
 
public add_new_or_update ()
 
public get_source_analyses ()
 
protected _meta_value_by_key ()
 
public hive_use_param_stack ()
 
public hive_pipeline_name ()
 
public hive_auto_rebalance_semaphores ()
 
public hive_use_triggers ()
 
public hive_default_max_retry_count ()
 
public list_all_hive_tables ()
 
public list_all_hive_views ()
 
public hive_sql_schema_version ()
 
public params_as_hash ()
 
public get_cached_hive_current_load ()
 
public invalidate_hive_current_load ()
 
public print_diagram ()
 
public apply_tweaks ()
 

Detailed Description

Definition at line 12 of file HivePipeline.pm.

Member Function Documentation

◆ _meta_value_by_key()

protected Bio::EnsEMBL::Hive::HivePipeline::_meta_value_by_key ( )
    Description: getter/setter for a particular meta_value from 'MetaParameters' collection given meta_key
 
Code:
click to view

◆ add_new_or_update()

public Bio::EnsEMBL::Hive::HivePipeline::add_new_or_update ( )

Undocumented method

Code:
click to view

◆ apply_tweaks()

public Bio::EnsEMBL::Hive::HivePipeline::apply_tweaks ( )
    Description: changes attributes of Analyses|ResourceClasses|ResourceDescriptions or values of pipeline/analysis parameters
 
Code:
click to view

◆ collection_of()

public Bio::EnsEMBL::Hive::HivePipeline::collection_of ( )

Undocumented method

Code:
click to view

◆ display_name()

public Bio::EnsEMBL::Hive::HivePipeline::display_name ( )

Undocumented method

Code:
click to view

◆ find_by_query()

public Bio::EnsEMBL::Hive::HivePipeline::find_by_query ( )

Undocumented method

Code:
click to view

◆ get_cached_hive_current_load()

public Bio::EnsEMBL::Hive::HivePipeline::get_cached_hive_current_load ( )
    Description: Proxy for RoleAdaptor::get_hive_current_load() that caches the last value.
 
Code:
click to view

◆ get_source_analyses()

public Bio::EnsEMBL::Hive::HivePipeline::get_source_analyses ( )
    Description: returns a listref of analyses that do not have local inflow ("source analyses")
 
Code:
click to view

◆ hive_auto_rebalance_semaphores()

public Bio::EnsEMBL::Hive::HivePipeline::hive_auto_rebalance_semaphores ( )
    Description: getter/setter via MetaParameters. Defines whether beekeeper should attempt to rebalance semaphores on each iteration.
 
Code:
click to view

◆ hive_dba()

public Bio::EnsEMBL::Hive::HivePipeline::hive_dba ( )

Undocumented method

Code:
click to view

◆ hive_default_max_retry_count()

public Bio::EnsEMBL::Hive::HivePipeline::hive_default_max_retry_count ( )
    Description: getter/setter via MetaParameters. Defines the default value for analysis_base.max_retry_count
 
Code:
click to view

◆ hive_pipeline_name()

public Bio::EnsEMBL::Hive::HivePipeline::hive_pipeline_name ( )
    Description: getter/setter via MetaParameters. Defines the symbolic name of the pipeline.
 
Code:
click to view

◆ hive_sql_schema_version()

public Bio::EnsEMBL::Hive::HivePipeline::hive_sql_schema_version ( )
    Description: getter via MetaParameters. Defines the Hive SQL schema version of the database if it has been stored
 
Code:
click to view

◆ hive_use_param_stack()

public Bio::EnsEMBL::Hive::HivePipeline::hive_use_param_stack ( )
    Description: getter/setter via MetaParameters. Defines which one of two modes of parameter propagation is used in this pipeline
 
Code:
click to view

◆ hive_use_triggers()

public Bio::EnsEMBL::Hive::HivePipeline::hive_use_triggers ( )
    Description: getter via MetaParameters. Defines whether SQL triggers are used to automatically update AnalysisStats counters
 
Code:
click to view

◆ invalidate_collections()

public Bio::EnsEMBL::Hive::HivePipeline::invalidate_collections ( )

Undocumented method

Code:
click to view

◆ invalidate_hive_current_load()

public Bio::EnsEMBL::Hive::HivePipeline::invalidate_hive_current_load ( )
    Description: Method that forces the next get_cached_hive_current_load() call to fetch a fresh value from the database
 
Code:
click to view

◆ list_all_hive_tables()

public Bio::EnsEMBL::Hive::HivePipeline::list_all_hive_tables ( )
    Description: getter via MetaParameters. Lists the (MySQL) table names used by the HivePipeline
 
Code:
click to view

◆ list_all_hive_views()

public Bio::EnsEMBL::Hive::HivePipeline::list_all_hive_views ( )
    Description: getter via MetaParameters. Lists the (MySQL) view names used by the HivePipeline
 
Code:
click to view

◆ new()

public Bio::EnsEMBL::Hive::HivePipeline::new ( )

Undocumented method

Code:
click to view

◆ params_as_hash()

public Bio::EnsEMBL::Hive::HivePipeline::params_as_hash ( )
    Description: returns the destringified contents of the 'PipelineWideParameters' collection as a hash
 
Code:
click to view

◆ print_diagram()

public Bio::EnsEMBL::Hive::HivePipeline::print_diagram ( )
    Description: prints a "Unicode art" textual representation of the pipeline's flow diagram
 
Code:
click to view

◆ save_collections()

public Bio::EnsEMBL::Hive::HivePipeline::save_collections ( )

Undocumented method

Code:
click to view

◆ test_connections()

public Bio::EnsEMBL::Hive::HivePipeline::test_connections ( )

Undocumented method

Code:
click to view

◆ unambig_key()

public Bio::EnsEMBL::Hive::HivePipeline::unambig_key ( )

Undocumented method

Code:
click to view

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