Safe Haskell	Safe-Inferred
Language	GHC2021

Database.LSMTree.Internal.Paths

Contents

Table paths
Run paths
Checksums for Run files
Checksums for WriteBuffer files
ForRunFiles abstraction
WriteBuffer paths

Synopsis

newtype SessionRoot = SessionRoot {
- getSessionRoot :: FsPath
}
lockFile :: SessionRoot -> FsPath
lockFileName :: String
metadataFile :: SessionRoot -> FsPath
newtype ActiveDir = ActiveDir {
- getActiveDir :: FsPath
}
activeDir :: SessionRoot -> ActiveDir
runPath :: ActiveDir -> RunNumber -> RunFsPaths
data SnapshotName
toSnapshotName :: String -> SnapshotName
isValidSnapshotName :: String -> Bool
data InvalidSnapshotNameError = ErrInvalidSnapshotName !String
snapshotsDir :: SessionRoot -> FsPath
newtype NamedSnapshotDir = NamedSnapshotDir {
- getNamedSnapshotDir :: FsPath
}
namedSnapshotDir :: SessionRoot -> SnapshotName -> NamedSnapshotDir
newtype SnapshotMetaDataFile = SnapshotMetaDataFile FsPath
snapshotMetaDataFile :: NamedSnapshotDir -> SnapshotMetaDataFile
newtype SnapshotMetaDataChecksumFile = SnapshotMetaDataChecksumFile FsPath
snapshotMetaDataChecksumFile :: NamedSnapshotDir -> SnapshotMetaDataChecksumFile
tableBlobPath :: SessionRoot -> Unique -> FsPath
data RunFsPaths = RunFsPaths {
- runDir :: !FsPath
- runNumber :: !RunNumber
}
pathsForRunFiles :: RunFsPaths -> ForRunFiles FsPath
runKOpsPath :: RunFsPaths -> FsPath
runBlobPath :: RunFsPaths -> FsPath
runFilterPath :: RunFsPaths -> FsPath
runIndexPath :: RunFsPaths -> FsPath
runChecksumsPath :: RunFsPaths -> FsPath
checksumFileNamesForRunFiles :: ForRunFiles ChecksumsFileName
toChecksumsFile :: ForRunFiles CRC32C -> ChecksumsFile
fromChecksumsFile :: ChecksumsFile -> Either String (ForRunFiles CRC32C)
toChecksumsFileForWriteBufferFiles :: (ForKOps CRC32C, ForBlob CRC32C) -> ChecksumsFile
fromChecksumsFileForWriteBufferFiles :: ChecksumsFile -> Either String (ForKOps CRC32C, ForBlob CRC32C)
newtype ForKOps a = ForKOps {
- unForKOps :: a
}
newtype ForBlob a = ForBlob {
- unForBlob :: a
}
newtype ForFilter a = ForFilter {
- unForFilter :: a
}
newtype ForIndex a = ForIndex {
- unForIndex :: a
}
data ForRunFiles a = ForRunFiles {
- forRunKOps :: !(ForKOps a)
- forRunBlob :: !(ForBlob a)
- forRunFilter :: !(ForFilter a)
- forRunIndex :: !(ForIndex a)
}
forRunKOpsRaw :: ForRunFiles a -> a
forRunBlobRaw :: ForRunFiles a -> a
forRunFilterRaw :: ForRunFiles a -> a
forRunIndexRaw :: ForRunFiles a -> a
newtype WriteBufferFsPaths where
- WrapRunFsPaths RunFsPaths
- pattern WriteBufferFsPaths :: FsPath -> RunNumber -> WriteBufferFsPaths
writeBufferKOpsPath :: WriteBufferFsPaths -> FsPath
writeBufferBlobPath :: WriteBufferFsPaths -> FsPath
writeBufferChecksumsPath :: WriteBufferFsPaths -> FsPath
writeBufferFilePathWithExt :: WriteBufferFsPaths -> String -> FsPath

Documentation

newtype SessionRoot Source #

Constructors

SessionRoot
Fields getSessionRoot :: FsPath

Instances

Instances details

Eq SessionRoot Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods (==) :: SessionRoot -> SessionRoot -> Bool # (/=) :: SessionRoot -> SessionRoot -> Bool #

lockFile :: SessionRoot -> FsPath Source #

lockFileName :: String Source #

metadataFile :: SessionRoot -> FsPath Source #

newtype ActiveDir Source #

Constructors

ActiveDir
Fields getActiveDir :: FsPath

activeDir :: SessionRoot -> ActiveDir Source #

runPath :: ActiveDir -> RunNumber -> RunFsPaths Source #

data SnapshotName Source #

Instances

Instances details

IsString SnapshotName Source #	The given string must satisfy `isValidSnapshotName`. Otherwise, `fromString` throws an `InvalidSnapshotNameError`.
Instance details Defined in Database.LSMTree.Internal.Paths Methods fromString :: String -> SnapshotName #
Show SnapshotName Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods showsPrec :: Int -> SnapshotName -> ShowS # show :: SnapshotName -> String # showList :: [SnapshotName] -> ShowS #
Eq SnapshotName Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods (==) :: SnapshotName -> SnapshotName -> Bool # (/=) :: SnapshotName -> SnapshotName -> Bool #
Ord SnapshotName Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods compare :: SnapshotName -> SnapshotName -> Ordering # (<) :: SnapshotName -> SnapshotName -> Bool # (<=) :: SnapshotName -> SnapshotName -> Bool # (>) :: SnapshotName -> SnapshotName -> Bool # (>=) :: SnapshotName -> SnapshotName -> Bool # max :: SnapshotName -> SnapshotName -> SnapshotName # min :: SnapshotName -> SnapshotName -> SnapshotName #

toSnapshotName :: String -> SnapshotName Source #

Create snapshot name.

The given string must satisfy isValidSnapshotName.

Throws the following exceptions:

InvalidSnapshotNameError: If the given string is not a valid snapshot name.

isValidSnapshotName :: String -> Bool Source #

Check if a String would be a valid snapshot name.

Snapshot names consist of lowercase characters, digits, dashes -, and underscores _, and must be between 1 and 64 characters long. >>> isValidSnapshotName "main" True

>>> isValidSnapshotName "temporary-123-test_"
True

>>> isValidSnapshotName "UPPER"
False
>>> isValidSnapshotName "dir/dot.exe"
False
>>> isValidSnapshotName ".."
False
>>> isValidSnapshotName "\\"
False
>>> isValidSnapshotName ""
False
>>> isValidSnapshotName (replicate 100 'a')
False

Snapshot names must be valid directory on both POSIX and Windows. This rules out the following reserved file and directory names on Windows:

>>> isValidSnapshotName "con"
False
>>> isValidSnapshotName "prn"
False
>>> isValidSnapshotName "aux"
False
>>> isValidSnapshotName "nul"
False
>>> isValidSnapshotName "com1" -- "com2", "com3", etc.
False
>>> isValidSnapshotName "lpt1" -- "lpt2", "lpt3", etc.
False

See, e.g., the VBA docs for the "Bad file name or number" error.

data InvalidSnapshotNameError Source #

Constructors

ErrInvalidSnapshotName !String

Instances

Instances details

Exception InvalidSnapshotNameError Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods toException :: InvalidSnapshotNameError -> SomeException # fromException :: SomeException -> Maybe InvalidSnapshotNameError # displayException :: InvalidSnapshotNameError -> String #
Show InvalidSnapshotNameError Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods showsPrec :: Int -> InvalidSnapshotNameError -> ShowS # show :: InvalidSnapshotNameError -> String # showList :: [InvalidSnapshotNameError] -> ShowS #
Eq InvalidSnapshotNameError Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods (==) :: InvalidSnapshotNameError -> InvalidSnapshotNameError -> Bool # (/=) :: InvalidSnapshotNameError -> InvalidSnapshotNameError -> Bool #

snapshotsDir :: SessionRoot -> FsPath Source #

newtype NamedSnapshotDir Source #

The directory for a specific, named snapshot.

Not to be confused with the snapshots directory, which holds all named snapshot directories.

Constructors

NamedSnapshotDir
Fields getNamedSnapshotDir :: FsPath

namedSnapshotDir :: SessionRoot -> SnapshotName -> NamedSnapshotDir Source #

newtype SnapshotMetaDataFile Source #

Constructors

SnapshotMetaDataFile FsPath

snapshotMetaDataFile :: NamedSnapshotDir -> SnapshotMetaDataFile Source #

newtype SnapshotMetaDataChecksumFile Source #

Constructors

SnapshotMetaDataChecksumFile FsPath

snapshotMetaDataChecksumFile :: NamedSnapshotDir -> SnapshotMetaDataChecksumFile Source #

Table paths

tableBlobPath :: SessionRoot -> Unique -> FsPath Source #

The file name for a table's write buffer blob file

Run paths

data RunFsPaths Source #

The (relative) file path locations of all the files used by the run:

The following files exist for a run:

${n}.keyops: the sorted run of key/operation pairs
${n}.blobs: the blob values associated with the key/operations
${n}.filter: a Bloom filter of all the keys in the run
${n}.index: an index from keys to disk page numbers
${n}.checksums: a file listing the crc32c checksums of the other files

The representation doesn't store the full, name, just the number n. Use the accessor functions to get the actual names.

Constructors

RunFsPaths
Fields runDir :: !FsPath The directory that run files live in. runNumber :: !RunNumber

Instances

Instances details

Show RunFsPaths Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods showsPrec :: Int -> RunFsPaths -> ShowS # show :: RunFsPaths -> String # showList :: [RunFsPaths] -> ShowS #
NFData RunFsPaths Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods rnf :: RunFsPaths -> () #

pathsForRunFiles :: RunFsPaths -> ForRunFiles FsPath Source #

Paths to all files associated with this run, except runChecksumsPath.

runKOpsPath :: RunFsPaths -> FsPath Source #

runBlobPath :: RunFsPaths -> FsPath Source #

runFilterPath :: RunFsPaths -> FsPath Source #

runIndexPath :: RunFsPaths -> FsPath Source #

runChecksumsPath :: RunFsPaths -> FsPath Source #

Checksums for Run files

checksumFileNamesForRunFiles :: ForRunFiles ChecksumsFileName Source #

toChecksumsFile :: ForRunFiles CRC32C -> ChecksumsFile Source #

fromChecksumsFile :: ChecksumsFile -> Either String (ForRunFiles CRC32C) Source #

Checksums for WriteBuffer files

toChecksumsFileForWriteBufferFiles :: (ForKOps CRC32C, ForBlob CRC32C) -> ChecksumsFile Source #

fromChecksumsFileForWriteBufferFiles :: ChecksumsFile -> Either String (ForKOps CRC32C, ForBlob CRC32C) Source #

ForRunFiles abstraction

newtype ForKOps a Source #

Constructors

ForKOps
Fields unForKOps :: a

Instances

Instances details

Foldable ForKOps Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods fold :: Monoid m => ForKOps m -> m # foldMap :: Monoid m => (a -> m) -> ForKOps a -> m # foldMap' :: Monoid m => (a -> m) -> ForKOps a -> m # foldr :: (a -> b -> b) -> b -> ForKOps a -> b # foldr' :: (a -> b -> b) -> b -> ForKOps a -> b # foldl :: (b -> a -> b) -> b -> ForKOps a -> b # foldl' :: (b -> a -> b) -> b -> ForKOps a -> b # foldr1 :: (a -> a -> a) -> ForKOps a -> a # foldl1 :: (a -> a -> a) -> ForKOps a -> a # toList :: ForKOps a -> [a] # null :: ForKOps a -> Bool # length :: ForKOps a -> Int # elem :: Eq a => a -> ForKOps a -> Bool # maximum :: Ord a => ForKOps a -> a # minimum :: Ord a => ForKOps a -> a # sum :: Num a => ForKOps a -> a # product :: Num a => ForKOps a -> a #
Traversable ForKOps Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods traverse :: Applicative f => (a -> f b) -> ForKOps a -> f (ForKOps b) # sequenceA :: Applicative f => ForKOps (f a) -> f (ForKOps a) # mapM :: Monad m => (a -> m b) -> ForKOps a -> m (ForKOps b) # sequence :: Monad m => ForKOps (m a) -> m (ForKOps a) #
Functor ForKOps Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods fmap :: (a -> b) -> ForKOps a -> ForKOps b # (<$) :: a -> ForKOps b -> ForKOps a #
Show a => Show (ForKOps a) Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods showsPrec :: Int -> ForKOps a -> ShowS # show :: ForKOps a -> String # showList :: [ForKOps a] -> ShowS #

newtype ForBlob a Source #

Constructors

ForBlob
Fields unForBlob :: a

Instances

Instances details

Foldable ForBlob Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods fold :: Monoid m => ForBlob m -> m # foldMap :: Monoid m => (a -> m) -> ForBlob a -> m # foldMap' :: Monoid m => (a -> m) -> ForBlob a -> m # foldr :: (a -> b -> b) -> b -> ForBlob a -> b # foldr' :: (a -> b -> b) -> b -> ForBlob a -> b # foldl :: (b -> a -> b) -> b -> ForBlob a -> b # foldl' :: (b -> a -> b) -> b -> ForBlob a -> b # foldr1 :: (a -> a -> a) -> ForBlob a -> a # foldl1 :: (a -> a -> a) -> ForBlob a -> a # toList :: ForBlob a -> [a] # null :: ForBlob a -> Bool # length :: ForBlob a -> Int # elem :: Eq a => a -> ForBlob a -> Bool # maximum :: Ord a => ForBlob a -> a # minimum :: Ord a => ForBlob a -> a # sum :: Num a => ForBlob a -> a # product :: Num a => ForBlob a -> a #
Traversable ForBlob Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods traverse :: Applicative f => (a -> f b) -> ForBlob a -> f (ForBlob b) # sequenceA :: Applicative f => ForBlob (f a) -> f (ForBlob a) # mapM :: Monad m => (a -> m b) -> ForBlob a -> m (ForBlob b) # sequence :: Monad m => ForBlob (m a) -> m (ForBlob a) #
Functor ForBlob Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods fmap :: (a -> b) -> ForBlob a -> ForBlob b # (<$) :: a -> ForBlob b -> ForBlob a #
Show a => Show (ForBlob a) Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods showsPrec :: Int -> ForBlob a -> ShowS # show :: ForBlob a -> String # showList :: [ForBlob a] -> ShowS #

newtype ForFilter a Source #

Constructors

ForFilter
Fields unForFilter :: a

Instances

Instances details

Foldable ForFilter Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods fold :: Monoid m => ForFilter m -> m # foldMap :: Monoid m => (a -> m) -> ForFilter a -> m # foldMap' :: Monoid m => (a -> m) -> ForFilter a -> m # foldr :: (a -> b -> b) -> b -> ForFilter a -> b # foldr' :: (a -> b -> b) -> b -> ForFilter a -> b # foldl :: (b -> a -> b) -> b -> ForFilter a -> b # foldl' :: (b -> a -> b) -> b -> ForFilter a -> b # foldr1 :: (a -> a -> a) -> ForFilter a -> a # foldl1 :: (a -> a -> a) -> ForFilter a -> a # toList :: ForFilter a -> [a] # null :: ForFilter a -> Bool # length :: ForFilter a -> Int # elem :: Eq a => a -> ForFilter a -> Bool # maximum :: Ord a => ForFilter a -> a # minimum :: Ord a => ForFilter a -> a # sum :: Num a => ForFilter a -> a # product :: Num a => ForFilter a -> a #
Traversable ForFilter Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods traverse :: Applicative f => (a -> f b) -> ForFilter a -> f (ForFilter b) # sequenceA :: Applicative f => ForFilter (f a) -> f (ForFilter a) # mapM :: Monad m => (a -> m b) -> ForFilter a -> m (ForFilter b) # sequence :: Monad m => ForFilter (m a) -> m (ForFilter a) #
Functor ForFilter Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods fmap :: (a -> b) -> ForFilter a -> ForFilter b # (<$) :: a -> ForFilter b -> ForFilter a #
Show a => Show (ForFilter a) Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods showsPrec :: Int -> ForFilter a -> ShowS # show :: ForFilter a -> String # showList :: [ForFilter a] -> ShowS #

newtype ForIndex a Source #

Constructors

ForIndex
Fields unForIndex :: a

Instances

Instances details

Foldable ForIndex Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods fold :: Monoid m => ForIndex m -> m # foldMap :: Monoid m => (a -> m) -> ForIndex a -> m # foldMap' :: Monoid m => (a -> m) -> ForIndex a -> m # foldr :: (a -> b -> b) -> b -> ForIndex a -> b # foldr' :: (a -> b -> b) -> b -> ForIndex a -> b # foldl :: (b -> a -> b) -> b -> ForIndex a -> b # foldl' :: (b -> a -> b) -> b -> ForIndex a -> b # foldr1 :: (a -> a -> a) -> ForIndex a -> a # foldl1 :: (a -> a -> a) -> ForIndex a -> a # toList :: ForIndex a -> [a] # null :: ForIndex a -> Bool # length :: ForIndex a -> Int # elem :: Eq a => a -> ForIndex a -> Bool # maximum :: Ord a => ForIndex a -> a # minimum :: Ord a => ForIndex a -> a # sum :: Num a => ForIndex a -> a # product :: Num a => ForIndex a -> a #
Traversable ForIndex Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods traverse :: Applicative f => (a -> f b) -> ForIndex a -> f (ForIndex b) # sequenceA :: Applicative f => ForIndex (f a) -> f (ForIndex a) # mapM :: Monad m => (a -> m b) -> ForIndex a -> m (ForIndex b) # sequence :: Monad m => ForIndex (m a) -> m (ForIndex a) #
Functor ForIndex Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods fmap :: (a -> b) -> ForIndex a -> ForIndex b # (<$) :: a -> ForIndex b -> ForIndex a #
Show a => Show (ForIndex a) Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods showsPrec :: Int -> ForIndex a -> ShowS # show :: ForIndex a -> String # showList :: [ForIndex a] -> ShowS #

data ForRunFiles a Source #

Stores something for each run file (except the checksums file), allowing to easily do something for all of them without mixing them up.

Constructors

ForRunFiles
Fields forRunKOps :: !(ForKOps a) forRunBlob :: !(ForBlob a) forRunFilter :: !(ForFilter a) forRunIndex :: !(ForIndex a)

Instances

Instances details

Foldable ForRunFiles Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods fold :: Monoid m => ForRunFiles m -> m # foldMap :: Monoid m => (a -> m) -> ForRunFiles a -> m # foldMap' :: Monoid m => (a -> m) -> ForRunFiles a -> m # foldr :: (a -> b -> b) -> b -> ForRunFiles a -> b # foldr' :: (a -> b -> b) -> b -> ForRunFiles a -> b # foldl :: (b -> a -> b) -> b -> ForRunFiles a -> b # foldl' :: (b -> a -> b) -> b -> ForRunFiles a -> b # foldr1 :: (a -> a -> a) -> ForRunFiles a -> a # foldl1 :: (a -> a -> a) -> ForRunFiles a -> a # toList :: ForRunFiles a -> [a] # null :: ForRunFiles a -> Bool # length :: ForRunFiles a -> Int # elem :: Eq a => a -> ForRunFiles a -> Bool # maximum :: Ord a => ForRunFiles a -> a # minimum :: Ord a => ForRunFiles a -> a # sum :: Num a => ForRunFiles a -> a # product :: Num a => ForRunFiles a -> a #
Traversable ForRunFiles Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods traverse :: Applicative f => (a -> f b) -> ForRunFiles a -> f (ForRunFiles b) # sequenceA :: Applicative f => ForRunFiles (f a) -> f (ForRunFiles a) # mapM :: Monad m => (a -> m b) -> ForRunFiles a -> m (ForRunFiles b) # sequence :: Monad m => ForRunFiles (m a) -> m (ForRunFiles a) #
Applicative ForRunFiles Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods pure :: a -> ForRunFiles a # (<>) :: ForRunFiles (a -> b) -> ForRunFiles a -> ForRunFiles b # liftA2 :: (a -> b -> c) -> ForRunFiles a -> ForRunFiles b -> ForRunFiles c # (>) :: ForRunFiles a -> ForRunFiles b -> ForRunFiles b # (<*) :: ForRunFiles a -> ForRunFiles b -> ForRunFiles a #
Functor ForRunFiles Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods fmap :: (a -> b) -> ForRunFiles a -> ForRunFiles b # (<$) :: a -> ForRunFiles b -> ForRunFiles a #
Show a => Show (ForRunFiles a) Source #
Instance details Defined in Database.LSMTree.Internal.Paths Methods showsPrec :: Int -> ForRunFiles a -> ShowS # show :: ForRunFiles a -> String # showList :: [ForRunFiles a] -> ShowS #

forRunKOpsRaw :: ForRunFiles a -> a Source #

forRunBlobRaw :: ForRunFiles a -> a Source #

forRunFilterRaw :: ForRunFiles a -> a Source #

forRunIndexRaw :: ForRunFiles a -> a Source #

WriteBuffer paths

newtype WriteBufferFsPaths Source #

Constructors

WrapRunFsPaths RunFsPaths

Bundled Patterns

pattern WriteBufferFsPaths :: FsPath -> RunNumber -> WriteBufferFsPaths

writeBufferKOpsPath :: WriteBufferFsPaths -> FsPath Source #

writeBufferBlobPath :: WriteBufferFsPaths -> FsPath Source #

writeBufferChecksumsPath :: WriteBufferFsPaths -> FsPath Source #

writeBufferFilePathWithExt :: WriteBufferFsPaths -> String -> FsPath Source #