Package biana :: Module biana_commands' :: Class administration
[hide private]
[frames] | no frames]

Class administration

source code

Static Methods [hide private]
 
check_database(dbname, dbhost, dbuser, dbpassword, dbport=None)
Examines the current database and gets its basic information (external databases, unification protocols...)
source code
 
create_biana_database(dbname, dbhost, dbuser, dbpassword, description, dbport=None)
Creates the BIANA database in the mysql server
source code
 
create_unification_protocol(unification_protocol_name, list_unification_atom_elements, dbname, dbhost, dbuser, dbpassword, dbport=None)
Creates a new unification protocol
source code
 
delete_biana_database(dbname, dbhost, dbuser, dbpassword, dbport=None)
Deletes the specified BIANA database.
source code
 
delete_unification_protocol(unification_protocol_name, dbname, dbhost, dbuser, dbpassword, dbport=None)
Creates a new unification protocol
source code
 
get_available_external_entity_attributes()
Returns all the possible external entity attributes
source code
 
get_available_external_entity_relation_types()
Returns all the possible external entity relation types
source code
 
get_available_external_entity_types()
Returns all the possible external entity types
source code
 
get_available_parsers()
Returns the description of available parsers
source code
 
get_unification_protocol_atoms(unification_protocol_name, dbname, dbhost, dbuser, dbpassword, dbport=None)
Returns unification protocol atom information of given unification protocol
source code
 
reset_biana_database(dbname, dbhost, dbuser, dbpassword, dbport=None)
Deletes all the tables in the specified BIANA database without deleting the database itself.
source code
Method Details [hide private]

create_biana_database(dbname, dbhost, dbuser, dbpassword, description, dbport=None)
Static Method

source code 

Creates the BIANA database in the mysql server

"dbname": Desired database name. It must not exist a database with the same name in the same database server (required)

"dbhost" is the machine with the mysql server that holds the biana database (required)

"dbuser" is the mysql user (not required in most systems)

"dbpassword" is the mysql password (not required in most systems)

"dbport" is the mysql port (not required in most systems)

In order to make parsers faster, it creates tables without indices and addicional checkings. Biana automatically enable indices when necessary. If user wants to enable indices manually, it is necessary to use the method "enable_indices"

create_unification_protocol(unification_protocol_name, list_unification_atom_elements, dbname, dbhost, dbuser, dbpassword, dbport=None)
Static Method

source code 

Creates a new unification protocol

"unification_protocol_name" is the name of the unification protocol (it can be a string). It cannot contain blank spaces. It must be unique (required)

"listUnifiationAtomElements" is a list of tuples. Each tuple consists on two elements: the list of database to cross and the list of attributes as for example [([1,2],["uniprotAccession"]),([1],["geneSymbol"])]

"dbname": Biana database name

"dbhost" is the machine with the mysql server that holds the biana database (required)

"dbuser" is the mysql user (not required in most systems)

"dbpassword" is the mysql password (not required in most systems)

"dbport" is the mysql port (not required in most systems)

delete_biana_database(dbname, dbhost, dbuser, dbpassword, dbport=None)
Static Method

source code 

Deletes the specified BIANA database.

ALERT!!! This action is not reversible! All data in BIANA database will be deleted permanently!

"dbname": BIANA database name

"dbhost" is the machine with the mysql server that holds the biana database (required)

"dbuser" is the mysql user (not required in most systems)

"dbpassword" is the mysql password (not required in most systems)

"dbport" is the mysql port (not required in most systems)

delete_unification_protocol(unification_protocol_name, dbname, dbhost, dbuser, dbpassword, dbport=None)
Static Method

source code 

Creates a new unification protocol

"unification_protocol_name" is the name of the unification protocol (it can be a string). It cannot contain blank spaces. It must be unique (required)

"dbname": Biana database name

"dbhost" is the machine with the mysql server that holds the biana database (required)

"dbuser" is the mysql user (not required in most systems)

"dbpassword" is the mysql password (not required in most systems)

"dbport" is the mysql port (not required in most systems)

reset_biana_database(dbname, dbhost, dbuser, dbpassword, dbport=None)
Static Method

source code 

Deletes all the tables in the specified BIANA database without deleting the database itself.

ALERT!!! This action is not reversible! All data in BIANA database will be deleted permanently!

"dbname": Biana database name

"dbhost" is the machine with the mysql server that holds the biana database (required)

"dbuser" is the mysql user (not required in most systems)

"dbpassword" is the mysql password (not required in most systems)

"dbport" is the mysql port (not required in most systems)