ouroboros-consensus-0.26.0.0: Consensus layer for the Ouroboros blockchain protocol
Safe HaskellNone
LanguageHaskell2010

Ouroboros.Consensus.Storage.LedgerDB.Args

Description

Arguments for LedgerDB initialization.

Synopsis

Documentation

data LedgerDbArgs (f ∷ TypeType) (m ∷ TypeType) blk Source #

Arguments required to initialize a LedgerDB.

Constructors

LedgerDbArgs 

Fields

data QueryBatchSize Source #

The maximum number of keys to read in a backing store range query.

When performing a ledger state query that involves on-disk parts of the ledger state, we might have to read ranges of key-value pair data (e.g., UTxO) from disk using backing store range queries. Instead of reading all data in one go, we read it in batches. QueryBatchSize determines the size of these batches.

INVARIANT: Should be at least 1.

It is fine if the result of a range read contains less than this number of keys, but it should never return more.

Constructors

DefaultQueryBatchSize

A default value, which is determined by a specific QueryBatchSize. See defaultQueryBatchSize as an example.

RequestedQueryBatchSize Word64

A requested value: the number of keys to read from disk in each batch.

Instances

Instances details
Generic QueryBatchSize Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.Args

Associated Types

type Rep QueryBatchSize 
Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.Args

type Rep QueryBatchSize = D1 ('MetaData "QueryBatchSize" "Ouroboros.Consensus.Storage.LedgerDB.Args" "ouroboros-consensus-0.26.0.0-inplace" 'False) (C1 ('MetaCons "DefaultQueryBatchSize" 'PrefixI 'False) (U1TypeType) :+: C1 ('MetaCons "RequestedQueryBatchSize" 'PrefixI 'False) (S1 ('MetaSel ('NothingMaybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))
Show QueryBatchSize Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.Args

Eq QueryBatchSize Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.Args

NoThunks QueryBatchSize Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.Args

type Rep QueryBatchSize Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.Args

type Rep QueryBatchSize = D1 ('MetaData "QueryBatchSize" "Ouroboros.Consensus.Storage.LedgerDB.Args" "ouroboros-consensus-0.26.0.0-inplace" 'False) (C1 ('MetaCons "DefaultQueryBatchSize" 'PrefixI 'False) (U1TypeType) :+: C1 ('MetaCons "RequestedQueryBatchSize" 'PrefixI 'False) (S1 ('MetaSel ('NothingMaybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

defaultArgs ∷ ∀ (m ∷ TypeType) blk. Applicative m ⇒ Incomplete LedgerDbArgs m blk Source #

Default arguments