MINI MINI MANI MO

%
% Copyright (c) 2012, 2015, Oracle and/or its affiliates. All rights reserved.
%
\name{ore.datastoreSummary}
\alias{ore.datastoreSummary}
\title{Oracle R Enterprise Datastore Summarizing Function}
\description{
   Summarizes the contents of a datastore in the user's Oracle Database
   schema.
}
\usage{
ore.datastoreSummary(name, owner)
}
\arguments{
  \item{name}{
    The character string specifying the datastore name.
  }
  \item{owner}{
    An optional character string specifying the owner of the datastore to 
    summarize. If the owner of the datastore is not the current user, 
    the read privilege for the datastore must be granted to the current user by
    \code{\link{ore.grant}}; otherwise \code{\link{ore.load}} errors out.
    If the \code{owner} argument not specified, the default value is 
    the current user.
  }
}
\details{
  Summarizes the datastore specified by argument \code{name} and \code{owner}. 
  If the named datastore does not exist or the current user does not have read
  privilege for this datastore, the function throws an error.
}
\value{
  A \code{data.frame} object is returned with columns
  \code{object.name}, \code{class},\code{size}, \code{length},
  \code{row.count}, and \code{col.count}; these columns specify the
  object name, the object's class, the object's size in bytes, the
  length of object, and the number of rows and columns of object,
  respectively. The rows of the \code{data.frame} object are
  alphabetically sorted by column \code{object.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.datastore}}
  \code{\link{ore.grant}}
  \code{\link{ore.revoke}}
}
\examples{
\dontrun{
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="rq$ds_1")

# show detailed information about the datastore rq$ds_1
ore.datastoreSummary(name="rq$ds_1")

ore.delete(name="rq$ds_1")
rm(x, y, z)
}
}
\keyword{datastore}
\keyword{database}
\keyword{ORE}