\HeaderA{yeast2\_dbconn}{Collect information about the package annotation DB}{yeast2.Rul.dbconn}
\aliasA{yeast2\_dbfile}{yeast2\_dbconn}{yeast2.Rul.dbfile}
\aliasA{yeast2\_dbInfo}{yeast2\_dbconn}{yeast2.Rul.dbInfo}
\aliasA{yeast2\_dbschema}{yeast2\_dbconn}{yeast2.Rul.dbschema}
\keyword{utilities}{yeast2\_dbconn}
\keyword{datasets}{yeast2\_dbconn}
\begin{Description}\relax
Some convenience functions for getting a connection object to (or collecting
information about) the package annotation DB.
\end{Description}
\begin{Usage}
\begin{verbatim}
  yeast2_dbconn()
  yeast2_dbfile()
  yeast2_dbschema(file="", show.indices=FALSE)
  yeast2_dbInfo()
\end{verbatim}
\end{Usage}
\begin{Arguments}
\begin{ldescription}
\item[\code{file}] A connection, or a character string naming the file to print to (see
the \code{file} argument of the \code{\LinkA{cat}{cat}} function for
the details).

\item[\code{show.indices}] The CREATE INDEX statements are not shown by default.
Use \code{show.indices=TRUE} to get them.

\end{ldescription}
\end{Arguments}
\begin{Details}\relax
\code{yeast2\_dbconn} returns a connection object to the package
annotation DB.
IMPORTANT: Don't call \code{\LinkA{dbDisconnect}{dbDisconnect}} on the connection
object returned by \code{yeast2\_dbconn} or you will
break all the \code{\LinkA{AnnDbObj}{AnnDbObj}} objects defined in this package!

\code{yeast2\_dbfile} returns the path (character string) to the
package annotation DB (this is an SQLite file).

\code{yeast2\_dbschema} prints the schema definition of the
package annotation DB.

\code{yeast2\_dbInfo} prints other information about the package
annotation DB.
\end{Details}
\begin{Value}
\code{yeast2\_dbconn}: a DBIConnection object representing an open
connection to the package annotation DB.

\code{yeast2\_dbfile}: a character string with the path to the
package annotation DB.

\code{yeast2\_dbschema}: none (invisible \code{NULL}).

\code{yeast2\_dbInfo}: none (invisible \code{NULL}).
\end{Value}
\begin{SeeAlso}\relax
\code{\LinkA{dbGetQuery}{dbGetQuery}},
\code{\LinkA{dbConnect}{dbConnect}},
\code{\LinkA{dbconn}{dbconn}},
\code{\LinkA{dbfile}{dbfile}},
\code{\LinkA{dbschema}{dbschema}},
\code{\LinkA{dbInfo}{dbInfo}}
\end{SeeAlso}
\begin{Examples}
\begin{ExampleCode}
  ## Count the number of rows in the "probes" table:
  dbGetQuery(yeast2_dbconn(), "SELECT COUNT(*) FROM probes")

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

  yeast2_dbschema()

  yeast2_dbInfo()
\end{ExampleCode}
\end{Examples}

