mongoDB-0.2: A driver for MongoDB

Database.MongoDB.BSON

Contents

Synopsis

Types

data BsonValue Source

BsonValue is the type that can be used as a key in a BsonDoc.

Constructors

BsonDouble Double 
BsonString ByteString 
BsonObject BsonDoc 
BsonArray [BsonValue] 
BsonUndefined 
BsonBinary BinarySubType ByteString 
BsonObjectId ByteString 
BsonBool !Bool 
BsonDate POSIXTime 
BsonNull 
BsonRegex ByteString String 
BsonSymbol ByteString 
BsonInt32 Int32 
BsonInt64 Int64 
BsonMinKey 
BsonMaxKey 

Instances

Eq BsonValue 
Ord BsonValue 
Show BsonValue 
Typeable BsonValue 
Convertible Bool BsonValue 
Convertible Double BsonValue 
Convertible Float BsonValue 
Convertible Int BsonValue 
Convertible Int32 BsonValue 
Convertible Int64 BsonValue 
Convertible Integer BsonValue 
Convertible String BsonValue 
Convertible ByteString BsonValue 
Convertible ByteString BsonValue 
Convertible POSIXTime BsonValue 
Convertible BsonDoc BsonValue 
Convertible BsonValue Bool 
Convertible BsonValue Double 
Convertible BsonValue Float 
Convertible BsonValue Int 
Convertible BsonValue Int32 
Convertible BsonValue Int64 
Convertible BsonValue Integer 
Convertible BsonValue String 
Convertible BsonValue ByteString 
Convertible BsonValue ByteString 
Convertible BsonValue POSIXTime 
Convertible BsonValue BsonDoc 
BsonConv BsonValue a 
Convertible BsonValue [Bool] 
Convertible BsonValue [Double] 
Convertible BsonValue [Float] 
Convertible BsonValue [Int32] 
Convertible BsonValue [Int64] 
Convertible BsonValue [String] 
Convertible BsonValue [(String, BsonValue)] 
Convertible BsonValue [(ByteString, BsonValue)] 
Convertible BsonValue [POSIXTime] 
Convertible BsonValue (Map String BsonValue) 
Convertible [Bool] BsonValue 
Convertible [Double] BsonValue 
Convertible [Float] BsonValue 
Convertible [Int] BsonValue 
Convertible [Int32] BsonValue 
Convertible [Int64] BsonValue 
Convertible [Integer] BsonValue 
Convertible [String] BsonValue 
Convertible [(String, BsonValue)] BsonValue 
Convertible [(ByteString, BsonValue)] BsonValue 
Convertible [ByteString] BsonValue 
Convertible [ByteString] BsonValue 
Convertible [POSIXTime] BsonValue 
Convertible a BsonValue => Convertible (Maybe a) BsonValue 
Convertible BsonValue a => Convertible (Maybe BsonValue) (Maybe a) 
BsonConv (Maybe BsonValue) (Maybe a) 
Convertible (Map String BsonValue) BsonValue 

type BsonDoc = Map ByteString BsonValueSource

BSON Document: this is the top-level (but recursive) type that all MongoDB collections work in terms of. It is a mapping between strings (Data.ByteString.Lazu.UTF8.ByteString) and BsonValues. It can be constructed either from a Map (eg BsonDoc myMap) or from a associative list (eg toBsonDoc myAL).

data BinarySubType Source

Constructors

BSTUNDEFINED1 
BSTFunction 
BSTByteArray 
BSTUUID 
BSTUNDEFINED2 
BSTMD5 
BSTUserDefined 

Instances

BsonDoc Operations

empty :: BsonDocSource

An empty BsonDoc

lookup :: BsonDocOps a => a -> BsonDoc -> Maybe BsonValueSource

Return the BsonValue for given key, if any.

Type Conversion

fromBson :: (BsonConv a b, Convertible a b) => a -> bSource

Convert a BsonValue into a native Haskell type.

toBson :: (BsonConv a b, Convertible b a) => b -> aSource

Convert a native Haskell type into a BsonValue.

fromBsonDoc :: BsonDocOps a => BsonDoc -> [(a, BsonValue)]Source

Unwrap BsonDoc to be a Map

toBsonDoc :: BsonDocOps a => [(a, BsonValue)] -> BsonDocSource

Construct a BsonDoc from an associative list

Binary encoding/decoding

getBsonDoc :: Get BsonDocSource

putBsonDoc :: BsonDoc -> PutSource