loadDatabaseSchema: Load the compendium database schema

Description Usage Arguments Details Note Author(s) See Also Examples

View source: R/loadDatabaseSchema.R

Description

Load a database schema file to the compendium database in the MySQL server

Usage

1
  loadDatabaseSchema(con, updateSchema = FALSE , file = "")

Arguments

con

list containing a connection object specifying the user name and password to connect or interact with the compendium database (see connectDatabase)

updateSchema

logical, default value is FALSE

file

character string, default value is "". In this case the compendiaSchema.sql database schema provided with the package is loaded.

Details

See http://wiki.bioinformaticslaboratory.nl/foswiki/bin/view/BioLab/CompendiumDB for a detailed description of the database schema.

Note

Execute this function only after having created the database specified in the connection object in the MySQL server. Set the updateSchema value TRUE only before filling the database with series record data for the first time, or if you want to delete all the records of the database and reload the schema. In the latter case the user will be prompted whether (s)he really wants to update the current schema and delete all data in the compendium database.

Author(s)

Umesh K. Nandal

See Also

connectDatabase

Examples

1
2
3
4
5
 ## Not run: 
  conn <- connectDatabase(user="usrname",password="passwd",dbname="compendium")
  loadDatabaseSchema(conn,updateSchema=TRUE)
 
## End(Not run)

compendiumdb documentation built on May 2, 2019, 4:06 p.m.