documentation for keep-tx-metadata flag

Author: Cmdv

cardano-db-sync/app/cardano-db-sync.hs

@@ -7,6 +7,7 @@ import Cardano.DbSync.Config
 import Cardano.DbSync.Metrics (withMetricSetters)
 import Cardano.Prelude
 import Cardano.Slotting.Slot (SlotNo (..))
+import Data.List.Split (splitOn)
 import Data.String (String)
 import qualified Data.Text as Text
 import Data.Version (showVersion)
@@ -231,13 +232,17 @@ pSlotNo =
 
 pKeepTxMetadata :: Parser [Word64]
 pKeepTxMetadata =
-  Opt.many
-    ( Opt.option
-        Opt.auto
-        ( Opt.long "keep-tx-metadata"
-            <> Opt.help "Insert a specific set of tx metadata, based on the tx metadata key names"
-        )
+  Opt.option
+    (parseCommaSeparated <$> Opt.str)
+    ( Opt.long "keep-tx-metadata"
+        <> Opt.help "Insert a specific set of tx metadata, based on the tx metadata key names"
     )
+  where
+    parseCommaSeparated :: String -> [Word64]
+    parseCommaSeparated str =
+      case traverse readMaybe (splitOn "," str) of
+        Just values -> values
+        Nothing -> error "Failed to parse comma-separated values"
 
 pHasInOut :: Parser Bool
 pHasInOut =

cardano-db-sync/cardano-db-sync.cabal

@@ -254,6 +254,7 @@ executable cardano-db-sync
                       , cardano-prelude
                       , cardano-slotting
                       , optparse-applicative
+                      , split
                       , text
 
 executable http-get-json-metadata

cardano-db-sync/src/Cardano/DbSync.hs

@@ -235,13 +235,13 @@ extractSyncOptions snp aop =
   where
     maybeKeepMNames =
       if null (enpKeepMetadataNames snp)
-        then Strict.Just (enpKeepMetadataNames snp)
-        else Strict.Nothing
+        then Strict.Nothing
+        else Strict.Just (enpKeepMetadataNames snp)
 
     iopts
       | enpOnlyGov snp = onlyGovInsertOptions useLedger
       | enpOnlyUTxO snp = onlyUTxOInsertOptions
-      | enpFullMode snp = fullInsertOptions useLedger maybeKeepMNames
+      | enpFullMode snp = fullInsertOptions useLedger
       | enpDisableAllMode snp = disableAllInsertOptions useLedger
       | otherwise =
           InsertOptions

cardano-db-sync/src/Cardano/DbSync/Api.hs

@@ -199,8 +199,20 @@ getPrunes :: SyncEnv -> Bool
 getPrunes = do
   DB.pcmPruneTxOut . getPruneConsume
 
-fullInsertOptions :: Bool -> Strict.Maybe [Word64] -> InsertOptions
-fullInsertOptions useLedger maybeKeepMNames = InsertOptions True useLedger True True True True maybeKeepMNames True True True
+fullInsertOptions :: Bool -> InsertOptions
+fullInsertOptions useLedger =
+  InsertOptions
+    { ioInOut = True
+    , ioUseLedger = useLedger
+    , ioShelley = True
+    , ioRewards = True
+    , ioMultiAssets = True
+    , ioMetadata = True
+    , ioKeepMetadataNames = Strict.Nothing
+    , ioPlutusExtra = True
+    , ioOffChainPoolData = True
+    , ioGov = True
+    }
 
 onlyUTxOInsertOptions :: InsertOptions
 onlyUTxOInsertOptions =
@@ -221,7 +233,19 @@ onlyGovInsertOptions :: Bool -> InsertOptions
 onlyGovInsertOptions useLedger = (disableAllInsertOptions useLedger) {ioGov = True}
 
 disableAllInsertOptions :: Bool -> InsertOptions
-disableAllInsertOptions useLedger = InsertOptions False useLedger False False False False Strict.Nothing False False False
+disableAllInsertOptions useLedger =
+  InsertOptions
+    { ioInOut = False
+    , ioUseLedger = useLedger
+    , ioShelley = False
+    , ioRewards = False
+    , ioMultiAssets = False
+    , ioMetadata = False
+    , ioKeepMetadataNames = Strict.Nothing
+    , ioPlutusExtra = False
+    , ioOffChainPoolData = False
+    , ioGov = False
+    }
 
 initEpochState :: EpochState
 initEpochState =

doc/configuration.md

@@ -154,3 +154,9 @@ Some field are left empty when using this flag, like
 - `redeemer.script_hash` is left Null
 
 Until the ledger state migration happens any restart requires reusing the `--bootstrap-tx-out` flag. After it's completed the flag can be omitted on restarts.
+
+### --keep-tx-metadata
+
+This flag was introduced in v.13.2.0.0 as all postgres field with the type jsonb were removed to improve insertion performance.
+If they are required and you have database queries against jsonb then activate this flag to re-introduce the type jsonb.
+You can pass multiple values to the flag eg: `--keep-tx-metadata 1,2,3` make sure you are using commas between each key.