Database.MongoDB.Query

Query and update documents

Monad

data Action m a

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

Instances

MonadTrans Action

MonadTransControl Action

MonadBase b m => MonadBase b (Action m)

(MonadIO m, MonadBaseControl b m) => MonadBaseControl b (Action m)

Monad m => MonadError Failure (Action m)

Monad m => Monad (Action m)

Functor m => Functor (Action m)

(Monad m, Functor m) => Applicative (Action m)

MonadIO m => MonadIO (Action m)

(MonadBaseControl IO m, Applicative m, Functor m) => MonadDB (Action m)

access :: MonadIO m => Pipe -> AccessMode -> Database -> Action m a -> m (Either Failure a)

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

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.

Constructors

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

Instances

Eq Failure

Show Failure

Error Failure

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

Monad m => MonadError Failure (Action m)

type ErrorCode = Int

Error code from getLastError or query failure

data AccessMode

Type of reads and writes to perform

Constructors

ReadStaleOk

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

UnconfirmedWrites

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.

Instances

Show AccessMode

type GetLastError = Document

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 http://www.mongodb.org/display/DOCS/Last+Error+Commands for more options.

master :: AccessMode

Same as ConfirmWrites []

slaveOk :: AccessMode

Same as ReadStaleOk

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

Run action with given AccessMode

class (Monad m, MonadBaseControl IO (BaseMonad m), Applicative (BaseMonad m), Functor (BaseMonad m)) => MonadDB m where

If you stack a monad on top of Action then make it an instance of this class and use liftDB to execute a DB Action within it. Instances already exist for the basic mtl transformers.

Associated Types

type BaseMonad m :: * -> *

Methods

liftDB :: Action (BaseMonad m) a -> m a

Instances

(MonadBaseControl IO m, Applicative m, Functor m) => MonadDB (Action m)

(MonadDB m, Error e) => MonadDB (ErrorT e m)

MonadDB m => MonadDB (ReaderT r m)

MonadDB m => MonadDB (StateT s m)

(MonadDB m, Monoid w) => MonadDB (WriterT w m)

(MonadDB m, Monoid w) => MonadDB (RWST r w s m)

Database

type Database = Text

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

List all databases residing on server

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

Run action against given database

thisDatabase :: Monad m => Action m Database

Current database in use

Authentication

type Username = Text

type Password = Text

auth :: MonadIO' m => Username -> Password -> Action m Bool

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.

Collection

type Collection = Text

Collection name (not prefixed with database)

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

List all collections in this database

Selection

data Selection

Selects documents in collection that match selector

Constructors

Select

Fields

selector :: Selector

coll :: Collection

Instances

Eq Selection

Show Selection

Select Selection

type Selector = Document

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 http://www.mongodb.org/display/DOCS/Querying for full selector syntax.

whereJS :: Selector -> Javascript -> Selector

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

class Select aQueryOrSelection where

Methods

select :: Selector -> Collection -> aQueryOrSelection

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.

Instances

Select Query

Select Selection

Write

Insert

insert :: MonadIO' m => Collection -> Document -> Action m Value

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

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

Same as insert except don't return _id

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

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 ()

Same as insertMany except don't return _ids

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

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 ()

Same as insertAll except don't return _ids

Update

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

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

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

Replace first document in selection with given document

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

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

type Modifier = Document

Update operations on fields in a document. See http://www.mongodb.org/display/DOCS/Updating#Updating-ModifierOperations

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

Update all documents in selection using given modifier

Delete

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

Delete all documents in selection

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

Delete first document in selection

Read

Query

data Query

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

Constructors

Query

Fields

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 = []

Instances

Eq Query

Show Query

Select Query

data QueryOption

Constructors

TailableCursor

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.

NoCursorTimeout

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.

AwaitData

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

Partial

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

Instances

Eq QueryOption

Show QueryOption

type Projector = Document

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 = Word32

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

type Order = Document

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 = Word32

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

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

Return performance stats of query execution

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

Fetch documents satisfying query

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

Fetch first document satisfying query or Nothing if none satisfy it

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

Same as findOne except throw DocNotFound if none match

findAndModify

Arguments

:: (Applicative m, MonadIO m)

=> Query

-> Document

updates

-> Action m (Either String Document)

runs the findAndModify command. Returns a single updated document (new option is set to true). Currently this API does not allow setting the remove option

count :: MonadIO' m => Query -> Action m Int

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

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

Fetch distinct values of field in selected documents

Cursor

data Cursor

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]

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)

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

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

Return next N documents or less if end is reached

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

Return remaining documents in query result

closeCursor :: (MonadIO m, MonadBaseControl IO m) => Cursor -> Action m ()

isCursorClosed :: (MonadIO m, MonadBase IO m) => Cursor -> Action m Bool

Aggregate

type Pipeline = [Document]

The Aggregate Pipeline

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

Runs an aggregate and unpacks the result. See http://docs.mongodb.org/manual/core/aggregation/ for details.

Group

data Group

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

Constructors

Group

Fields

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).

Instances

Eq Group

Show Group

data GroupKey

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).

Constructors

Key [Label]

KeyF Javascript

Instances

Eq GroupKey

Show GroupKey

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

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

MapReduce

data MapReduce

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.

Constructors

MapReduce

Fields

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.

Instances

Eq MapReduce

Show MapReduce

type MapFun = Javascript

() -> 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 = Javascript

(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 = Javascript

(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

Constructors

Inline

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

Instances

Eq MROut

Show MROut

data MRMerge

Constructors

Replace

Clear all old data and replace it with new data

Merge

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

Reduce

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

Instances

Eq MRMerge

Show MRMerge

type MRResult = Document

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

mapReduce :: Collection -> MapFun -> ReduceFun -> MapReduce

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, Applicative m) => MapReduce -> Action m Cursor

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

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

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).

Command

type Command = Document

A command is a special query or action against the database. See http://www.mongodb.org/display/DOCS/Commands for details.

runCommand :: MonadIO' m => Command -> Action m Document

Run command against the database and return its result

runCommand1 :: MonadIO' m => Text -> Action m Document

runCommand1 foo = runCommand [foo =: 1]

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

Run code on server