Database.Perdure

Documentation

module Database.Perdure.Persistent

module Database.Perdure.Ref

module Database.Perdure.Deref

module Database.Perdure.Rev

module Database.Perdure.SizeRef

data LocalStoreFile

A file or raw device where we can persist bytes.

Instances

SyncableStoreFile LocalStoreFile

RawStoreFile LocalStoreFile

withRawDeviceStoreFiles :: [FilePath] -> ([LocalStoreFile] -> IO a) -> ErrorT String IO a

Like nesting multiple calls to withRawDeviceStoreFile.

withRawDeviceStoreFile :: FilePath -> (LocalStoreFile -> IO a) -> ErrorT String IO a

Opens the specified raw device as a LocalStoreFile, runs the provided function and closes the device. Do not make concurrent calls on the same device, place concurrency in the passed function.

withFileStoreFile :: FilePath -> (LocalStoreFile -> IO a) -> ErrorT String IO a

Opens the specified file as a LocalStoreFile, runs the provided function and closes the file. Do not make concurrent calls on the same file, place concurrency in the passed function.

newtype ReplicatedFile

A list of LocalStoreFile to be used as replicates. We write to all replicates and read from the first one that reports no error.

Constructors

ReplicatedFile [LocalStoreFile]

Instances

SyncableStoreFile ReplicatedFile

StoreFile ReplicatedFile

newCachedFile :: Integer -> ReplicatedFile -> IO CachedFile

Wraps a ReplicatedFile with cache of a given size (number of dereferenced DRefs)

data RootLocation

The RootLocation specifies where roots are written, and provides a cache.

defaultRootLocation :: CachedFile -> RootLocation

At the moment this is the only way to create a rootLocation. The root of the database will be located in one of two reserved locations at the start of the specified files.

data PVar s

Represents a persisted database. Contains a (ram-only) lock to sequence multithreaded operations, so only one PVar must be created per RootLocation.

openPVar :: (Typeable s, Persistent s) => RootLocation -> IO (Maybe (PVar s))

Attempts to open a PVar by reading at the given RootLocation. Do not open the same location multiple times, share the PVar instead.

createPVar :: (Typeable s, Persistent s) => s -> Word64 -> RootLocation -> IO (PVar s)

Creates a PVar with the specified initial state. Writes at the specified location, using the given maximum usable space (in bytes).

updatePVar :: (Typeable s, Persistent s) => PVar s -> StateT s IO a -> IO a

Persist a state change

updateInspectPVar :: (Typeable s, Persistent s) => PVar s -> StateT s (ReaderT (PState s) IO) a -> IO a

This function allows read access to the bookkeeping structures of the database. The PState type is subject to change.