Safe Haskell	None
Language	Haskell98

Imm.Database

Contents

Description

Database module abstracts over a key-value database that supports CRUD operations.

This module follows the Handle pattern.

import qualified Imm.Database as Database

Synopsis

class (Ord (Key t), Show (Key t), Show (Entry t), Typeable t, Show t, Pretty t, Pretty (Key t)) => Table t where
- type Key t :: *
- type Entry t :: *
- rep :: t
data Handle m t = Handle {
- _describeDatabase :: forall a. m (Doc a)
- _fetchList :: [Key t] -> m (Map (Key t) (Entry t))
- _fetchAll :: m (Map (Key t) (Entry t))
- _update :: Key t -> (Entry t -> Entry t) -> m ()
- _insertList :: [(Key t, Entry t)] -> m ()
- _deleteList :: [Key t] -> m ()
- _purge :: m ()
- _commit :: m ()
}
data DatabaseException t
- = NotCommitted t
- | NotDeleted t [Key t]
- | NotFound t [Key t]
- | NotInserted t [(Key t, Entry t)]
- | NotPurged t
- | NotUpdated t (Key t)
- | UnableFetchAll t
fetch :: Monad m => Table t => MonadThrow m => Handle m t -> Key t -> m (Entry t)
fetchList :: Monad m => Handle m t -> [Key t] -> m (Map (Key t) (Entry t))
fetchAll :: Monad m => Handle m t -> m (Map (Key t) (Entry t))
update :: Monad m => Handle m t -> Key t -> (Entry t -> Entry t) -> m ()
insert :: Monad m => Handle m -> Handle m t -> Key t -> Entry t -> m ()
insertList :: Monad m => Handle m -> Handle m t -> [(Key t, Entry t)] -> m ()
delete :: Monad m => Handle m -> Handle m t -> Key t -> m ()
deleteList :: Monad m => Handle m -> Handle m t -> [Key t] -> m ()
purge :: Monad m => Handle m -> Handle m t -> m ()
commit :: Monad m => Handle m -> Handle m t -> m ()
table :: Table t => Handle m t -> t

Types

Generic database table

Associated Types

type Key t :: * Source #

type Entry t :: * Source #

Methods

Instances

Table FeedTable Source #
Instance details Defined in Imm.Database.FeedTable Associated Types type Key FeedTable :: Type Source # type Entry FeedTable :: Type Source # Methods rep :: FeedTable Source #

Constructors

Handle
Fields _describeDatabase :: forall a. m (Doc a) _fetchList :: [Key t] -> m (Map (Key t) (Entry t)) _fetchAll :: m (Map (Key t) (Entry t)) _update :: Key t -> (Entry t -> Entry t) -> m () _insertList :: [(Key t, Entry t)] -> m () _deleteList :: [Key t] -> m () _purge :: m () _commit :: m ()

Constructors

Instances

(Eq t, Eq (Key t), Eq (Entry t)) => Eq (DatabaseException t) Source #
Instance details Defined in Imm.Database Methods (==) :: DatabaseException t -> DatabaseException t -> Bool # (/=) :: DatabaseException t -> DatabaseException t -> Bool #
(Show t, Show (Key t), Show (Entry t)) => Show (DatabaseException t) Source #
Instance details Defined in Imm.Database Methods showsPrec :: Int -> DatabaseException t -> ShowS # show :: DatabaseException t -> String # showList :: [DatabaseException t] -> ShowS #
(Table t, Show (Key t), Show (Entry t), Pretty (Key t), Typeable t) => Exception (DatabaseException t) Source #
Instance details Defined in Imm.Database Methods toException :: DatabaseException t -> SomeException # fromException :: SomeException -> Maybe (DatabaseException t) # displayException :: DatabaseException t -> String #
(Pretty t, Pretty (Key t)) => Pretty (DatabaseException t) Source #
Instance details Defined in Imm.Database Methods pretty :: DatabaseException t -> Doc ann # prettyList :: [DatabaseException t] -> Doc ann #

Primitives

fetchList :: Monad m => Handle m t -> [Key t] -> m (Map (Key t) (Entry t)) Source #

update :: Monad m => Handle m t -> Key t -> (Entry t -> Entry t) -> m () Source #

insert :: Monad m => Handle m -> Handle m t -> Key t -> Entry t -> m () Source #

insertList :: Monad m => Handle m -> Handle m t -> [(Key t, Entry t)] -> m () Source #

delete :: Monad m => Handle m -> Handle m t -> Key t -> m () Source #

deleteList :: Monad m => Handle m -> Handle m t -> [Key t] -> m () Source #

purge :: Monad m => Handle m -> Handle m t -> m () Source #