Data.Bson.Mapping

This module aims to make mapping between algebraic data types and bson documents easy.

You can also generate documents with selectFields, which takes a list of functions names that of type a -> b and returns a function of type a -> Document.

Example:

import Data.Bson.Mapping
import Data.Time.Clock
import Data.Data (Typeable)

data Post = Post { time :: UTCTime
                 , author :: String
                 , content :: String
                 , votes :: Int
                 }
          deriving (Show, Read, Eq, Ord, Typeable)
$(deriveBson ''Post)

main :: IO ()
main = do
  now <- getCurrentTime
  let post = Post now "francesco" "lorem ipsum" 5
  (fromBson (toBson post) :: IO Post) >>= print
  print $ toBson post
  print $ $(selectFields ['time, 'content]) post

Documentation

class (Show a, Eq a, Typeable a) => Bson a where

Minimal complete definition

toBson, fromBson

Methods

toBson :: a -> Document

fromBson :: Monad m => Document -> m a

deriveBson :: Name -> Q [Dec]

Derive Bson and Val declarations for a data type.

selectFields :: [Name] -> Q Exp

Select only certain fields in a document, see the code sample at the top.

Please note that there is no checking for the names to be actual fields of the bson document mapped to a datatype, so be careful.

getLabel :: Name -> Q Exp

getConsDoc :: Name -> Q Exp

Get a document that identifies the data type - getConsDoc ''Post.

This is useful to select all documents mapped to a certain data type.

subDocument :: Label -> Document -> Document

Simple function to select fields in a nested document.

getField :: Name -> Q Exp

Returns a function that gets a datatype and a value, and generates a Document consisting of one field - the label provided - and the value of that datatype.

$(getField 'time) post will generate ["time" =: time post].