hom.Sc.inp_dbconn {hom.Sc.inp.db} | R Documentation

## Collect information about the package annotation DB

### Description

Some convenience functions for getting a connection object to (or collecting information about) the package annotation DB.

### Usage

      hom.Sc.inp_dbconn()
      hom.Sc.inp_dbfile()
      hom.Sc.inp_dbschema(file="", show.indices=FALSE)
      hom.Sc.inp_dbInfo()

### Arguments

`file` | A connection, or a character string naming the file to print to (see the `file` argument of the `cat` function for the details).
`show.indices` | The CREATE INDEX statements are not shown by default. Use `show.indices=TRUE` to get them.

### Details

`hom.Sc.inp_dbconn` returns a connection object to the package annotation DB. IMPORTANT: Don't call `dbDisconnect` on the connection object returned by `hom.Sc.inp_dbconn` or you will break all the `AnnDbObj` objects defined in this package!

`hom.Sc.inp_dbfile` returns the path (character string) to the package annotation DB (this is an SQLite file).

`hom.Sc.inp_dbschema` prints the schema definition of the package annotation DB.

`hom.Sc.inp_dbInfo` prints other information about the package annotation DB.

### Value

`hom.Sc.inp_dbconn`: a DBIConnection object representing an open connection to the package annotation DB.
`hom.Sc.inp_dbfile`: a character string with the path to the package annotation DB.
`hom.Sc.inp_dbschema`: none (invisible `NULL`).
`hom.Sc.inp_dbInfo`: none (invisible `NULL`).

### See Also

`dbGetQuery`, `dbConnect`, `dbconn`, `dbfile`, `dbschema`, `dbInfo`

### Examples

      ## Count the number of rows in the "metadata" table:
      dbGetQuery(hom.Sc.inp_dbconn(), "SELECT COUNT(*) FROM metadata")

      ## The connection object returned by hom.Sc.inp_dbconn() was created with:
      dbConnect(SQLite(), dbname=hom.Sc.inp_dbfile(), cache_size=64000, synchronous=0)

      hom.Sc.inp_dbschema()

      hom.Sc.inp_dbInfo()

[Package hom.Sc.inp.db version 2.2.5 Index]