Safe Haskell	None
Language	Haskell2010

Database.Liszt

Contents

Writer interface
Reader

Synopsis

openLiszt :: MonadIO m => FilePath -> m LisztHandle
closeLiszt :: MonadIO m => LisztHandle -> m ()
withLiszt :: (MonadIO m, MonadMask m) => FilePath -> (LisztHandle -> m a) -> m a
data LisztHandle
type Key = ByteString
type Tag = Encoding
type Transaction = StateT TransactionState IO
clear :: Key -> Transaction ()
insert :: Serialise a => Key -> a -> Transaction ()
insertTagged :: (Serialise t, Serialise a) => Key -> t -> a -> Transaction ()
insertRaw :: Key -> Tag -> Encoding -> Transaction ()
commit :: MonadIO m => LisztHandle -> Transaction a -> m a
commitFile :: FilePath -> Transaction a -> IO a
data Offset
- = SeqNo !Int
- | FromEnd !Int
- | WineryTag !Schema ![Text] !Scientific
data Request = Request {
- reqKey :: !Key
- reqTimeout :: !Int
- reqLimit :: !Int
- reqFrom :: !Offset
- reqTo :: !Offset
}
defRequest :: Key -> Request
data Connection
withConnection :: String -> Int -> ByteString -> (Connection -> IO r) -> IO r
fetch :: Connection -> Request -> IO [(Int, ByteString, ByteString)]

Documentation

openLiszt :: MonadIO m => FilePath -> m LisztHandle Source #

closeLiszt :: MonadIO m => LisztHandle -> m () Source #

withLiszt :: (MonadIO m, MonadMask m) => FilePath -> (LisztHandle -> m a) -> m a Source #

data LisztHandle Source #

Writer interface

type Key = ByteString Source #

type Tag = Encoding Source #

Tag is an extra value attached to a payload. This can be used to perform a binary search.

type Transaction = StateT TransactionState IO Source #

clear :: Key -> Transaction () Source #

Replace the specified key with an empty list.

insert :: Serialise a => Key -> a -> Transaction () Source #

Insert a value.

insertTagged :: (Serialise t, Serialise a) => Key -> t -> a -> Transaction () Source #

Insert a value with a tag (e.g. timestamp). Tags can be used to perform WineryTag query. Tag values should be monotonically increasing but this is not checked.

insertRaw :: Key -> Tag -> Encoding -> Transaction () Source #

commit :: MonadIO m => LisztHandle -> Transaction a -> m a Source #

commitFile :: FilePath -> Transaction a -> IO a Source #

Commit a Transaction to a file.

Reader

data Offset Source #

Constructors

SeqNo !Int
FromEnd !Int
WineryTag !Schema ![Text] !Scientific

Instances

Show Offset Source #
Instance details Defined in Database.Liszt.Tracker Methods showsPrec :: Int -> Offset -> ShowS # show :: Offset -> String # showList :: [Offset] -> ShowS #
Generic Offset Source #
Instance details Defined in Database.Liszt.Tracker Associated Types type Rep Offset :: * -> * # Methods from :: Offset -> Rep Offset x # to :: Rep Offset x -> Offset #
Serialise Offset Source #
Instance details Defined in Database.Liszt.Tracker Methods schemaVia :: Proxy Offset -> [TypeRep] -> Schema # toEncoding :: Offset -> Encoding # deserialiser :: Deserialiser Offset # constantSize :: Proxy Offset -> Maybe Int #
type Rep Offset Source #
Instance details Defined in Database.Liszt.Tracker type Rep Offset = D1 (MetaData "Offset" "Database.Liszt.Tracker" "liszt-0.1-1cOiQgJXwtqKFMyn5HpvuM" False) (C1 (MetaCons "SeqNo" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) :+: (C1 (MetaCons "FromEnd" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) :+: C1 (MetaCons "WineryTag" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Schema) :: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Text]) :: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Scientific)))))

data Request Source #

Constructors

Request
Fields reqKey :: !Key reqTimeout :: !Int reqLimit :: !Int reqFrom :: !Offset reqTo :: !Offset

Instances

Show Request Source #
Instance details Defined in Database.Liszt.Tracker Methods showsPrec :: Int -> Request -> ShowS # show :: Request -> String # showList :: [Request] -> ShowS #
Generic Request Source #
Instance details Defined in Database.Liszt.Tracker Associated Types type Rep Request :: * -> * # Methods from :: Request -> Rep Request x # to :: Rep Request x -> Request #
Serialise Request Source #
Instance details Defined in Database.Liszt.Tracker Methods schemaVia :: Proxy Request -> [TypeRep] -> Schema # toEncoding :: Request -> Encoding # deserialiser :: Deserialiser Request # constantSize :: Proxy Request -> Maybe Int #
type Rep Request Source #
Instance details Defined in Database.Liszt.Tracker type Rep Request = D1 (MetaData "Request" "Database.Liszt.Tracker" "liszt-0.1-1cOiQgJXwtqKFMyn5HpvuM" False) (C1 (MetaCons "Request" PrefixI True) ((S1 (MetaSel (Just "reqKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Key) :: S1 (MetaSel (Just "reqTimeout") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) :: (S1 (MetaSel (Just "reqLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :: (S1 (MetaSel (Just "reqFrom") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Offset) :: S1 (MetaSel (Just "reqTo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Offset)))))

defRequest :: Key -> Request Source #

data Connection Source #

withConnection :: String -> Int -> ByteString -> (Connection -> IO r) -> IO r Source #

fetch :: Connection -> Request -> IO [(Int, ByteString, ByteString)] Source #