ag_dbconn               package:ag.db               R Documentation

_C_o_l_l_e_c_t _i_n_f_o_r_m_a_t_i_o_n _a_b_o_u_t _t_h_e _p_a_c_k_a_g_e _a_n_n_o_t_a_t_i_o_n _D_B

_D_e_s_c_r_i_p_t_i_o_n:

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

_U_s_a_g_e:

       ag_dbconn()
       ag_dbfile()
       ag_dbschema(file="", show.indices=FALSE)
       ag_dbInfo()

_A_r_g_u_m_e_n_t_s:

    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. 

_D_e_t_a_i_l_s:

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

     'ag_dbfile' returns the path (character string) to the package
     annotation DB (this is an SQLite file).

     'ag_dbschema' prints the schema definition of the package
     annotation DB.

     'ag_dbInfo' prints other information about the package annotation
     DB.

_V_a_l_u_e:

     'ag_dbconn': a DBIConnection object representing an open
     connection to the package annotation DB.

     'ag_dbfile': a character string with the path to the package
     annotation DB.

     'ag_dbschema': none (invisible 'NULL').

     'ag_dbInfo': none (invisible 'NULL').

_S_e_e _A_l_s_o:

     'dbGetQuery', 'dbConnect', 'dbconn', 'dbfile', 'dbschema',
     'dbInfo'

_E_x_a_m_p_l_e_s:

       ## Count the number of rows in the "probes" table:
       dbGetQuery(ag_dbconn(), "SELECT COUNT(*) FROM probes")

       ## The connection object returned by ag_dbconn() was created with:
       dbConnect(SQLite(), dbname=ag_dbfile(), cache_size=64000, synchronous=0)

       ag_dbschema()

       ag_dbInfo()

