Bio::EnsEMBL::DBSQL::BaseMetaContainer Class Reference

Inheritance diagram for Bio::EnsEMBL::DBSQL::BaseMetaContainer:

Public Member Functions
public Int	get_schema_version ()
public Listref	list_value_by_key ()
public Scalar	single_value_by_key ()
public void	store_key_value ()
public void	update_key_value ()
public void	delete_key ()
public void	delete_key_value ()
public Boolean	key_value_exists ()
protected	_species_specific_key ()
Public Member Functions inherited from Bio::EnsEMBL::DBSQL::BaseAdaptor
public Bio::EnsEMBL::DBSQL::BaseAdaptor	new ()
public DBI::StatementHandle	prepare ()
public Bio::EnsEMBL::DBSQL::DBAdaptor	db ()
public Bio::EnsEMBL::DBSQL::DBConnection	dbc ()
public Boolean	is_multispecies ()
public Int	species_id ()
protected	_list_dbIDs ()
protected	_straight_join ()
protected	_can_straight_join ()
public Listref	bind_param_generic_fetch ()
protected	_bind_param_generic_fetch ()
public String	generate_in_constraint ()
public Listref	generic_fetch ()
public Int	generic_count ()
protected	_generate_sql ()
public Bio::EnsEMBL::Feature	fetch_by_dbID ()
protected	_uncached_fetch_by_dbID ()
public Listref	fetch_all_by_dbID_list ()
protected	_uncached_fetch_all_by_dbID_list ()
protected ArrayRef	_uncached_fetch_all_by_id_list ()
public	fetch_all ()
public Scalar	last_insert_id ()
public	insert_ignore_clause ()
protected Bio::EnsEMBL::DBSQL::Support::BaseCache	_id_cache ()
protected Boolean	_no_id_cache ()
public Boolean	ignore_cache_override ()
public Int	schema_version ()
protected	_tables ()
protected	_columns ()
protected	_default_where_clause ()
protected	_left_join ()
protected	_final_clause ()
protected	_objs_from_sth ()
protected	_build_id_cache ()
protected	_logic_name_to_constraint ()

Detailed Description

Synopsis

my $meta_container = $db_adaptor->get_MetaContainer();
 
my @mapping_info =
  @{ $meta_container->list_value_by_key('assembly.mapping') };

Description

  An object that encapsulates access to db meta data

Definition at line 20 of file BaseMetaContainer.pm.

Member Function Documentation

_species_specific_key()

protected Bio::EnsEMBL::DBSQL::BaseMetaContainer::_species_specific_key

(

)

Undocumented method

Code:

delete_key()

public void Bio::EnsEMBL::DBSQL::BaseMetaContainer::delete_key

(

)

  Arg [1]    : string $key
               The key which should be removed from the database.
  Example    :

$meta_container->delete_key('sequence.compression');

  Description: Removes all rows from the meta table which have a meta_key
               equal to $key.
  Returntype : none
  Exceptions : none
  Caller     : dna_compress script, general
  Status     : Stable

Code:

delete_key_value()

public void Bio::EnsEMBL::DBSQL::BaseMetaContainer::delete_key_value

(

)

  Arg [1]    : string $key
               The key which should be removed from the database.
  Arg [2]    : string $value
               The value to be removed.
  Example    :

$meta_container->delete_key('patch', 'patch_39_40_b.sql|xref_unique_constraint');

  Description: Removes all rows from the meta table which have a meta_key
               equal to $key, AND a meta_value equal to $value.
  Returntype : none
  Exceptions : none
  Caller     : general
  Status     : Stable

Code:

get_schema_version()

public Int Bio::EnsEMBL::DBSQL::BaseMetaContainer::get_schema_version

(

)

  Arg [1]    : none
  Example    :

$schema_ver = $meta_container->get_schema_version();

  Description: Retrieves the schema version from the database meta table
  Returntype : int
  Exceptions : none
  Caller     : ?
  Status     : Medium risk

Code:

key_value_exists()

public Boolean Bio::EnsEMBL::DBSQL::BaseMetaContainer::key_value_exists

(

)

  Arg [1]    : string $key
               the key to check
  Arg [2]    : string $value
               the value to check
  Example    :

if ($meta_container->key_value_exists($key, $value)) ...

  Description: Return true (1) if a particular key/value pair exists,
               false (0) otherwise.
  Returntype : boolean
  Exceptions : none
  Caller     : ?
  Status     : Stable

Code:

list_value_by_key()

public Listref Bio::EnsEMBL::DBSQL::BaseMetaContainer::list_value_by_key

(

)

  Arg [1]    : string $key
               the key to obtain values from the meta table with
  Example    :

my @values = @{ $meta_container->list_value_by_key($key) };

  Description: gets a value for a key. Can be anything 
  Returntype : listref of strings 
  Exceptions : none
  Caller     : ?
  Status     : Stable

Code:

single_value_by_key()

public Scalar Bio::EnsEMBL::DBSQL::BaseMetaContainer::single_value_by_key

(

)

  Arg [1]    : string $key
               the key to obtain values from the meta table with
  Arg [2]    : boolean $warn
               If true will cause the code to warn the non-existence of a value
  Example    :

my $value = $mc->single_value_by_key($key);

  Description: Gets a value for a key. Can be anything
  Returntype : Scalar
  Exceptions : Raised if more than 1 meta item is returned

Code:

store_key_value()

public void Bio::EnsEMBL::DBSQL::BaseMetaContainer::store_key_value

(

)

  Arg [1]    : string $key
               a key under which $value should be stored
  Arg [2]    : string $value
               the value to store in the meta table
  Example    :

$meta_container->store_key_value($key, $value);

  Description: stores a value in the meta container, accessable by a key
  Returntype : none
  Exceptions : Thrown if the key/value already exists.
  Caller     : ?
  Status     : Stable

Code:

update_key_value()

public void Bio::EnsEMBL::DBSQL::BaseMetaContainer::update_key_value

(

)

  Arg [1]    : string $key
               a key under which $value should be updated
  Arg [2]    : string $value
               the value to update in the meta table
  Example    :

$meta_container->update_key_value($key, $value);

  Description: update a value in the meta container, accessable by a key
  Returntype : none
  Exceptions : none
  Caller     : ?
  Status     : Stable

Code:

---

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

• ensembl/modules/Bio/EnsEMBL/DBSQL/BaseMetaContainer.pm