Database.Haskey.Alloc.Concurrent.Meta

This module implements data structures and function related to the metadata of the concurrent page allocator.

Documentation

class Value root => Root root

User-defined data root stored inside ConcurrentMeta.

This can be a user-defined collection of Tree roots.

Instances

(Key k, Value v) => Root (Tree k v)

data CurrentMetaPage

Data type used to point to the most recent version of the meta data.

Constructors

Meta1

Meta2

data ConcurrentMeta root

Meta data of the page allocator.

The root type parameter should be a user-defined collection of Tree roots, instantiating the Root type class.

To store store a single tree, use ConcurrentMeta (Tree k v).

Constructors

ConcurrentMeta

Fields

• concurrentMetaRevision :: TxId
• concurrentMetaDataNumPages :: S TypeData PageId
• concurrentMetaIndexNumPages :: S TypeIndex PageId
• concurrentMetaRoot :: root
• concurrentMetaDataFreeTree :: S TypeData FreeTree
• concurrentMetaIndexFreeTree :: S TypeIndex FreeTree
• concurrentMetaOverflowTree :: OverflowTree
• concurrentMetaDataCachedFreePages :: S TypeData [FreePage]
• concurrentMetaIndexCachedFreePages :: S TypeIndex [FreePage]

Instances

Show root => Show (ConcurrentMeta root)

Methods

showsPrec :: Int -> ConcurrentMeta root -> ShowS

show :: ConcurrentMeta root -> String

showList :: [ConcurrentMeta root] -> ShowS

Generic (ConcurrentMeta root)

Associated Types

type Rep (ConcurrentMeta root) :: * -> *

Methods

from :: ConcurrentMeta root -> Rep (ConcurrentMeta root) x

to :: Rep (ConcurrentMeta root) x -> ConcurrentMeta root

Binary root => Binary (ConcurrentMeta root)

Methods

put :: ConcurrentMeta root -> Put

get :: Get (ConcurrentMeta root)

putList :: [ConcurrentMeta root] -> Put

type Rep (ConcurrentMeta root)

type Rep (ConcurrentMeta root) = D1 (MetaData "ConcurrentMeta" "Database.Haskey.Alloc.Concurrent.Meta" "haskey-0.2.0.0-1EosJKVTIA32JYw7HhPTkM" False) (C1 (MetaCons "ConcurrentMeta" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "concurrentMetaRevision") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TxId)) (S1 (MetaSel (Just Symbol "concurrentMetaDataNumPages") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (S TypeData PageId)))) ((:*:) (S1 (MetaSel (Just Symbol "concurrentMetaIndexNumPages") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (S TypeIndex PageId))) (S1 (MetaSel (Just Symbol "concurrentMetaRoot") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 root)))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "concurrentMetaDataFreeTree") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (S TypeData FreeTree))) (S1 (MetaSel (Just Symbol "concurrentMetaIndexFreeTree") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (S TypeIndex FreeTree)))) ((:*:) (S1 (MetaSel (Just Symbol "concurrentMetaOverflowTree") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OverflowTree)) ((:*:) (S1 (MetaSel (Just Symbol "concurrentMetaDataCachedFreePages") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (S TypeData [FreePage]))) (S1 (MetaSel (Just Symbol "concurrentMetaIndexCachedFreePages") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (S TypeIndex [FreePage]))))))))

class StoreM FilePath m => ConcurrentMetaStoreM m where

A class representing the storage requirements of the page allocator.

A store supporting the page allocator should be an instance of this class.

Minimal complete definition

putConcurrentMeta, readConcurrentMeta

Methods

putConcurrentMeta :: Root root => FilePath -> ConcurrentMeta root -> m ()

Write the meta-data structure to a certain page.

readConcurrentMeta :: Root root => FilePath -> Proxy root -> m (Maybe (ConcurrentMeta root))

Try to read the meta-data structure from a handle, or return Nothing if the handle doesn't contain a meta page.

Instances

(Applicative m, Monad m, MonadIO m, MonadCatch m) => ConcurrentMetaStoreM (FileStoreT FilePath m)

Methods

putConcurrentMeta :: Root root => FilePath -> ConcurrentMeta root -> FileStoreT FilePath m ()

readConcurrentMeta :: Root root => FilePath -> Proxy * root -> FileStoreT FilePath m (Maybe (ConcurrentMeta root))

(Applicative m, Monad m, MonadIO m, MonadCatch m) => ConcurrentMetaStoreM (MemoryStoreT FilePath m)

Methods

putConcurrentMeta :: Root root => FilePath -> ConcurrentMeta root -> MemoryStoreT FilePath m ()

readConcurrentMeta :: Root root => FilePath -> Proxy * root -> MemoryStoreT FilePath m (Maybe (ConcurrentMeta root))