man/dbInit.Rd

   1 \name{dbInit}
   2 \alias{dbInit}
   3 \alias{dbInitialize}
   4 \alias{dbCreate}
   5 \alias{dbCreate,ANY-method}
   6 \alias{dbInit,ANY-method}
   7 \alias{dbReconnect}
   8 \alias{dbReconnect,filehashDB1-method}
   9
  10 %\alias{dbInitialize}
  11
  12 \title{Simple file-based hash table}
  13 \description{
  14   Interface for creating and initializing a simple file-based hash table
  15 }
  16 \usage{
  17 dbCreate(db, ...)
  18 dbInit(db, ...)
  19 dbReconnect(db, ...)
  20
  21 \S4method{dbCreate}{ANY}(db, type = NULL, ...)
  22 \S4method{dbInit}{ANY}(db, type = NULL, ...)
  23 \S4method{dbReconnect}{filehashDB1}(db, ...)
  24 }
  25
  26 \arguments{
  27   \item{db}{name of database or a database object}
  28   \item{type}{type of database format.  If missing, the default type
  29     will be used}
  30   \item{...}{other arguments passed to methods}
  31 }
  32
  33 \details{
  34   \code{dbCreate} creates the necessary files or directory for the
  35   database.  If those files already exist nothing is done.
  36
  37   \code{dbInit} takes a database name and returns an object
  38   inheriting from class \code{"filehash"}.
  39
  40   The \code{type} argument specifies the format in which the database
  41   should be stored on the disk.  If not specified, the default
  42   type will be used (as specified by \code{filehashOption}).
  43 }
  44
  45 \note{
  46   The function \code{dbInitialize} has been deprecated.  Use
  47   \code{dbInit} instead.
  48 }
  49
  50 \value{
  51   \code{dbCreate} returns \code{TRUE} upon success and \code{FALSE} in
  52   the event of an error.  \code{dbInit} returns an object
  53   inheriting from class \code{"filehash"}
  54 }
  55
  56 \author{Roger D. Peng}
  57
  58 \seealso{
  59   See \code{\link{filehash-class}} more information and examples and
  60   \code{\link{filehashOption}} for setting the default database type.
  61 }
  62
  63 \keyword{database}% at least one, from doc/KEYWORDS
  64