mongoDB-2.0.3: Driver (client) for MongoDB, a free, scalable, fast, document DBMS

Safe HaskellNone




Query and update documents



type Action = ReaderT MongoContextSource

A monad on top of m (which must be a MonadIO) that may access the database and may fail with a DB Failure

access :: MonadIO m => Pipe -> AccessMode -> Database -> Action m a -> m aSource

Run action against database on server at other end of pipe. Use access mode for any reads and writes. Return Left on connection failure or read/write failure.

data Failure Source

A connection failure, or a read or write exception like cursor expired or inserting a duplicate key. Note, unexpected data from the server is not a Failure, rather it is a programming error (you should call error in this case) because the client and server are incompatible and requires a programming change.


ConnectionFailure IOError

TCP connection (Pipeline) failed. May work if you try again on the same Mongo Connection which will create a new Pipe.

CursorNotFoundFailure CursorId

Cursor expired because it wasn't accessed for over 10 minutes, or this cursor came from a different server that the one you are currently connected to (perhaps a fail over happen between servers in a replica set)

QueryFailure ErrorCode String

Query failed for some reason as described in the string

WriteFailure ErrorCode String

Error observed by getLastError after a write, error description is in string

DocNotFound Selection

fetch found no document matching selection

AggregateFailure String

aggregate returned an error


Eq Failure 
Show Failure 
Typeable Failure 
Exception Failure 
Error Failure

fail is treated the same as a programming error. In other words, don't use it.

type ErrorCode = IntSource

Error code from getLastError or query failure

data AccessMode Source

Type of reads and writes to perform



Read-only action, reading stale data from a slave is OK.


Read-write action, slave not OK, every write is fire & forget.

ConfirmWrites GetLastError

Read-write action, slave not OK, every write is confirmed with getLastError.


type GetLastError = DocumentSource

Parameters for getLastError command. For example ["w" =: 2] tells the server to wait for the write to reach at least two servers in replica set before acknowledging. See for more options.

accessMode :: Monad m => AccessMode -> Action m a -> Action m aSource

Run action with given AccessMode

liftDB :: (MonadReader env m, HasMongoContext env, MonadIO m) => Action IO a -> m aSource

data MongoContext Source

Values needed when executing a db operation


allDatabases :: MonadIO m => Action m [Database]Source

List all databases residing on server

useDb :: Monad m => Database -> Action m a -> Action m aSource

Run action against given database

thisDatabase :: Monad m => Action m DatabaseSource

Current database in use


auth :: MonadIO m => Username -> Password -> Action m BoolSource

Authenticate with the current database (if server is running in secure mode). Return whether authentication was successful or not. Reauthentication is required for every new pipe.


type Collection = TextSource

Collection name (not prefixed with database)

allCollections :: (MonadIO m, MonadBaseControl IO m) => Action m [Collection]Source

List all collections in this database


data Selection Source

Selects documents in collection that match selector



type Selector = DocumentSource

Filter for a query, analogous to the where clause in SQL. [] matches all documents in collection. ["x" =: a, "y" =: b] is analogous to where x = a and y = b in SQL. See for full selector syntax.

whereJS :: Selector -> Javascript -> SelectorSource

Add Javascript predicate to selector, in which case a document must match both selector and predicate

class Select aQueryOrSelection whereSource


select :: Selector -> Collection -> aQueryOrSelectionSource

Query or Selection that selects documents in collection that match selector. The choice of type depends on use, for example, in find (select sel col) it is a Query, and in delete (select sel col) it is a Selection.



insert :: MonadIO m => Collection -> Document -> Action m ValueSource

Insert document into collection and return its "_id" value, which is created automatically if not supplied

insert_ :: MonadIO m => Collection -> Document -> Action m ()Source

Same as insert except don't return _id

insertMany :: MonadIO m => Collection -> [Document] -> Action m [Value]Source

Insert documents into collection and return their "_id" values, which are created automatically if not supplied. If a document fails to be inserted (eg. due to duplicate key) then remaining docs are aborted, and LastError is set.

insertMany_ :: MonadIO m => Collection -> [Document] -> Action m ()Source

Same as insertMany except don't return _ids

insertAll :: MonadIO m => Collection -> [Document] -> Action m [Value]Source

Insert documents into collection and return their "_id" values, which are created automatically if not supplied. If a document fails to be inserted (eg. due to duplicate key) then remaining docs are still inserted. LastError is set if any doc fails, not just last one.

insertAll_ :: MonadIO m => Collection -> [Document] -> Action m ()Source

Same as insertAll except don't return _ids


save :: MonadIO m => Collection -> Document -> Action m ()Source

Save document to collection, meaning insert it if its new (has no "_id" field) or upsert it if its not new (has "_id" field)

replace :: MonadIO m => Selection -> Document -> Action m ()Source

Replace first document in selection with given document

repsert :: MonadIO m => Selection -> Document -> Action m ()Source

Deprecated: use upsert instead

Replace first document in selection with given document, or insert document if selection is empty

upsert :: MonadIO m => Selection -> Document -> Action m ()Source

Update first document in selection with given document, or insert document if selection is empty

modify :: MonadIO m => Selection -> Modifier -> Action m ()Source

Update all documents in selection using given modifier


delete :: MonadIO m => Selection -> Action m ()Source

Delete all documents in selection

deleteOne :: MonadIO m => Selection -> Action m ()Source

Delete first document in selection



data Query Source

Use select to create a basic query with defaults, then modify if desired. For example, (select sel col) {limit = 10}




options :: [QueryOption]

Default = []

selection :: Selection
project :: Projector

[] = all fields. Default = []

skip :: Word32

Number of initial matching documents to skip. Default = 0

limit :: Limit

Maximum number of documents to return, 0 = no limit. Default = 0

sort :: Order

Sort results by this order, [] = no sort. Default = []

snapshot :: Bool

If true assures no duplicates are returned, or objects missed, which were present at both the start and end of the query's execution (even if the object were updated). If an object is new during the query, or deleted during the query, it may or may not be returned, even with snapshot mode. Note that short query responses (less than 1MB) are always effectively snapshotted. Default = False

batchSize :: BatchSize

The number of document to return in each batch response from the server. 0 means use Mongo default. Default = 0

hint :: Order

Force MongoDB to use this index, [] = no hint. Default = []


data QueryOption Source



Tailable means cursor is not closed when the last data is retrieved. Rather, the cursor marks the final object's position. You can resume using the cursor later, from where it was located, if more data were received. Like any latent cursor, the cursor may become invalid at some point – for example if the final object it references were deleted. Thus, you should be prepared to requery on CursorNotFound exception.


The server normally times out idle cursors after 10 minutes to prevent a memory leak in case a client forgets to close a cursor. Set this option to allow a cursor to live forever until it is closed.


Use with TailableCursor. If we are at the end of the data, block for a while rather than returning no data. After a timeout period, we do return as normal. | Exhaust -- ^ Stream the data down full blast in multiple more packages, on the assumption that the client will fully read all data queried. Faster when you are pulling a lot of data and know you want to pull it all down. Note: the client is not allowed to not read all the data unless it closes the connection. Exhaust commented out because not compatible with current Pipeline implementation


Get partial results from a _mongos_ if some shards are down, instead of throwing an error.

type Projector = DocumentSource

Fields to return, analogous to the select clause in SQL. [] means return whole document (analogous to * in SQL). ["x" =: 1, "y" =: 1] means return only x and y fields of each document. ["x" =: 0] means return all fields except x.

type Limit = Word32Source

Maximum number of documents to return, i.e. cursor will close after iterating over this number of documents. 0 means no limit.

type Order = DocumentSource

Fields to sort by. Each one is associated with 1 or -1. Eg. ["x" =: 1, "y" =: -1] means sort by x ascending then y descending

type BatchSize = Word32Source

The number of document to return in each batch response from the server. 0 means use Mongo default.

explain :: MonadIO m => Query -> Action m DocumentSource

Return performance stats of query execution

find :: (MonadIO m, MonadBaseControl IO m) => Query -> Action m CursorSource

Fetch documents satisfying query

findOne :: MonadIO m => Query -> Action m (Maybe Document)Source

Fetch first document satisfying query or Nothing if none satisfy it

fetch :: MonadIO m => Query -> Action m DocumentSource

Same as findOne except throw DocNotFound if none match



:: MonadIO m 
=> Query 
-> Document


-> Action m (Either String Document) 

runs the findAndModify command as an update without an upsert and new set to true. Returns a single updated document (new option is set to true).

see findAndModifyOpts if you want to use findAndModify in a differnt way

findAndModifyOpts :: MonadIO m => Query -> FindAndModifyOpts -> Action m (Either String (Maybe Document))Source

runs the findAndModify command, allows more options than findAndModify

count :: MonadIO m => Query -> Action m IntSource

Fetch number of documents satisfying query (including effect of skip and/or limit if present)

distinct :: MonadIO m => Label -> Selection -> Action m [Value]Source

Fetch distinct values of field in selected documents


data Cursor Source

Iterator over results of a query. Use next to iterate or rest to get all results. A cursor is closed when it is explicitly closed, all results have been read from it, garbage collected, or not used for over 10 minutes (unless NoCursorTimeout option was specified in Query). Reading from a closed cursor raises a CursorNotFoundFailure. Note, a cursor is not closed when the pipe is closed, so you can open another pipe to the same server and continue using the cursor.

nextBatch :: (MonadIO m, MonadBaseControl IO m) => Cursor -> Action m [Document]Source

Return next batch of documents in query result, which will be empty if finished.

next :: (MonadIO m, MonadBaseControl IO m) => Cursor -> Action m (Maybe Document)Source

Return next document in query result, or Nothing if finished.

nextN :: (MonadIO m, MonadBaseControl IO m) => Int -> Cursor -> Action m [Document]Source

Return next N documents or less if end is reached

rest :: (MonadIO m, MonadBaseControl IO m) => Cursor -> Action m [Document]Source

Return remaining documents in query result


type Pipeline = [Document]Source

The Aggregate Pipeline

aggregate :: MonadIO m => Collection -> Pipeline -> Action m [Document]Source

Runs an aggregate and unpacks the result. See for details.


data Group Source

Groups documents in collection by key then reduces (aggregates) each group




gColl :: Collection
gKey :: GroupKey

Fields to group by

gReduce :: Javascript

(doc, agg) -> (). The reduce function reduces (aggregates) the objects iterated. Typical operations of a reduce function include summing and counting. It takes two arguments, the current document being iterated over and the aggregation value, and updates the aggregate value.

gInitial :: Document

agg. Initial aggregation value supplied to reduce

gCond :: Selector

Condition that must be true for a row to be considered. [] means always true.

gFinalize :: Maybe Javascript

agg -> () | result. An optional function to be run on each item in the result set just before the item is returned. Can either modify the item (e.g., add an average field given a count and a total) or return a replacement object (returning a new object with just _id and average fields).


data GroupKey Source

Fields to group by, or function (doc -> key) returning a key object to be used as the grouping key. Use KeyF instead of Key to specify a key that is not an existing member of the object (or, to access embedded members).


Key [Label] 
KeyF Javascript 


group :: MonadIO m => Group -> Action m [Document]Source

Execute group query and return resulting aggregate value for each distinct key


data MapReduce Source

Maps every document in collection to a list of (key, value) pairs, then for each unique key reduces all its associated values to a single result. There are additional parameters that may be set to tweak this basic operation. This implements the latest version of map-reduce that requires MongoDB 1.7.4 or greater. To map-reduce against an older server use runCommand directly as described in http:www.mongodb.orgdisplayDOCS/MapReduce.




rColl :: Collection
rMap :: MapFun
rReduce :: ReduceFun
rSelect :: Selector

Operate on only those documents selected. Default is [] meaning all documents.

rSort :: Order

Default is [] meaning no sort

rLimit :: Limit

Default is 0 meaning no limit

rOut :: MROut

Output to a collection with a certain merge policy. Default is no collection (Inline). Note, you don't want this default if your result set is large.

rFinalize :: Maybe FinalizeFun

Function to apply to all the results when finished. Default is Nothing.

rScope :: Document

Variables (environment) that can be accessed from mapreducefinalize. Default is [].

rVerbose :: Bool

Provide statistics on job execution time. Default is False.

type MapFun = JavascriptSource

() -> void. The map function references the variable this to inspect the current object under consideration. The function must call emit(key,value) at least once, but may be invoked any number of times, as may be appropriate.

type ReduceFun = JavascriptSource

(key, [value]) -> value. The reduce function receives a key and an array of values and returns an aggregate result value. The MapReduce engine may invoke reduce functions iteratively; thus, these functions must be idempotent. That is, the following must hold for your reduce function: reduce(k, [reduce(k,vs)]) == reduce(k,vs). If you need to perform an operation only once, use a finalize function. The output of emit (the 2nd param) and reduce should be the same format to make iterative reduce possible.

type FinalizeFun = JavascriptSource

(key, value) -> final_value. A finalize function may be run after reduction. Such a function is optional and is not necessary for many map/reduce cases. The finalize function takes a key and a value, and returns a finalized value.

data MROut Source



Return results directly instead of writing them to an output collection. Results must fit within 16MB limit of a single document

Output MRMerge Collection (Maybe Database)

Write results to given collection, in other database if specified. Follow merge policy when entry already exists


data MRMerge Source



Clear all old data and replace it with new data


Leave old data but overwrite entries with the same key with new data


Leave old data but combine entries with the same key via MR's reduce function


type MRResult = DocumentSource

Result of running a MapReduce has some stats besides the output. See http:www.mongodb.orgdisplayDOCS/MapReduce#MapReduce-Resultobject

mapReduce :: Collection -> MapFun -> ReduceFun -> MapReduceSource

MapReduce on collection with given map and reduce functions. Remaining attributes are set to their defaults, which are stated in their comments.

runMR :: (MonadIO m, MonadBaseControl IO m) => MapReduce -> Action m CursorSource

Run MapReduce and return cursor of results. Error if map/reduce fails (because of bad Javascript)

runMR' :: MonadIO m => MapReduce -> Action m MRResultSource

Run MapReduce and return a MR result document containing stats and the results if Inlined. Error if the map/reduce failed (because of bad Javascript).


type Command = DocumentSource

A command is a special query or action against the database. See for details.

runCommand :: MonadIO m => Command -> Action m DocumentSource

Run command against the database and return its result

runCommand1 :: MonadIO m => Text -> Action m DocumentSource

runCommand1 foo = runCommand [foo =: 1]

eval :: (MonadIO m, Val v) => Javascript -> Action m vSource

Run code on server