Merge documents with preference given to first one when both have the same key. I.e. for every (k := v) in first argument, if k exists in second argument then replace its value with v, otherwise add (k := v) to second argument.

Field

data Field l Source

A Field is a 'Key'-'Value' pair.

Constructors

:=
Fields key :: !Key value :: Value l

Instances

Typeable1 Field
(LabelState l p s, Serialize l) => Insert l p s (Document l)
(LabelState l p s, Serialize l, Insert l p s (Document l)) => Insert l p s (Labeled l (Document l))
Label l => Eq (Field l)
Label l => Show (Field l)
(Serialize l, Label l) => BsonDocSerialize (Document l)

(=:) :: (Val l v, Label l) => Key -> v -> Field lSource

Field with given label and typed value

(=?) :: (Val l a, Label l) => Key -> Maybe a -> Document lSource

If Just value then return one field document, otherwise return empty document

type Key = Label Source

A Key, or attribute is a BSON label.

hailsInternalKeyPrefix :: Key Source

This prefix is reserved for HAILS keys. It should not be used by arbitrary code.

Value

data Value l Source

A Value is either a standard BSON value, a labeled value, or a policy-labeled value.

Instances

Typeable1 Value
Label l => Val l (Value l)	Every `Value` is a `Val`.
Label l => Eq (Value l)	Instance for `Eq`, only comparing unlabeled BSON values.
Label l => Show (Value l)	Instance for `Show`, only showing unlabeled BSON values.

class (Typeable a, Show a, Eq a, Label l) => Val l a whereSource

Haskell types of this class correspond to LBSON value types.

Methods

val :: a -> Value lSource

cast' :: Value l -> Maybe aSource

Instances

(Val a, Label l) => Val l a	Every type that is an instance of BSON Val is an instance of LBSON Val. This requires the use of `OverlappingInstances` extension.
Label l => Val l (Value l)	Every `Value` is a `Val`.
(Val a, Label l) => Val l (PolicyLabeled l a)	Convert between a policy-labeled value and a labeled BSON value.
(Val a, Label l) => Val l (Labeled l a)	Convert between a labeled value and a labeled BSON value.

cast :: forall m l a. (Label l, Val l a, Monad m) => Value l -> m aSource

Convert Value to expected type, or fail (Nothing) if not of that type

typed :: (Val l a, Label l) => Value l -> aSource

Convert Value to expected type. Error if not that type.

Policy labeled values

pu :: (Label l, Val a) => a -> PolicyLabeled l aSource

Wrap an unlabeled value by PolicyLabeled.

pl :: (Label l, Val a) => Labeled l a -> PolicyLabeled l aSource

Wrap an already-labeled value by PolicyLabeled.

Special Bson value types

newtype Binary

Constructors

Binary ByteString

Instances

Eq Binary
Read Binary
Show Binary
Typeable Binary
Val Binary

newtype Function

Constructors

Function ByteString

Instances

Eq Function
Read Function
Show Function
Typeable Function
Val Function

newtype UUID

Constructors

UUID ByteString

Instances

Eq UUID
Read UUID
Show UUID
Typeable UUID
Val UUID

newtype MD5

Constructors

MD5 ByteString

Instances

Eq MD5
Read MD5
Show MD5
Typeable MD5
Val MD5

newtype UserDefined

Constructors

UserDefined ByteString

Instances

Eq UserDefined
Read UserDefined
Show UserDefined
Typeable UserDefined
Val UserDefined

data Regex

The first string is the regex pattern, the second is the regex options string. Options are identified by characters, which must be listed in alphabetical order. Valid options are *i* for case insensitive matching, *m* for multiline matching, *x* for verbose mode, *l* to make \w, \W, etc. locale dependent, *s* for dotall mode ("." matches everything), and *u* to make \w, \W, etc. match unicode.

Constructors

Regex UString UString

Instances

Eq Regex
Read Regex
Show Regex
Typeable Regex
Val Regex

data Javascript

Javascript code with possibly empty environment mapping variables to values that the code may reference

Constructors

Javascript Document UString

Instances

Eq Javascript
Show Javascript
Typeable Javascript
Val Javascript

newtype Symbol

Constructors

Symbol UString

Instances

Eq Symbol
Read Symbol
Show Symbol
Typeable Symbol
Val Symbol

newtype MongoStamp

Constructors

MongoStamp Int64

Instances

Eq MongoStamp
Read MongoStamp
Show MongoStamp
Typeable MongoStamp
Val MongoStamp

data MinMaxKey

Constructors

MinKey
MaxKey

Instances

Eq MinMaxKey
Read MinMaxKey
Show MinMaxKey
Typeable MinMaxKey
Val MinMaxKey

ObjectId

data ObjectId

A BSON ObjectID is a 12-byte value consisting of a 4-byte timestamp (seconds since epoch), a 3-byte machine id, a 2-byte process id, and a 3-byte counter. Note that the timestamp and counter fields must be stored big endian unlike the rest of BSON. This is because they are compared byte-by-byte and we want to ensure a mostly increasing order.

Constructors

Oid Word32 Word64

Instances