Database.MongoDB.Structured.Types

This module exports a Structued type class which can be used to convert Haskel "record types" to BSON objects and vice versa. As a Mongo document has an "_id" field, we impose the requirement a record type have a field whose type is SObjId (corresponding to "_id").

Documentation

class Structured a where

Structured class used to convert between a Haskell record type and BSON document.

Methods

collection

Arguments

:: a

-> Collection

Collection name is then name of type

toBSON

Arguments

:: a

-> Document

Convert record to a BSON object

fromBSON

Arguments

:: Document

-> Maybe a

Convert BSON object to record

Structured "_id"

newtype SObjId

Type corresponding to the "_id" field of a document in a structured object.

Constructors

SObjId (Maybe ObjectId)

Instances

Eq SObjId

Ord SObjId

Read SObjId

Show SObjId

Typeable SObjId

Val SObjId

noSObjId :: SObjId

The "_id" field is unset.

isNoSObjId :: SObjId -> Bool

Check if the "_id" field is unset.

toSObjId :: ObjectId -> SObjId

Set the "_id" field.

unSObjId :: SObjId -> ObjectId

Get the "_id" field (assumes that it is set0.