Merge pull request #701 from IntersectMBO/wenkokke/doc-table-config

doc: document table configuration

Author: recursion-ninja

README.md

@@ -227,7 +227,7 @@ cmdP = O.subparser $ mconcat
 
 setupOptsP :: O.Parser SetupOpts
 setupOptsP = pure SetupOpts
-    <*> O.option O.auto (O.long "bloom-filter-alloc" <> O.value LSM.defaultBloomFilterAlloc <> O.showDefault <> O.help "Bloom filter allocation method [AllocFixed n | AllocRequestFPR d]")
+    <*> O.option O.auto (O.long "bloom-filter-alloc" <> O.value (LSM.confBloomFilterAlloc LSM.defaultTableConfig) <> O.showDefault <> O.help "Bloom filter allocation method [AllocFixed n | AllocRequestFPR d]")
 
 runOptsP :: O.Parser RunOpts
 runOptsP = pure RunOpts

bench/macro/lsm-tree-bench-wp8.hs

@@ -7,7 +7,8 @@ build-depends:
     , pandoc       ^>=3.6.4
     , text          >=2.1
 -}
-{-# LANGUAGE LambdaCase #-}
+{-# LANGUAGE LambdaCase        #-}
+{-# LANGUAGE OverloadedStrings #-}
 
 module Main (main) where
 
@@ -22,7 +23,7 @@ import qualified Distribution.Types.PackageDescription as PackageDescription
 import           Distribution.Utils.ShortText (fromShortText)
 import           System.IO (hPutStrLn, stderr)
 import           Text.Pandoc (runIOorExplode)
-import           Text.Pandoc.Extensions (githubMarkdownExtensions)
+import           Text.Pandoc.Extensions (getDefaultExtensions)
 import           Text.Pandoc.Options (ReaderOptions (..), WriterOptions (..),
                      def)
 import           Text.Pandoc.Readers (readHaddock)
@@ -45,6 +46,6 @@ main = do
                 runIOorExplode $ do
                     doc1 <- readHaddock def description
                     let doc2 = headerShift 1 doc1
-                    writeMarkdown def{writerExtensions = githubMarkdownExtensions} doc2
+                    writeMarkdown def{writerExtensions = getDefaultExtensions "gfm"} doc2
             let readme = T.unlines [readmeHeaderContent, body]
             TIO.writeFile "README.md" readme

lsm-tree.cabal

@@ -113,13 +113,12 @@ module Database.LSMTree (
   ),
   defaultTableConfig,
   MergePolicy (LazyLevelling),
+  MergeSchedule (..),
   SizeRatio (Four),
   WriteBufferAlloc (AllocNumEntries),
   BloomFilterAlloc (AllocFixed, AllocRequestFPR),
-  defaultBloomFilterAlloc,
   FencePointerIndexType (OrdinaryIndex, CompactIndex),
   DiskCachePolicy (..),
-  MergeSchedule (..),
 
   -- ** Table Configuration Overrides #table_configuration_overrides#
   OverrideDiskCachePolicy (..),
@@ -156,12 +155,6 @@ module Database.LSMTree (
   resolveValidOutput,
   resolveAssociativity,
 
-  -- * Tracer
-  Tracer,
-  LSMTreeTrace (..),
-  TableTrace (..),
-  CursorTrace (..),
-
   -- * Errors #errors#
   SessionDirDoesNotExistError (..),
   SessionDirLockedError (..),
@@ -178,6 +171,24 @@ module Database.LSMTree (
   BlobRefInvalidError (..),
   CursorClosedError (..),
   InvalidSnapshotNameError (..),
+
+  -- * Traces #traces#
+  Tracer,
+  LSMTreeTrace (..),
+  TableTrace (..),
+  CursorTrace (..),
+  MergeTrace (..),
+  CursorId (..),
+  TableId (..),
+  AtLevel (..),
+  LevelNo (..),
+  NumEntries (..),
+  RunNumber (..),
+  MergePolicyForLevel (..),
+  LevelMergeType (..),
+  RunParams (..),
+  RunDataCaching (..),
+  IndexType (..),
 ) where
 
 import           Control.Concurrent.Class.MonadMVar.Strict (MonadMVar)
@@ -203,17 +214,24 @@ import qualified Database.LSMTree.Internal.BlobRef as Internal
 import           Database.LSMTree.Internal.Config
                      (BloomFilterAlloc (AllocFixed, AllocRequestFPR),
                      DiskCachePolicy (..), FencePointerIndexType (..),
-                     MergePolicy (..), MergeSchedule (..), SizeRatio (..),
-                     TableConfig (..), WriteBufferAlloc (..),
-                     defaultBloomFilterAlloc, defaultTableConfig,
-                     serialiseKeyMinimalSize)
+                     LevelNo (..), MergePolicy (..), MergeSchedule (..),
+                     SizeRatio (..), TableConfig (..), WriteBufferAlloc (..),
+                     defaultTableConfig, serialiseKeyMinimalSize)
 import           Database.LSMTree.Internal.Config.Override
                      (OverrideDiskCachePolicy (..))
+import           Database.LSMTree.Internal.Entry (NumEntries (..))
 import qualified Database.LSMTree.Internal.Entry as Entry
+import           Database.LSMTree.Internal.Merge (LevelMergeType (..))
+import           Database.LSMTree.Internal.MergeSchedule (AtLevel (..),
+                     MergePolicyForLevel (..), MergeTrace (..))
 import           Database.LSMTree.Internal.Paths (SnapshotName,
                      isValidSnapshotName, toSnapshotName)
 import           Database.LSMTree.Internal.Range (Range (..))
 import           Database.LSMTree.Internal.RawBytes (RawBytes (..))
+import           Database.LSMTree.Internal.RunBuilder (IndexType (..),
+                     RunDataCaching (..), RunParams (..))
+import           Database.LSMTree.Internal.RunNumber (CursorId (..),
+                     RunNumber (..), TableId (..))
 import qualified Database.LSMTree.Internal.Serialise as Internal
 import           Database.LSMTree.Internal.Serialise.Class (SerialiseKey (..),
                      SerialiseKeyOrderPreserving, SerialiseValue (..),