Safe Haskell	None
Language	Haskell2010

Cardano.Tools.DBAnalyser.Types

Synopsis

defaultLSMDatabasePath ∷ FilePath
defaultLSMExportPath ∷ FilePath
selectLedgerDBBackend ∷ Maybe LedgerDBBackendFlags → Maybe LedgerDBBackend → Maybe LedgerDBBackend
data AnalysisName
data AnalysisResult
- = ResultCountBlock Int
- | ResultMaxHeaderSize Word16
data DBAnalyserConfig = DBAnalyserConfig {
- dbDir ∷ FilePath
- verbose ∷ Bool
- selectDB ∷ SelectDB
- validation ∷ Maybe ValidateBlocks
- analysis ∷ AnalysisName
- confLimit ∷ Limit
- ldbBackend ∷ Maybe LedgerDBBackendFlags
}
data LSMFlags = LSMFlags {
- lsmExportFlag ∷ Bool
- lsmNoDiskCacheFlag ∷ Bool
}
data LSMOptions = LSMOptions {
- lsmDatabasePath ∷ FilePath
- lsmExportPath ∷ Maybe FilePath
- lsmNoDiskCache ∷ Bool
}
data LedgerApplicationMode
- = LedgerReapply
- | LedgerApply
data LedgerDBBackend
- = V2InMem
- | V2LSM LSMOptions
data LedgerDBBackendFlags
- = InMemFlag
- | LSMFlag LSMFlags
data Limit
- = Limit Int
- | Unlimited
newtype NumberOfBlocks = NumberOfBlocks {
- unNumberOfBlocks ∷ Word64
}
data SelectDB = SelectImmutableDB (WithOrigin SlotNo)
data ValidateBlocks
- = ValidateAllBlocks
- | MinimumBlockValidation

Documentation

defaultLSMDatabasePath ∷ FilePath Source #

The directory holding the working LSM database, used when the node configuration file does not set LedgerDB.Backend.LSM.DatabasePath.

defaultLSMExportPath ∷ FilePath Source #

The directory that --lsm-export exports snapshots into, when the node configuration file does not set LedgerDB.Backend.LSM.ExportPath.

selectLedgerDBBackend ∷ Maybe LedgerDBBackendFlags → Maybe LedgerDBBackend → Maybe LedgerDBBackend Source #

The backend to use, from the one the command line selects and the one the node configuration file selects. The command line wins, but --lsm against a configuration that also selects LSM overrides only what its switches set: the paths come from the configuration, and --lsm-export exports into the configured ExportPath when there is one. Against any other configuration, --lsm starts from the defaults.

data AnalysisName Source #

Constructors

ShowSlotBlockNo
CountTxOutputs
ShowBlockHeaderSize
ShowBlockTxsSize
ShowEBBs
OnlyValidation
StoreLedgerStateAt SlotNo LedgerApplicationMode
CountBlocks
CheckNoThunksEvery Word64
TraceLedgerProcessing
BenchmarkLedgerOps (Maybe FilePath) LedgerApplicationMode
ReproMempoolAndForge Int
GetBlockApplicationMetrics NumberOfBlocks (Maybe FilePath)	Compute different block application metrics every `NumberOfBlocks`. The metrics will be written to the provided file path, or to the standard output if no file path is specified.

Instances

Instances details

Show AnalysisName Source #
Instance details Defined in Cardano.Tools.DBAnalyser.Types Methods showsPrec ∷ Int → AnalysisName → ShowS # show ∷ AnalysisName → String # showList ∷ [AnalysisName] → ShowS #

data AnalysisResult Source #

Constructors

ResultCountBlock Int
ResultMaxHeaderSize Word16

Instances

Instances details

Eq AnalysisResult Source #
Instance details Defined in Cardano.Tools.DBAnalyser.Types Methods (==) ∷ AnalysisResult → AnalysisResult → Bool # (/=) ∷ AnalysisResult → AnalysisResult → Bool #
Show AnalysisResult Source #
Instance details Defined in Cardano.Tools.DBAnalyser.Types Methods showsPrec ∷ Int → AnalysisResult → ShowS # show ∷ AnalysisResult → String # showList ∷ [AnalysisResult] → ShowS #

data DBAnalyserConfig Source #

Constructors

DBAnalyserConfig
Fields dbDir ∷ FilePath verbose ∷ Bool selectDB ∷ SelectDB validation ∷ Maybe ValidateBlocks analysis ∷ AnalysisName confLimit ∷ Limit ldbBackend ∷ Maybe LedgerDBBackendFlags The LedgerDB backend selected on the command line. When `Nothing`, the backend and its settings are taken from the node configuration file instead; see `selectLedgerDBBackend`.

data LSMFlags Source #

The switches that accompany --lsm. Each can only turn its setting on, so False leaves the setting as the node configuration file has it.

Constructors

LSMFlags
Fields lsmExportFlag ∷ Bool --lsm-export lsmNoDiskCacheFlag ∷ Bool --lsm-no-cache

data LSMOptions Source #

The settings of the LSM-trees backend.

Constructors

LSMOptions

Fields

lsmDatabasePath ∷ FilePath
The directory, relative to the LedgerDB filesystem root, holding the working LSM database.
lsmExportPath ∷ Maybe FilePath
The directory, relative to the LedgerDB filesystem root, into which the LSM backend exports snapshots as it takes them. When Nothing, snapshots are not exported.
lsmNoDiskCache ∷ Bool
Bypass the OS page cache for UTxO table reads/writes (instead of caching all). Intended for benchmarking.

data LedgerApplicationMode Source #

Whether to apply blocks to a ledger state via reapplication (eg skipping signature checksPlutus scripts) or full application/ (much slower).

Constructors

LedgerReapply
LedgerApply

Instances

Instances details

Eq LedgerApplicationMode Source #
Instance details Defined in Cardano.Tools.DBAnalyser.Types Methods (==) ∷ LedgerApplicationMode → LedgerApplicationMode → Bool # (/=) ∷ LedgerApplicationMode → LedgerApplicationMode → Bool #
Show LedgerApplicationMode Source #
Instance details Defined in Cardano.Tools.DBAnalyser.Types Methods showsPrec ∷ Int → LedgerApplicationMode → ShowS # show ∷ LedgerApplicationMode → String # showList ∷ [LedgerApplicationMode] → ShowS #

data LedgerDBBackend Source #

Constructors

V2InMem
V2LSM LSMOptions

data LedgerDBBackendFlags Source #

The LedgerDB backend as the command line selects it: --in-mem, or --lsm with its switches.

Constructors

InMemFlag
LSMFlag LSMFlags

data Limit Source #

Constructors

Limit Int
Unlimited

newtype NumberOfBlocks Source #

Constructors

NumberOfBlocks
Fields unNumberOfBlocks ∷ Word64

Instances

Instances details

Eq NumberOfBlocks Source #
Instance details Defined in Cardano.Tools.DBAnalyser.Types Methods (==) ∷ NumberOfBlocks → NumberOfBlocks → Bool # (/=) ∷ NumberOfBlocks → NumberOfBlocks → Bool #
Num NumberOfBlocks Source #
Instance details Defined in Cardano.Tools.DBAnalyser.Types Methods (+) ∷ NumberOfBlocks → NumberOfBlocks → NumberOfBlocks # (-) ∷ NumberOfBlocks → NumberOfBlocks → NumberOfBlocks # (*) ∷ NumberOfBlocks → NumberOfBlocks → NumberOfBlocks # negate ∷ NumberOfBlocks → NumberOfBlocks # abs ∷ NumberOfBlocks → NumberOfBlocks # signum ∷ NumberOfBlocks → NumberOfBlocks # fromInteger ∷ Integer → NumberOfBlocks #
Read NumberOfBlocks Source #
Instance details Defined in Cardano.Tools.DBAnalyser.Types Methods readsPrec ∷ Int → ReadS NumberOfBlocks # readList ∷ ReadS [NumberOfBlocks] # readPrec ∷ ReadPrec NumberOfBlocks # readListPrec ∷ ReadPrec [NumberOfBlocks] #
Show NumberOfBlocks Source #
Instance details Defined in Cardano.Tools.DBAnalyser.Types Methods showsPrec ∷ Int → NumberOfBlocks → ShowS # show ∷ NumberOfBlocks → String # showList ∷ [NumberOfBlocks] → ShowS #

data SelectDB Source #

Constructors

SelectImmutableDB (WithOrigin SlotNo)

data ValidateBlocks Source #

The extent of the ChainDB on-disk files validation. This is completely unrelated to validation of the ledger rules.

Constructors

ValidateAllBlocks
MinimumBlockValidation