update entity, convert runs and make a start on queries

Author: Cmdv

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

@@ -57,7 +57,7 @@ import Ouroboros.Network.NodeToClient (IOManager, withIOManager)
 import Paths_cardano_db_sync (version)
 import System.Directory (createDirectoryIfMissing)
 import Prelude (id)
-import Hasql.Connection as HC
+import qualified Hasql.Connection as HsqlC
 
 runDbSyncNode :: MetricSetters -> [(Text, Text)] -> SyncNodeParams -> SyncNodeConfig -> IO ()
 runDbSyncNode metricsSetters knownMigrations params syncNodeConfigFromFile =
@@ -116,8 +116,7 @@ runDbSync metricsSetters knownMigrations iomgr trce params syncNodeConfigFromFil
     then logInfo trce "All user indexes were created"
     else logInfo trce "New user indexes were not created. They may be created later if necessary."
 
-  let setting = Db.toConnectionSetting pgConfig
-
+  let dbConnectionSetting = Db.toConnectionSetting pgConfig
 
   -- For testing and debugging.
   whenJust (enpMaybeRollback params) $ \slotNo ->
@@ -126,7 +125,7 @@ runDbSync metricsSetters knownMigrations iomgr trce params syncNodeConfigFromFil
     metricsSetters
     trce
     iomgr
-    connectionSetting
+    dbConnectionSetting
     ranMigrations
     (void . runMigration)
     syncNodeConfigFromFile
@@ -154,6 +153,7 @@ runSyncNode ::
   MetricSetters ->
   Trace IO Text ->
   IOManager ->
+  -- | Database connection settings
   Setting ->
   -- | migrations were ran on startup
   Bool ->
@@ -163,7 +163,7 @@ runSyncNode ::
   SyncNodeParams ->
   SyncOptions ->
   IO ()
-runSyncNode metricsSetters trce iomgr connSetting ranMigrations runMigrationFnc syncNodeConfigFromFile syncNodeParams syncOptions = do
+runSyncNode metricsSetters trce iomgr dbConnSetting ranMigrations runMigrationFnc syncNodeConfigFromFile syncNodeParams syncOptions = do
   whenJust maybeLedgerDir $
     \enpLedgerStateDir -> do
       createDirectoryIfMissing True (unLedgerStateDir enpLedgerStateDir)
@@ -174,11 +174,11 @@ runSyncNode metricsSetters trce iomgr connSetting ranMigrations runMigrationFnc
   let useLedger = shouldUseLedger (sioLedger $ dncInsertOptions syncNodeConfigFromFile)
   -- Our main thread
   bracket
-    (runOrThrowIO $ HC.acquire [connSetting])
+    (runOrThrowIO $ HsqlC.acquire [dbConnSetting])
     release
-    (\connection -> do
+    (\dbConn -> do
         runOrThrowIO $ runExceptT $ do
-          let dbEnv = Db.DbEnv connection (dncEnableDbLogging syncNodeConfigFromFile)
+          let dbEnv = Db.DbEnv dbConn (dncEnableDbLogging syncNodeConfigFromFile)
           genCfg <- readCardanoGenesisConfig syncNodeConfigFromFile
           isJsonbInSchema <- queryIsJsonbInSchema dbEnv
           logProtocolMagicId trce $ genesisProtocolMagicId genCfg

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

@@ -124,7 +124,7 @@ getIsConsumedFixed env =
   where
     txOutTableType = getTxOutTableType env
     pcm = soptPruneConsumeMigration $ envOptions env
-    backend = envBackend env
+    backend = envDbEnv env
 
 noneFixed :: FixesRan -> Bool
 noneFixed NoneFixRan = True
@@ -197,7 +197,7 @@ runRemoveJsonbFromSchema
   => SyncEnv
   -> DbAction e m ()
 runRemoveJsonbFromSchema syncEnv = do
-  DB.runDbTx DB.Write transx
+  DB.runDbT DB.Write transx
   where
     dbEnv = envDbEnv syncEnv
     transx = mkDbTransaction "runRemoveJsonbFromSchema" mkCallSite (DB.disableJsonbInSchema (dbConnection dbEnv))
@@ -310,12 +310,12 @@ getDbLatestBlockInfo backend = do
 
 getDbTipBlockNo :: SyncEnv -> IO (Point.WithOrigin BlockNo)
 getDbTipBlockNo env = do
-  mblk <- getDbLatestBlockInfo (envBackend env)
+  mblk <- getDbLatestBlockInfo (envDbEnv env)
   pure $ maybe Point.Origin (Point.At . bBlockNo) mblk
 
 logDbState :: SyncEnv -> IO ()
 logDbState env = do
-  mblk <- getDbLatestBlockInfo (envBackend env)
+  mblk <- getDbLatestBlockInfo (envDbEnv env)
   case mblk of
     Nothing -> logInfo tracer "Database is empty"
     Just tip -> logInfo tracer $ mconcat ["Database tip is at ", showTip tip]
@@ -334,7 +334,7 @@ logDbState env = do
 
 getCurrentTipBlockNo :: SyncEnv -> IO (WithOrigin BlockNo)
 getCurrentTipBlockNo env = do
-  maybeTip <- getDbLatestBlockInfo (envBackend env)
+  maybeTip <- getDbLatestBlockInfo (envDbEnv env)
   case maybeTip of
     Just tip -> pure $ At (bBlockNo tip)
     Nothing -> pure Origin
@@ -487,7 +487,7 @@ getLatestPoints env = do
       verifySnapshotPoint env snapshotPoints
     NoLedger _ -> do
       -- Brings the 5 latest.
-      lastPoints <- DB.runDbIohkNoLogging (envBackend env) DB.queryLatestPoints
+      lastPoints <- DB.runDbIohkNoLogging (envDbEnv env) DB.queryLatestPoints
       pure $ mapMaybe convert lastPoints
   where
     convert (Nothing, _) = Nothing
@@ -499,7 +499,7 @@ verifySnapshotPoint env snapPoints =
   where
     validLedgerFileToPoint :: SnapshotPoint -> IO (Maybe (CardanoPoint, Bool))
     validLedgerFileToPoint (OnDisk lsf) = do
-      hashes <- getSlotHash (envBackend env) (lsfSlotNo lsf)
+      hashes <- getSlotHash (envDbEnv env) (lsfSlotNo lsf)
       let valid = find (\(_, h) -> lsfHash lsf == hashToAnnotation h) hashes
       case valid of
         Just (slot, hash) | slot == lsfSlotNo lsf -> pure $ convertToDiskPoint slot hash
@@ -508,7 +508,7 @@ verifySnapshotPoint env snapPoints =
       case pnt of
         GenesisPoint -> pure Nothing
         BlockPoint slotNo hsh -> do
-          hashes <- getSlotHash (envBackend env) slotNo
+          hashes <- getSlotHash (envDbEnv env) slotNo
           let valid = find (\(_, dbHash) -> getHeaderHash hsh == dbHash) hashes
           case valid of
             Just (dbSlotNo, _) | slotNo == dbSlotNo -> pure $ Just (pnt, True)

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

@@ -52,7 +52,7 @@ insertListBlocks ::
   [CardanoBlock] ->
   IO (Either SyncNodeError ())
 insertListBlocks synEnv blocks = do
-  DB.runDbIohkLogging (envBackend synEnv) tracer
+  DB.runDbIohkLogging (envDbEnv synEnv) tracer
     . runExceptT
     $ traverse_ (applyAndInsertBlockMaybe synEnv tracer) blocks
   where

cardano-db-sync/src/Cardano/DbSync/Era/Universal/Insert/GovAction.hs

@@ -335,7 +335,7 @@ insertCommitteeHash cred = do
 insertDrep :: (MonadBaseControl IO m, MonadIO m) => DRep StandardCrypto -> ReaderT SqlBackend m DB.DrepHashId
 insertDrep = \case
   DRepCredential cred -> insertCredDrepHash cred
-  DRepAlwaysAbstain -> DB.insertAlwaysAbstainDrep
+  DRepAlwaysAbstain -> DB.insertDrepHashAlwaysAbstain
   DRepAlwaysNoConfidence -> DB.insertAlwaysNoConfidence
 
 insertCredDrepHash :: (MonadBaseControl IO m, MonadIO m) => Ledger.Credential 'DRepRole StandardCrypto -> ReaderT SqlBackend m DB.DrepHashId

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

@@ -42,7 +42,7 @@ data SyncInvariant
 
 data SyncNodeError
   = SNErrDefault !Text
-  | SNErrDbTransaction !DB.DbError
+  | SNErrDatabase !DB.DbError
   | SNErrInvariant !Text !SyncInvariant
   | SNEErrBlockMismatch !Word64 !ByteString !ByteString
   | SNErrIgnoreShelleyInitiation
@@ -67,7 +67,7 @@ instance Show SyncNodeError where
   show =
     \case
       SNErrDefault t -> "Error SNErrDefault: " <> show t
-      SNErrDbTransaction err -> "Error SNErrDbTransaction: " <> show err
+      SNErrDatabase err -> "Error SNErrDatabase: " <> show err
       SNErrInvariant loc i -> "Error SNErrInvariant: " <> Show.show loc <> ": " <> show (renderSyncInvariant i)
       SNEErrBlockMismatch blkNo hashDb hashBlk ->
         mconcat

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

@@ -206,8 +206,8 @@ dbSyncProtocols syncEnv metricsSetters tc codecConfig version bversion =
     tracer :: Trace IO Text
     tracer = getTrace syncEnv
 
-    backend :: SqlBackend
-    backend = envDbEnv syncEnv
+    dbEnv :: DB.DbEnv
+    dbEnv = envDbEnv syncEnv
 
     initAction channel = do
       consumedFixed <- getIsConsumedFixed syncEnv
@@ -225,7 +225,7 @@ dbSyncProtocols syncEnv metricsSetters tc codecConfig version bversion =
               (cChainSyncCodec codecs)
               channel
               ( Client.chainSyncClientPeer $
-                  chainSyncClientFixConsumed backend syncEnv wrongEntriesSize
+                  chainSyncClientFixConsumed dbEnv syncEnv wrongEntriesSize
               )
           logInfo tracer $
             mconcat ["Fixed ", textShow fixedEntries, " consumed_by_tx_id wrong entries"]
@@ -237,15 +237,15 @@ dbSyncProtocols syncEnv metricsSetters tc codecConfig version bversion =
       let onlyFix = soptOnlyFix $ envOptions syncEnv
       if noneFixed fr && (onlyFix || not skipFix)
         then do
-          fd <- runDbIohkLogging backend tracer $ getWrongPlutusData tracer
+          fd <- runDbIohkLogging dbEnv tracer $ getWrongPlutusData tracer
           unless (nullData fd) $
             void $
               runPeer
                 localChainSyncTracer
                 (cChainSyncCodec codecs)
                 channel
                 ( Client.chainSyncClientPeer $
-                    chainSyncClientFixData backend tracer fd
+                    chainSyncClientFixData dbEnv tracer fd
                 )
           if onlyFix
             then do
@@ -255,15 +255,15 @@ dbSyncProtocols syncEnv metricsSetters tc codecConfig version bversion =
         else
           if isDataFixed fr && (onlyFix || not skipFix)
             then do
-              ls <- runDbIohkLogging backend tracer $ getWrongPlutusScripts tracer
+              ls <- runDbIohkLogging dbEnv tracer $ getWrongPlutusScripts tracer
               unless (nullPlutusScripts ls) $
                 void $
                   runPeer
                     localChainSyncTracer
                     (cChainSyncCodec codecs)
                     channel
                     ( Client.chainSyncClientPeer $
-                        chainSyncClientFixScripts backend tracer ls
+                        chainSyncClientFixScripts dbEnv tracer ls
                     )
               when onlyFix $ panic "All Good! This error is only thrown to exit db-sync"
               setIsFixed syncEnv AllFixRan
@@ -464,7 +464,7 @@ drainThePipe n0 client = go n0
 
 chainSyncClientFixConsumed ::
   SqlBackend -> SyncEnv -> Word64 -> ChainSyncClient CardanoBlock (Point CardanoBlock) (Tip CardanoBlock) IO Integer
-chainSyncClientFixConsumed backend syncEnv wrongTotalSize = Client.ChainSyncClient $ do
+chainSyncClientFixConsumed dbEnv syncEnv wrongTotalSize = Client.ChainSyncClient $ do
   liftIO $ logInfo tracer "Starting chainsync to fix consumed_by_tx_id Byron entries. See issue https://github.com/IntersectMBO/cardano-db-sync/issues/1821. This makes resyncing unnecessary."
   pure $ Client.SendMsgFindIntersect [genesisPoint] clientStIntersect
   where
@@ -483,7 +483,7 @@ chainSyncClientFixConsumed backend syncEnv wrongTotalSize = Client.ChainSyncClie
     clientStNext (sizeFixedTotal, (sizeFixEntries, fixEntries)) =
       Client.ClientStNext
         { Client.recvMsgRollForward = \blk _tip -> Client.ChainSyncClient $ do
-            mNewEntries <- fixConsumedBy backend syncEnv blk
+            mNewEntries <- fixConsumedBy dbEnv syncEnv blk
             case mNewEntries of
               Nothing -> do
                 fixAccumulatedEntries fixEntries
@@ -501,7 +501,7 @@ chainSyncClientFixConsumed backend syncEnv wrongTotalSize = Client.ChainSyncClie
                 Client.SendMsgRequestNext (pure ()) (clientStNext (sizeFixedTotal, (sizeFixEntries, fixEntries)))
         }
 
-    fixAccumulatedEntries = fixEntriesConsumed backend tracer . concat . reverse
+    fixAccumulatedEntries = fixEntriesConsumed dbEnv tracer . concat . reverse
 
     fixAccumulatedEntriesMaybe :: (Integer, [[FixEntry]]) -> IO (Integer, Integer, [[FixEntry]])
     fixAccumulatedEntriesMaybe (n, entries)
@@ -516,7 +516,7 @@ chainSyncClientFixConsumed backend syncEnv wrongTotalSize = Client.ChainSyncClie
 
 chainSyncClientFixData ::
   SqlBackend -> Trace IO Text -> FixData -> ChainSyncClient CardanoBlock (Point CardanoBlock) (Tip CardanoBlock) IO ()
-chainSyncClientFixData backend tracer fixData = Client.ChainSyncClient $ do
+chainSyncClientFixData dbEnv tracer fixData = Client.ChainSyncClient $ do
   liftIO $ logInfo tracer "Starting chainsync to fix Plutus Data. This will update database values in tables datum and redeemer_data."
   clientStIdle True (sizeFixData fixData) fixData
   where
@@ -566,7 +566,7 @@ chainSyncClientFixData backend tracer fixData = Client.ChainSyncClient $ do
     clientStNext lastSize fdOnPoint fdRest =
       Client.ClientStNext
         { Client.recvMsgRollForward = \blk _tip -> Client.ChainSyncClient $ do
-            runDbIohkLogging backend tracer $ fixPlutusData tracer blk fdOnPoint
+            runDbIohkLogging dbEnv tracer $ fixPlutusData tracer blk fdOnPoint
             clientStIdle False lastSize fdRest
         , Client.recvMsgRollBackward = \_point _tip ->
             Client.ChainSyncClient $
@@ -576,7 +576,7 @@ chainSyncClientFixData backend tracer fixData = Client.ChainSyncClient $ do
 
 chainSyncClientFixScripts ::
   SqlBackend -> Trace IO Text -> FixPlutusScripts -> ChainSyncClient CardanoBlock (Point CardanoBlock) (Tip CardanoBlock) IO ()
-chainSyncClientFixScripts backend tracer fps = Client.ChainSyncClient $ do
+chainSyncClientFixScripts dbEnv tracer fps = Client.ChainSyncClient $ do
   liftIO $ logInfo tracer "Starting chainsync to fix Plutus Scripts. This will update database values in tables script."
   clientStIdle True (sizeFixPlutusScripts fps) fps
   where
@@ -626,7 +626,7 @@ chainSyncClientFixScripts backend tracer fps = Client.ChainSyncClient $ do
     clientStNext lastSize fpsOnPoint fpsRest =
       Client.ClientStNext
         { Client.recvMsgRollForward = \blk _tip -> Client.ChainSyncClient $ do
-            runDbIohkLogging backend tracer $ fixPlutusScripts tracer blk fpsOnPoint
+            runDbIohkLogging dbEnv tracer $ fixPlutusScripts tracer blk fpsOnPoint
             clientStIdle False lastSize fpsRest
         , Client.recvMsgRollBackward = \_point _tip ->
             Client.ChainSyncClient $