Skip to content

Commit

Permalink
show collections docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tc committed Nov 3, 2010
1 parent 07d0539 commit c84a6a9
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 5 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
@@ -1,8 +1,8 @@
Package: RMongo Package: RMongo
Type: Package Type: Package
Title: MongoDB Client for R Title: MongoDB Client for R
Version: 0.0.16 Version: 0.0.17
Date: 2010-10-25 Date: 2010-11-03
Author: Tommy Chheng Author: Tommy Chheng
Maintainer: Tommy Chheng <tommy.chheng@gmail.com> 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. Description: MongoDB Database interface for R. The interface is provided via Java calls to the mongo-java-driver.
Expand Down
2 changes: 1 addition & 1 deletion NAMESPACE
@@ -1,4 +1,4 @@
import('rJava') import('rJava')
export('mongoDbConnect') export('mongoDbConnect')
exportClass('RMongo') exportClass('RMongo')
exportMethods('dbInsertDocument', 'dbGetQuery', 'dbGetQueryForKeys', 'dbDisconnect') exportMethods('dbInsertDocument', 'dbShowCollections', 'dbGetQuery', 'dbGetQueryForKeys', 'dbDisconnect')
2 changes: 1 addition & 1 deletion man/RMongo-package.Rd
Expand Up @@ -14,7 +14,7 @@ A typical workflow using RMongo:
\enumerate{ \enumerate{
\item Connect to a mongodb database: \item Connect to a mongodb database:
\preformatted{ \preformatted{
mongo <- mongoDbConnect("test") mongo <- mongoDbConnect("test", "localhost", 27017)
} }
\item Insert a document into a collection: \item Insert a document into a collection:
This will insert a document of '{"foo":"bar"}' into the "test_data" collection. This will insert a document of '{"foo":"bar"}' into the "test_data" collection.
Expand Down
29 changes: 29 additions & 0 deletions man/dbShowCollections-methods.Rd
@@ -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)
}

2 changes: 1 addition & 1 deletion man/mongoDbConnect.Rd
Expand Up @@ -18,5 +18,5 @@ mongoDbConnect(dbName, host="localhost", port=27017)
} }
\examples{ \examples{
mongo <- mongoDbConnect("test") mongo <- mongoDbConnect("test", "localhost", 27017)
} }

0 comments on commit c84a6a9

Please sign in to comment.