Safe Haskell	None
Language	Haskell2010

Database.Haskey.Store.InMemory

Contents

Storage
Exceptions

Description

Binary in-memory storage back-end. Can be used as a storage back-end for the append-only page allocator (see Data.BTree.Alloc).

Synopsis

Storage

data Page (t :: PageType) where Source #

A decoded page, of a certain type t of kind PageType.

Constructors

EmptyPage :: Page TypeEmpty
ConcurrentMetaPage :: Root root => ConcurrentMeta root -> Page TypeConcurrentMeta
OverflowPage :: Value v => v -> Page TypeOverflow
LeafNodePage :: (Key k, Value v) => Height Z -> Node Z k v -> Page TypeLeafNode
IndexNodePage :: (Key k, Value v) => Height (S h) -> Node (S h) k v -> Page TypeIndexNode

type MemoryFile = Map PageId ByteString Source #

A file containing a collection of pages.

type MemoryFiles fp = MVar (Map fp MemoryFile) Source #

A collection of Files, each associated with a certain fp handle.

This is shareable amongst multiple threads.

data MemoryStoreConfig Source #

Memory store configuration.

The default configuration can be obtained by using defMemoryStoreConfig.

A configuration with a specific page size can be obtained by using memoryStoreConfigWithPageSize.

Constructors

MemoryStoreConfig
Fields memoryStoreConfigPageSize :: !PageSize memoryStoreConfigMaxKeySize :: !Word64 memoryStoreConfigMaxValueSize :: !Word64

Instances

Show MemoryStoreConfig Source #
Methods showsPrec :: Int -> MemoryStoreConfig -> ShowS # show :: MemoryStoreConfig -> String # showList :: [MemoryStoreConfig] -> ShowS #
Monad m => MonadReader MemoryStoreConfig (MemoryStoreT fp m) Source #
Methods ask :: MemoryStoreT fp m MemoryStoreConfig # local :: (MemoryStoreConfig -> MemoryStoreConfig) -> MemoryStoreT fp m a -> MemoryStoreT fp m a # reader :: (MemoryStoreConfig -> a) -> MemoryStoreT fp m a #

defMemoryStoreConfig :: MemoryStoreConfig Source #

The default configuration.

This is an unwrapped memoryStoreConfigWithPageSize with a page size of 4096.

memoryStoreConfigWithPageSize :: PageSize -> Maybe MemoryStoreConfig Source #

Create a configuration with a specific page size.

The maximum key and value sizes are calculated using calculateMaxKeySize and calculateMaxValueSize.

If the page size is too small, Nothing is returned.

data MemoryStoreT fp m a Source #

Monad in which binary storage operations can take place.

Two important instances are StoreM making it a storage back-end, and ConcurrentMetaStoreM making it a storage back-end compatible with the concurrent page allocator.

Instances

Monad m => MonadReader MemoryStoreConfig (MemoryStoreT fp m) Source #
Methods ask :: MemoryStoreT fp m MemoryStoreConfig # local :: (MemoryStoreConfig -> MemoryStoreConfig) -> MemoryStoreT fp m a -> MemoryStoreT fp m a # reader :: (MemoryStoreConfig -> a) -> MemoryStoreT fp m a #
(Applicative m, Monad m, MonadIO m, MonadThrow m, Ord fp, Show fp, Typeable * fp) => StoreM fp (MemoryStoreT fp m) Source #
Methods openHandle :: fp -> MemoryStoreT fp m () Source # lockHandle :: fp -> MemoryStoreT fp m () Source # releaseHandle :: fp -> MemoryStoreT fp m () Source # flushHandle :: fp -> MemoryStoreT fp m () Source # closeHandle :: fp -> MemoryStoreT fp m () Source # removeHandle :: fp -> MemoryStoreT fp m () Source # nodePageSize :: (Key key, Value val) => MemoryStoreT fp m (Height height -> Node height key val -> PageSize) Source # maxPageSize :: MemoryStoreT fp m PageSize Source # maxKeySize :: MemoryStoreT fp m Word64 Source # maxValueSize :: MemoryStoreT fp m Word64 Source # getNodePage :: (Key key, Value val) => fp -> Height height -> Proxy * key -> Proxy * val -> NodeId height key val -> MemoryStoreT fp m (Node height key val) Source # putNodePage :: (Key key, Value val) => fp -> Height height -> NodeId height key val -> Node height key val -> MemoryStoreT fp m () Source # getOverflow :: Value val => fp -> Proxy * val -> MemoryStoreT fp m val Source # putOverflow :: Value val => fp -> val -> MemoryStoreT fp m () Source # listOverflows :: fp -> MemoryStoreT fp m [fp] Source #
Monad m => Monad (MemoryStoreT fp m) Source #
Methods (>>=) :: MemoryStoreT fp m a -> (a -> MemoryStoreT fp m b) -> MemoryStoreT fp m b # (>>) :: MemoryStoreT fp m a -> MemoryStoreT fp m b -> MemoryStoreT fp m b # return :: a -> MemoryStoreT fp m a # fail :: String -> MemoryStoreT fp m a #
Functor m => Functor (MemoryStoreT fp m) Source #
Methods fmap :: (a -> b) -> MemoryStoreT fp m a -> MemoryStoreT fp m b # (<$) :: a -> MemoryStoreT fp m b -> MemoryStoreT fp m a #
Applicative m => Applicative (MemoryStoreT fp m) Source #
Methods pure :: a -> MemoryStoreT fp m a # (<>) :: MemoryStoreT fp m (a -> b) -> MemoryStoreT fp m a -> MemoryStoreT fp m b # liftA2 :: (a -> b -> c) -> MemoryStoreT fp m a -> MemoryStoreT fp m b -> MemoryStoreT fp m c # (>) :: MemoryStoreT fp m a -> MemoryStoreT fp m b -> MemoryStoreT fp m b # (<*) :: MemoryStoreT fp m a -> MemoryStoreT fp m b -> MemoryStoreT fp m a #
MonadIO m => MonadIO (MemoryStoreT fp m) Source #
Methods liftIO :: IO a -> MemoryStoreT fp m a #
MonadThrow m => MonadThrow (MemoryStoreT fp m) Source #
Methods throwM :: Exception e => e -> MemoryStoreT fp m a #
MonadCatch m => MonadCatch (MemoryStoreT fp m) Source #
Methods catch :: Exception e => MemoryStoreT fp m a -> (e -> MemoryStoreT fp m a) -> MemoryStoreT fp m a #
MonadMask m => MonadMask (MemoryStoreT fp m) Source #
Methods mask :: ((forall a. MemoryStoreT fp m a -> MemoryStoreT fp m a) -> MemoryStoreT fp m b) -> MemoryStoreT fp m b # uninterruptibleMask :: ((forall a. MemoryStoreT fp m a -> MemoryStoreT fp m a) -> MemoryStoreT fp m b) -> MemoryStoreT fp m b # generalBracket :: MemoryStoreT fp m a -> (a -> ExitCase b -> MemoryStoreT fp m c) -> (a -> MemoryStoreT fp m b) -> MemoryStoreT fp m (b, c) #
(Applicative m, Monad m, MonadIO m, MonadCatch m) => ConcurrentMetaStoreM (MemoryStoreT FilePath m) Source #
Methods putConcurrentMeta :: Root root => FilePath -> ConcurrentMeta root -> MemoryStoreT FilePath m () Source # readConcurrentMeta :: Root root => FilePath -> Proxy * root -> MemoryStoreT FilePath m (Maybe (ConcurrentMeta root)) Source #

runMemoryStoreT Source #

Arguments

:: MemoryStoreT fp m a	Action to run
-> MemoryStoreConfig	Configuration
-> MemoryFiles fp	Data
-> m a

Run the storage operations in the MemoryStoreT monad, given a collection of Files.

newEmptyMemoryStore :: IO (MemoryFiles hnd) Source #

Construct a store with an empty database with name of type hnd.

Exceptions

newtype FileNotFoundError hnd Source #

Exception thrown when a file is accessed that doesn't exist.

Constructors

FileNotFoundError hnd

Instances

Show hnd => Show (FileNotFoundError hnd) Source #
Methods showsPrec :: Int -> FileNotFoundError hnd -> ShowS # show :: FileNotFoundError hnd -> String # showList :: [FileNotFoundError hnd] -> ShowS #
(Typeable * hnd, Show hnd) => Exception (FileNotFoundError hnd) Source #
Methods toException :: FileNotFoundError hnd -> SomeException # fromException :: SomeException -> Maybe (FileNotFoundError hnd) # displayException :: FileNotFoundError hnd -> String #

data PageNotFoundError hnd Source #

Exception thrown when a page that is accessed doesn't exist.

Constructors

PageNotFoundError hnd PageId

Instances

Show hnd => Show (PageNotFoundError hnd) Source #
Methods showsPrec :: Int -> PageNotFoundError hnd -> ShowS # show :: PageNotFoundError hnd -> String # showList :: [PageNotFoundError hnd] -> ShowS #
(Typeable * hnd, Show hnd) => Exception (PageNotFoundError hnd) Source #
Methods toException :: PageNotFoundError hnd -> SomeException # fromException :: SomeException -> Maybe (PageNotFoundError hnd) # displayException :: PageNotFoundError hnd -> String #

data WrongNodeTypeError Source #

Exception thrown when a node cannot be cast to the right type.

As used in getNodePage.

Constructors

WrongNodeTypeError

Instances

Show WrongNodeTypeError Source #
Methods showsPrec :: Int -> WrongNodeTypeError -> ShowS # show :: WrongNodeTypeError -> String # showList :: [WrongNodeTypeError] -> ShowS #
Exception WrongNodeTypeError Source #
Methods toException :: WrongNodeTypeError -> SomeException # fromException :: SomeException -> Maybe WrongNodeTypeError # displayException :: WrongNodeTypeError -> String #

data WrongOverflowValueError Source #

Exception thrown when a value from an overflow page cannot be cast.

As used in getOverflow.

Constructors

WrongOverflowValueError

Instances

Show WrongOverflowValueError Source #
Methods showsPrec :: Int -> WrongOverflowValueError -> ShowS # show :: WrongOverflowValueError -> String # showList :: [WrongOverflowValueError] -> ShowS #
Exception WrongOverflowValueError Source #
Methods toException :: WrongOverflowValueError -> SomeException # fromException :: SomeException -> Maybe WrongOverflowValueError # displayException :: WrongOverflowValueError -> String #