Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Storage.ChainDB.Impl.Args

Synopsis

data ChainDbArgs (f ∷ Type → Type) (m ∷ Type → Type) blk = ChainDbArgs {
- cdbImmDbArgs ∷ ImmutableDbArgs f m blk
- cdbVolDbArgs ∷ VolatileDbArgs f m blk
- cdbLgrDbArgs ∷ LedgerDbArgs f m blk
- cdbPerasCertDbArgs ∷ PerasCertDbArgs f m blk
- cdbPerasVoteDbArgs ∷ PerasVoteDbArgs f m blk
- cdbsArgs ∷ ChainDbSpecificArgs f m blk
}
data ChainDbSpecificArgs (f ∷ Type → Type) (m ∷ Type → Type) blk = ChainDbSpecificArgs {
- cdbsBlocksToAddSize ∷ Word
- cdbsGcDelay ∷ DiffTime
- cdbsGcInterval ∷ DiffTime
- cdbsRegistry ∷ HKD f (ResourceRegistry m)
- cdbsTracer ∷ Tracer m (TraceEvent blk)
- cdbsHasFSGsmDB ∷ HKD f (SomeHasFS m)
- cdbsTopLevelConfig ∷ HKD f (TopLevelConfig blk)
- cdbsLoE ∷ GetLoEFragment m blk
- cdbsSnapshotDelayRNG ∷ HKD f StdGen
}
newtype RelativeMountPoint = RelativeMountPoint FilePath
completeChainDbArgs ∷ ∀ blk (m ∷ Type → Type). (ConsensusProtocol (BlockProtocol blk), IOLike m) ⇒ ResourceRegistry m → TopLevelConfig blk → ExtLedgerState blk ValuesMK → ChunkInfo → (blk → Bool) → (RelativeMountPoint → SomeHasFS m) → (RelativeMountPoint → SomeHasFS m) → StdGen → LedgerDbBackendArgs m blk → Incomplete ChainDbArgs m blk → Complete ChainDbArgs m blk
defaultArgs ∷ ∀ (m ∷ Type → Type) blk. (IOLike m, LedgerDbSerialiseConstraints blk, LedgerSupportsProtocol blk, CanUpgradeLedgerTables LedgerState blk) ⇒ Incomplete ChainDbArgs m blk
enableLedgerEvents ∷ ∀ (m ∷ Type → Type) blk. Complete ChainDbArgs m blk → Complete ChainDbArgs m blk
ensureValidateAll ∷ ∀ (f ∷ Type → Type) (m ∷ Type → Type) blk. ChainDbArgs f m blk → ChainDbArgs f m blk
updateQueryBatchSize ∷ ∀ (f ∷ Type → Type) (m ∷ Type → Type) blk. QueryBatchSize → ChainDbArgs f m blk → ChainDbArgs f m blk
updateSnapshotPolicyArgs ∷ ∀ (f ∷ Type → Type) (m ∷ Type → Type) blk. SnapshotPolicyArgs → ChainDbArgs f m blk → ChainDbArgs f m blk
updateTracer ∷ ∀ (m ∷ Type → Type) blk (f ∷ Type → Type). Monad m ⇒ Tracer m (TraceEvent blk) → ChainDbArgs f m blk → ChainDbArgs f m blk

Documentation

data ChainDbArgs (f ∷ Type → Type) (m ∷ Type → Type) blk Source #

Constructors

ChainDbArgs
Fields cdbImmDbArgs ∷ ImmutableDbArgs f m blk cdbVolDbArgs ∷ VolatileDbArgs f m blk cdbLgrDbArgs ∷ LedgerDbArgs f m blk cdbPerasCertDbArgs ∷ PerasCertDbArgs f m blk cdbPerasVoteDbArgs ∷ PerasVoteDbArgs f m blk cdbsArgs ∷ ChainDbSpecificArgs f m blk

data ChainDbSpecificArgs (f ∷ Type → Type) (m ∷ Type → Type) blk Source #

Arguments specific to the ChainDB, not to the ImmutableDB, VolatileDB, or LedgerDB.

Constructors

ChainDbSpecificArgs

Fields

cdbsBlocksToAddSize ∷ Word
Size of the queue used to store asynchronously added blocks. This is the maximum number of blocks that could be kept in memory at the same time when the background thread processing the blocks can't keep up.
cdbsGcDelay ∷ DiffTime
Delay between copying a block to the ImmutableDB and triggering a garbage collection for the corresponding slot on the VolatileDB.
The goal of the delay is to ensure that the write to the ImmutableDB has been flushed to disk before deleting the block from the VolatileDB, so that a crash won't result in the loss of the block.
cdbsGcInterval ∷ DiffTime
Batch all scheduled GCs so that at most one GC happens every cdbsGcInterval.
cdbsRegistry ∷ HKD f (ResourceRegistry m)
cdbsTracer ∷ Tracer m (TraceEvent blk)
cdbsHasFSGsmDB ∷ HKD f (SomeHasFS m)
cdbsTopLevelConfig ∷ HKD f (TopLevelConfig blk)
cdbsLoE ∷ GetLoEFragment m blk
If this is LoEEnabled, it contains an action that returns the current LoE fragment.
cdbsSnapshotDelayRNG ∷ HKD f StdGen
RNG used to randomly determine the duration of snapshot delays

newtype RelativeMountPoint Source #

A relative path for a MountPoint

The root is determined by context.

Constructors

RelativeMountPoint FilePath

completeChainDbArgs Source #

Arguments

∷ ∀ blk (m ∷ Type → Type). (ConsensusProtocol (BlockProtocol blk), IOLike m)
⇒ ResourceRegistry m
→ TopLevelConfig blk
→ ExtLedgerState blk ValuesMK	Initial ledger
→ ChunkInfo
→ (blk → Bool)	Check integrity
→ (RelativeMountPoint → SomeHasFS m)	Immutable FS, see `NodeDatabasePaths`
→ (RelativeMountPoint → SomeHasFS m)	Volatile FS, see `NodeDatabasePaths`
→ StdGen	Randomised snapshot delay RNG
→ LedgerDbBackendArgs m blk
→ Incomplete ChainDbArgs m blk	A set of incomplete arguments, possibly modified wrt `defaultArgs`
→ Complete ChainDbArgs m blk

defaultArgs ∷ ∀ (m ∷ Type → Type) blk. (IOLike m, LedgerDbSerialiseConstraints blk, LedgerSupportsProtocol blk, CanUpgradeLedgerTables LedgerState blk) ⇒ Incomplete ChainDbArgs m blk Source #

Default arguments

See defaultArgs, defaultArgs, defaultArgs, and defaultSpecificArgs for a list of which fields are not given a default and must therefore be set explicitly.

enableLedgerEvents ∷ ∀ (m ∷ Type → Type) blk. Complete ChainDbArgs m blk → Complete ChainDbArgs m blk Source #

ensureValidateAll ∷ ∀ (f ∷ Type → Type) (m ∷ Type → Type) blk. ChainDbArgs f m blk → ChainDbArgs f m blk Source #

updateQueryBatchSize ∷ ∀ (f ∷ Type → Type) (m ∷ Type → Type) blk. QueryBatchSize → ChainDbArgs f m blk → ChainDbArgs f m blk Source #

updateSnapshotPolicyArgs ∷ ∀ (f ∷ Type → Type) (m ∷ Type → Type) blk. SnapshotPolicyArgs → ChainDbArgs f m blk → ChainDbArgs f m blk Source #

updateTracer ∷ ∀ (m ∷ Type → Type) blk (f ∷ Type → Type). Monad m ⇒ Tracer m (TraceEvent blk) → ChainDbArgs f m blk → ChainDbArgs f m blk Source #