MINI MINI MANI MO

%
% Copyright (c) 2012, 2015, Oracle and/or its affiliates. All rights reserved.
%
\name{ore.datastore}
\alias{ore.datastore}
\title{Oracle R Enterprise Datastore Listing Function}
\description{
  Lists existing datastores in the user's Oracle Database schema.
}
\usage{
ore.datastore(name, pattern, type = c("user", "private", "all", 
                                      "grantable", "grant", "granted"))
}
\arguments{
  \item{name}{
    An optional character string specifying the datastore name; cannot
    be used with argument \code{pattern}.
  }
  \item{pattern}{
    An optional regular expression character string specifying the
    matching datastore names; cannot be used with argument \code{name}.
  }
  \item{type}{
    An optional scalar character string specifying the type of datastore 
    to list. The valid values are 'user' (default), 'private', 'all', 
    'grantable', 'grant', or 'granted'.
    'user' lists the datastores created by current session user.
    'private' lists these datastores the read privileges for which
    cannot be granted by the current session user to other users.
    'all' lists all the datastores to which the current session user has read
    access.
    'grantable' lists these datastores the read privilege for which can be
    granted by the current session user to other users.
    'grant' lists these datastores the read privilege for which has been 
    granted by the current session user to other users.
    'granted' lists these datastores the read privilege for which has been 
    granted by other users to the current session user.
  }
}
\details{
  Function \code{ore.datastore} lists high-level information about
  datastores in the user's Oracle Database schema. This datastore
  listing may be optionally filtered by either the \code{name} or
  \code{pattern} argument.
}
\value{
  A \code{data.frame} object is returned with columns
  \code{datastore.name}, \code{object.count}, \code{size},
  \code{creation.date}, and \code{description} when argument \code{type} is 
  'user', 'private', or 'grantable'; these columns specify
  the datastore name, the number of objects in the named datastore, the
  size of the datastore in bytes, the datastore creation date, and the
  datastore comment, respectively. 
  The output \code{data.frame} has an extra column \code{owner} specifying 
  the owner of the datastores when argument \code{type} is 'all' or 'granted'.
  When argument \code{type} is 'grant', the output \code{data.frame} contains
  columns \code{datastore.name} and \code{grantee} specifying the datastore 
  name and the name of the user to which the read privilege of the named 
  datastore has been granted by the current session user. 
  The rows of the \code{data.frame} object are alphabetically sorted 
  according to column \code{owner}, if present, and \code{datastore.name}.
}
\references{
  \href{http://www.oracle.com/technetwork/database/database-technologies/r/r-enterprise/documentation/index.html}{Oracle R Enterprise}
}
\author{
  Oracle \email{oracle-r-enterprise@oracle.com}
}
\seealso{
  \code{\link{ore.save}},
  \code{\link{ore.load}},
  \code{\link{ore.delete}},
  \code{\link{ore.datastoreSummary}}
  \code{\link{ore.grant}}
  \code{\link{ore.revoke}}
}
\examples{
\dontshow{
if (!interactive())
    ore.connect(user     = Sys.getenv("ORE_USERNAME", "rquser"),
                sid      = Sys.getenv("ORACLE_SID"),
                host     = Sys.getenv("HOST"),
                password = Sys.getenv("ORE_PASSWORD", "rquser"),
                port  = if (.Platform$OS.type == "windows")
                           Sys.getenv("ORACLE_PORT")
                        else
                           Sys.getenv("TCPPORT"),
                all = TRUE)
}

if (!interactive())
{
if (any(sapply(c("x", "y", "z"), exists)))
  stop("object x, y, or z exists")

x <- stats::runif(20)
y <- list(a = 1, b = TRUE, c = "oops")
z <- ore.push(x)

ore.save(list=ls(), name="rqds_1")
ore.save(x, y, name="rqds_2")
ore.save(z, name="rqds_3", grantable=TRUE)

# list overall information about the datastores in user's schema
ds <- ore.datastore()
\dontrun{
ds
}
\dontshow{
ds[, -(3L:4L)]
}

# list overall information about the datastores available in the user's schema
ds <- ore.datastore(type="all")
\dontrun{
ds
}
\dontshow{
ds[, -(3L:4L)]
}

# list overall information about the datastore the read privilege for which
# can be granted
ds <- ore.datastore(type="grantable")
\dontrun{
ds
}
\dontshow{
ds[, -(3L:4L)]
}

# list overall information about the datastore with name 'rqds_1'
ds <- ore.datastore(name="rqds_1")
\dontrun{
ds
}
\dontshow{
ds[, -(3L:4L)]
}

# list overall information about the datastores whose name starts
# with 'rqds_'
ds <- ore.datastore(pattern="^rqds_")
\dontrun{
ds
}
\dontshow{
ds[, -(3L:4L)]
}

sapply(c("rqds_1", "rqds_2", "rqds_3"), ore.delete)
rm(x, y, z)
}
}
\keyword{datastore}
\keyword{database}
\keyword{ORE}