Permalink
Browse files

show collections docs

  • Loading branch information...
1 parent 07d0539 commit c84a6a9cd1ffc58a0cda774eacc084d81ab1450c @tc committed Nov 3, 2010
Showing with 34 additions and 5 deletions.
  1. +2 −2 DESCRIPTION
  2. +1 −1 NAMESPACE
  3. +1 −1 man/RMongo-package.Rd
  4. +29 −0 man/dbShowCollections-methods.Rd
  5. +1 −1 man/mongoDbConnect.Rd
View
@@ -1,8 +1,8 @@
Package: RMongo
Type: Package
Title: MongoDB Client for R
-Version: 0.0.16
-Date: 2010-10-25
+Version: 0.0.17
+Date: 2010-11-03
Author: Tommy Chheng
Maintainer: Tommy Chheng <tommy.chheng@gmail.com>
Description: MongoDB Database interface for R. The interface is provided via Java calls to the mongo-java-driver.
View
@@ -1,4 +1,4 @@
import('rJava')
export('mongoDbConnect')
exportClass('RMongo')
-exportMethods('dbInsertDocument', 'dbGetQuery', 'dbGetQueryForKeys', 'dbDisconnect')
+exportMethods('dbInsertDocument', 'dbShowCollections', 'dbGetQuery', 'dbGetQueryForKeys', 'dbDisconnect')
View
@@ -14,7 +14,7 @@ A typical workflow using RMongo:
\enumerate{
\item Connect to a mongodb database:
\preformatted{
- mongo <- mongoDbConnect("test")
+ mongo <- mongoDbConnect("test", "localhost", 27017)
}
\item Insert a document into a collection:
This will insert a document of '{"foo":"bar"}' into the "test_data" collection.
@@ -0,0 +1,29 @@
+\name{dbShowCollections-methods}
+\docType{methods}
+\alias{dbShowCollections}
+\alias{dbShowCollections-methods}
+\alias{dbShowCollections,RMongo-method}
+
+\title{Shows a list of collections}
+
+\description{
+Shows a list of collections in the specified rmongo.object database.
+}
+
+\usage{
+ dbShowCollections(rmongo.object)
+}
+
+\arguments{
+ \item{rmongo.object}{The RMongo object.}
+}
+
+\seealso{
+ \code{\link{dbShowCollections-methods}}
+}
+\examples{
+ mongo <- mongoDbConnect("test")
+ dbShowCollections(mongo)
+ dbDisconnect(mongo)
+}
+
View
@@ -18,5 +18,5 @@ mongoDbConnect(dbName, host="localhost", port=27017)
}
\examples{
- mongo <- mongoDbConnect("test")
+ mongo <- mongoDbConnect("test", "localhost", 27017)
}

0 comments on commit c84a6a9

Please sign in to comment.