Safe Haskell	None
Language	Haskell2010

Imm.Database.Feed

Contents

Types
Low-level primitives
High-level queries

Description

Feed table definitions.

Synopsis

getHashes :: FeedElement -> [Int]
newtype JsonElement = JsonElement {
- unwrapElement :: FeedElement
}
data Entry = Entry {
- entryLocation :: FeedLocation
- entryTags :: Set Text
- entryReadHashes :: Set Int
- entryFeed :: Maybe Feed
- entryItems :: Map FeedElement Bool
- entryLastUpdate :: Maybe UTCTime
}
prettyShortEntry :: Entry -> Doc AnsiStyle
prettyEntry :: Entry -> Doc AnsiStyle
makeEntry :: FeedLocation -> Set Text -> Entry
matching :: FeedQuery -> Int -> Entry -> Bool
data FeedStatus
- = Unknown
- | New
- | LastUpdate UTCTime
data EntryKey
- = ByLocation FeedLocation
- | ById Int
data Handle m = Handle {
- _describeDatabase :: m (Doc AnsiStyle)
- _fetch :: [EntryKey] -> m (Map EntryKey (Int, Entry))
- _fetchAll :: m (Map Int Entry)
- _update :: [EntryKey] -> (Entry -> Entry) -> m ()
- _insert :: [Entry] -> m (Map FeedLocation Int)
- _delete :: [EntryKey] -> m ()
- _purge :: m ()
- _commit :: m ()
}
readOnly :: Monad m => Handle m -> Handle m -> Handle m
data DatabaseException
- = NotCommitted
- | NotDeleted [FeedLocation]
- | KeyNotFound [EntryKey]
- | NotInserted [Entry]
- | NotPurged
- | NotUpdated FeedLocation
- | UnableFetchAll
fetch1 :: Monad m => MonadThrow m => Handle m -> EntryKey -> m (Int, Entry)
fetch :: Monad m => Handle m -> [EntryKey] -> m (Map EntryKey (Int, Entry))
fetchQuery :: Monad m => Handle m -> (Int -> Entry -> Bool) -> m (Map Int Entry)
fetchAll :: Monad m => Handle m -> m (Map Int Entry)
update :: Monad m => Handle m -> [EntryKey] -> (Entry -> Entry) -> m ()
insert :: MonadThrow m => Handle m -> Handle m -> Entry -> m Int
insertList :: Monad m => Handle m -> Handle m -> [Entry] -> m (Map FeedLocation Int)
delete1 :: Monad m => Handle m -> Handle m -> EntryKey -> m ()
delete :: Monad m => Handle m -> Handle m -> [EntryKey] -> m ()
purge :: Monad m => Handle m -> Handle m -> m ()
commit :: Monad m => Handle m -> Handle m -> m ()
register :: MonadThrow m => Handle m -> Handle m -> FeedLocation -> Set Text -> m Int
getStatus :: MonadCatch m => Handle m -> EntryKey -> m FeedStatus
markAsProcessed :: MonadThrow m => MonadTime m => Handle m -> Handle m -> EntryKey -> FeedElement -> m ()
markAsUnprocessed :: MonadThrow m => Handle m -> Handle m -> EntryKey -> m ()
listUnprocessedElements :: MonadThrow m => Handle m -> EntryKey -> m [FeedElement]
isRead :: MonadCatch m => Handle m -> EntryKey -> FeedElement -> m Bool
resolveEntryKey :: Monad m => Handle m -> FeedQuery -> m [EntryKey]
resolveFeedLocation :: Monad m => Handle m -> EntryKey -> m FeedLocation

Types

getHashes :: FeedElement -> [Int] Source #

newtype JsonElement Source #

Newtype wrapper to provide FromJSON and ToJSON instances for FeedElement

Constructors

JsonElement
Fields unwrapElement :: FeedElement

Instances

Eq JsonElement Source #
Instance details Defined in Imm.Database.Feed Methods (==) :: JsonElement -> JsonElement -> Bool # (/=) :: JsonElement -> JsonElement -> Bool #
Ord JsonElement Source #
Instance details Defined in Imm.Database.Feed Methods compare :: JsonElement -> JsonElement -> Ordering # (<) :: JsonElement -> JsonElement -> Bool # (<=) :: JsonElement -> JsonElement -> Bool # (>) :: JsonElement -> JsonElement -> Bool # (>=) :: JsonElement -> JsonElement -> Bool # max :: JsonElement -> JsonElement -> JsonElement # min :: JsonElement -> JsonElement -> JsonElement #
ToJSON JsonElement Source #
Instance details Defined in Imm.Database.Feed Methods toJSON :: JsonElement -> Value # toEncoding :: JsonElement -> Encoding # toJSONList :: [JsonElement] -> Value # toEncodingList :: [JsonElement] -> Encoding #
ToJSONKey JsonElement Source #
Instance details Defined in Imm.Database.Feed Methods toJSONKey :: ToJSONKeyFunction JsonElement # toJSONKeyList :: ToJSONKeyFunction [JsonElement] #
FromJSON JsonElement Source #
Instance details Defined in Imm.Database.Feed Methods parseJSON :: Value -> Parser JsonElement # parseJSONList :: Value -> Parser [JsonElement] #
FromJSONKey JsonElement Source #
Instance details Defined in Imm.Database.Feed Methods fromJSONKey :: FromJSONKeyFunction JsonElement # fromJSONKeyList :: FromJSONKeyFunction [JsonElement] #

data Entry Source #

Constructors

Entry
Fields entryLocation :: FeedLocation entryTags :: Set Text entryReadHashes :: Set Int entryFeed :: Maybe Feed entryItems :: Map FeedElement Bool entryLastUpdate :: Maybe UTCTime

Instances

Eq Entry Source #
Instance details Defined in Imm.Database.Feed Methods (==) :: Entry -> Entry -> Bool # (/=) :: Entry -> Entry -> Bool #
Ord Entry Source #
Instance details Defined in Imm.Database.Feed Methods compare :: Entry -> Entry -> Ordering # (<) :: Entry -> Entry -> Bool # (<=) :: Entry -> Entry -> Bool # (>) :: Entry -> Entry -> Bool # (>=) :: Entry -> Entry -> Bool # max :: Entry -> Entry -> Entry # min :: Entry -> Entry -> Entry #
Show Entry Source #
Instance details Defined in Imm.Database.Feed Methods showsPrec :: Int -> Entry -> ShowS # show :: Entry -> String # showList :: [Entry] -> ShowS #
ToJSON Entry Source #
Instance details Defined in Imm.Database.Feed Methods toJSON :: Entry -> Value # toEncoding :: Entry -> Encoding # toJSONList :: [Entry] -> Value # toEncodingList :: [Entry] -> Encoding #
FromJSON Entry Source #
Instance details Defined in Imm.Database.Feed Methods parseJSON :: Value -> Parser Entry # parseJSONList :: Value -> Parser [Entry] #

prettyShortEntry :: Entry -> Doc AnsiStyle Source #

prettyEntry :: Entry -> Doc AnsiStyle Source #

makeEntry :: FeedLocation -> Set Text -> Entry Source #

matching :: FeedQuery -> Int -> Entry -> Bool Source #

data FeedStatus Source #

Constructors

Unknown
New
LastUpdate UTCTime

Instances

Pretty FeedStatus Source #
Instance details Defined in Imm.Database.Feed Methods pretty :: FeedStatus -> Doc ann # prettyList :: [FeedStatus] -> Doc ann #

data EntryKey Source #

Constructors

ByLocation FeedLocation
ById Int

Instances

Eq EntryKey Source #
Instance details Defined in Imm.Database.Feed Methods (==) :: EntryKey -> EntryKey -> Bool # (/=) :: EntryKey -> EntryKey -> Bool #
Ord EntryKey Source #
Instance details Defined in Imm.Database.Feed Methods compare :: EntryKey -> EntryKey -> Ordering # (<) :: EntryKey -> EntryKey -> Bool # (<=) :: EntryKey -> EntryKey -> Bool # (>) :: EntryKey -> EntryKey -> Bool # (>=) :: EntryKey -> EntryKey -> Bool # max :: EntryKey -> EntryKey -> EntryKey # min :: EntryKey -> EntryKey -> EntryKey #
Show EntryKey Source #
Instance details Defined in Imm.Database.Feed Methods showsPrec :: Int -> EntryKey -> ShowS # show :: EntryKey -> String # showList :: [EntryKey] -> ShowS #
Pretty EntryKey Source #
Instance details Defined in Imm.Database.Feed Methods pretty :: EntryKey -> Doc ann # prettyList :: [EntryKey] -> Doc ann #

data Handle m Source #

Constructors

Handle
Fields _describeDatabase :: m (Doc AnsiStyle) _fetch :: [EntryKey] -> m (Map EntryKey (Int, Entry)) _fetchAll :: m (Map Int Entry) _update :: [EntryKey] -> (Entry -> Entry) -> m () _insert :: [Entry] -> m (Map FeedLocation Int) _delete :: [EntryKey] -> m () _purge :: m () _commit :: m ()

readOnly :: Monad m => Handle m -> Handle m -> Handle m Source #

data DatabaseException Source #

Constructors

NotCommitted
NotDeleted [FeedLocation]
KeyNotFound [EntryKey]
NotInserted [Entry]
NotPurged
NotUpdated FeedLocation
UnableFetchAll

Instances

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

Low-level primitives

fetch1 :: Monad m => MonadThrow m => Handle m -> EntryKey -> m (Int, Entry) Source #

fetch :: Monad m => Handle m -> [EntryKey] -> m (Map EntryKey (Int, Entry)) Source #

fetchQuery :: Monad m => Handle m -> (Int -> Entry -> Bool) -> m (Map Int Entry) Source #

fetchAll :: Monad m => Handle m -> m (Map Int Entry) Source #

update :: Monad m => Handle m -> [EntryKey] -> (Entry -> Entry) -> m () Source #

insert :: MonadThrow m => Handle m -> Handle m -> Entry -> m Int Source #

insertList :: Monad m => Handle m -> Handle m -> [Entry] -> m (Map FeedLocation Int) Source #

delete1 :: Monad m => Handle m -> Handle m -> EntryKey -> m () Source #

delete :: Monad m => Handle m -> Handle m -> [EntryKey] -> m () Source #

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

commit :: Monad m => Handle m -> Handle m -> m () Source #

High-level queries

register :: MonadThrow m => Handle m -> Handle m -> FeedLocation -> Set Text -> m Int Source #

getStatus :: MonadCatch m => Handle m -> EntryKey -> m FeedStatus Source #

markAsProcessed :: MonadThrow m => MonadTime m => Handle m -> Handle m -> EntryKey -> FeedElement -> m () Source #

markAsUnprocessed :: MonadThrow m => Handle m -> Handle m -> EntryKey -> m () Source #

listUnprocessedElements :: MonadThrow m => Handle m -> EntryKey -> m [FeedElement] Source #

isRead :: MonadCatch m => Handle m -> EntryKey -> FeedElement -> m Bool Source #

resolveEntryKey :: Monad m => Handle m -> FeedQuery -> m [EntryKey] Source #

resolveFeedLocation :: Monad m => Handle m -> EntryKey -> m FeedLocation Source #