Hails.Database.MongoDB.Structured

Documentation

class DCRecord a where

Class for converting from "structured" records to documents (and vice versa).

Methods

fromDocument :: Monad m => Document DCLabel -> m a

Convert a document to a record

toDocument :: a -> Document DCLabel

Convert a record to a document

collectionName :: a -> CollectionName

Get the collection name for the record

findBy :: (Val DCLabel v, DatabasePolicy p) => p -> CollectionName -> Key -> v -> DC (Maybe a)

Find an object with mathing value for the given key. If the object does exist but cannot be read (above clearance), this returns Nothing.

findWhere :: DatabasePolicy p => p -> Query DCLabel -> DC (Maybe a)

Find an object with given query

insertRecord :: DatabasePolicy p => p -> a -> DC (Either Failure (Value DCLabel))

Insert a record into the database

saveRecord :: DatabasePolicy p => p -> a -> DC (Either Failure ())

Insert a record into the database

deleteBy :: (Val DCLabel v, DatabasePolicy p) => p -> CollectionName -> Key -> v -> DC (Maybe a)

Delete a record from the database given a matching value for given key. The deleted record is returned.

deleteWhere :: DatabasePolicy p => p -> Selection DCLabel -> DC (Maybe a)

Delete an object matching the given query. The deleted record is returned.

findByP :: (Val DCLabel v, DatabasePolicy p) => DCPrivTCB -> p -> CollectionName -> Key -> v -> DC (Maybe a)

Same as findBy, but using explicit privileges.

findWhereP :: DatabasePolicy p => DCPrivTCB -> p -> Query DCLabel -> DC (Maybe a)

Same as findWhere, but using explicit privileges.

insertRecordP :: DatabasePolicy p => DCPrivTCB -> p -> a -> DC (Either Failure (Value DCLabel))

Same as insertRecord, but using explicit privileges.

saveRecordP :: DatabasePolicy p => DCPrivTCB -> p -> a -> DC (Either Failure ())

Same as saveRecord, but using explicit privileges.

deleteByP :: (Val DCLabel v, DatabasePolicy p) => DCPrivTCB -> p -> CollectionName -> Key -> v -> DC (Maybe a)

Same as deleteBy, but using explicit privileges.

deleteWhereP :: DatabasePolicy p => DCPrivTCB -> p -> Selection DCLabel -> DC (Maybe a)

Same as deleteWhere, but using explicit privileges.

class DCRecord a => DCLabeledRecord a where

Class for inserting and saving labeled records.

Methods

insertLabeledRecord :: MkToLabeledDocument p => p -> DCLabeled a -> DC (Either Failure (Value DCLabel))

Insert a labeled record into the database

saveLabeledRecord :: MkToLabeledDocument p => p -> DCLabeled a -> DC (Either Failure ())

Insert a labeled record into the database

insertLabeledRecordP :: MkToLabeledDocument p => DCPrivTCB -> p -> DCLabeled a -> DC (Either Failure (Value DCLabel))

Same as insertLabeledRecord, but using explicit privileges.

saveLabeledRecordP :: MkToLabeledDocument p => DCPrivTCB -> p -> DCLabeled a -> DC (Either Failure ())

Same as saveLabeledRecord, but using explicit privileges.

class DatabasePolicy p => MkToLabeledDocument p where

Classe used by a database policy to translate a labeled record to a labeled document.

Methods

mkToLabeledDocument :: DCRecord a => p -> DCLabeled a -> DC (DCLabeled (Document DCLabel))

Given a policy, return a function that can be used to translate labeled records to labeled documents. It is recommended to simply create the instance by defining mkToDocumentP as:

 mkToDocumentP (Policy ... priv ..) = toDocumentP priv

toDocumentP :: DCRecord a => DCPrivTCB -> DCLabeled a -> DC (DCLabeled (Document DCLabel))

Same as toDocument but for uses the policy's privileges to convert a labeled record to a labeled document.