Moduleouroboros-consensus-4.2.1.0

Ouroboros.Consensus.Storage.LedgerDB.Snapshots

21 types
30 values

Packageouroboros-consensus-4.2.1.0
Exports53
LicenceApache-2.0

patternpattern DoDiskSnapshotChecksum :: Flag "DoDiskSnapshotChecksum"

patternpattern NoDoDiskSnapshotChecksum :: Flag "DoDiskSnapshotChecksum"

valuedecodeLBackwardsCompatible

:: Proxy blk
-> forall s. Decoder s l
-> forall s. Decoder s (HeaderHash blk)
-> forall s. Decoder s l

valuedefaultDeleteSnapshotIfTemporary

:: (MonadCatch m, HasCallStack)
=> SomeHasFS m
-> Tracer m (TraceSnapshotEvent blk)
-> DiskSnapshot
-> m ()

valuedefaultListSnapshots :: Monad m => SomeHasFS m -> m [DiskSnapshot]

valuedefaultSnapshotPolicy

:: SecurityParam
-> SnapshotPolicyArgs
-> SnapshotPolicy

valuedefaultSnapshotPolicyArgs :: SnapshotPolicyArgs

valuedestroySnapshots :: Monad m => SnapshotManager m blk st -> m ()

valuediskSnapshotIsTemporary :: DiskSnapshot -> Bool

valueencodeL :: (l -> Encoding) -> l -> Encoding

valueloadSnapshotMetadata

:: IOLike m
=> SomeHasFS m
-> DiskSnapshot
-> ExceptT MetadataErr m SnapshotMetadata

valuemithrilEpochSize :: Word64

valuemithrilSnapshotPolicyArgs :: SnapshotPolicyArgs

valuenewSnapshotRequestQueue

:: MonadMVar m
=> SnapshotDelayRange
-> m (SnapshotRequestQueue m)

valuereadExtLedgerState

:: IOLike m
=> SomeHasFS m
-> forall s. Decoder s (ExtLedgerState blk EmptyMK)
-> forall s. Decoder s (HeaderHash blk)
-> FsPath
-> ExceptT ReadIncrementalErr m (ExtLedgerState blk EmptyMK, CRC)

valueresolveSnapshotInterval

valuesanityCheckSnapshotPolicyArgs

valuesnapshotFromPath :: String -> Maybe DiskSnapshot

valuesnapshotQueueDelayRange :: SnapshotRequestQueue m -> SnapshotDelayRange

valuesnapshotRequestInFlight :: MonadMVar m => SnapshotRequestQueue m -> m Bool

valuesnapshotToChecksumPath :: DiskSnapshot -> FsPath

valuesnapshotToDirName :: DiskSnapshot -> String

valuesnapshotToDirPath :: DiskSnapshot -> FsPath

valuesnapshotToMetadataPath :: DiskSnapshot -> FsPath

valuesnapshotToStatePath :: DiskSnapshot -> FsPath

valuesnapshotsMapM_

:: Monad m
=> SnapshotManager m blk st
-> DiskSnapshot -> m a
-> m ()

valuetrimSnapshots

:: Monad m
=> SnapshotManager m blk st
-> SnapshotPolicy
-> m [DiskSnapshot]

valuetryEnqueueSnapshotRequest

:: MonadMVar m
=> SnapshotRequestQueue m
-> SnapshotRequest m
-> m Bool

valuetryWithSnapshotRequest

:: (MonadMVar m, MonadThrow m)
=> SnapshotRequestQueue m
-> SnapshotRequest m -> m ()
-> m ()

valuewithSnapshotRequest

:: (MonadMVar m, MonadThrow m)
=> SnapshotRequestQueue m
-> SnapshotRequest m -> m a
-> m a

valuewriteExtLedgerState

:: MonadThrow m
=> SomeHasFS m
-> ExtLedgerState blk EmptyMK -> Encoding
-> FsPath
-> ExtLedgerState blk EmptyMK
-> m CRC

valuewriteSnapshotMetadata

:: MonadThrow m
=> SomeHasFS m
-> DiskSnapshot
-> SnapshotMetadata
-> m ()

datadata DiskSnapshot

Constructors

DiskSnapshot
- dsNumber :: Word64
- dsSuffix :: Maybe String

Instances4Eq, Show, Generic, Rep

Eq DiskSnapshotDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
Show DiskSnapshotDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
Generic DiskSnapshotDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
type Rep DiskSnapshot = D1 ('MetaData "DiskSnapshot" "Ouroboros.Consensus.Storage.LedgerDB.Snapshots" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "DiskSnapshot" 'PrefixI 'True) (S1 ('MetaSel ('Just "dsNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64) :*: S1 ('MetaSel ('Just "dsSuffix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots

datadata MetadataErr

Instances2Eq, Show

Eq MetadataErrDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
Show MetadataErrDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots

newtypenewtype NumOfDiskSnapshots

Constructors

NumOfDiskSnapshots
- getNumOfDiskSnapshots :: Word

Instances4Eq, Show, Generic, Rep

Eq NumOfDiskSnapshotsDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
Show NumOfDiskSnapshotsDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
Generic NumOfDiskSnapshotsDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
type Rep NumOfDiskSnapshots = D1 ('MetaData "NumOfDiskSnapshots" "Ouroboros.Consensus.Storage.LedgerDB.Snapshots" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'True) (C1 ('MetaCons "NumOfDiskSnapshots" 'PrefixI 'True) (S1 ('MetaSel ('Just "getNumOfDiskSnapshots") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word)))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots

datadata ReadSnapshotErr

Constructors

ReadSnapshotFailed ReadIncrementalErr
ReadSnapshotDataCorruption
ReadMetadataError FsPath MetadataErr
ReadSnapshotIsLegacy

Instances2Eq, Show

Eq ReadSnapshotErrDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
Show ReadSnapshotErrDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots

datadata SnapshotBackend

UTxOHDMemSnapshot UTxOHDLMDBSnapshot UTxOHDLSMSnapshot

Instances4Eq, Show, FromJSON, ToJSON

Eq SnapshotBackendDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
Show SnapshotBackendDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
FromJSON SnapshotBackendDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
ToJSON SnapshotBackendDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots

datadata SnapshotDelayRange

Constructors

SnapshotDelayRange
- minimumDelay :: !DiffTime
- maximumDelay :: !DiffTime

Instances5Eq, Show, Generic, NoThunks, Rep

Eq SnapshotDelayRangeDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
Show SnapshotDelayRangeDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
Generic SnapshotDelayRangeDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
NoThunks SnapshotDelayRangeDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
type Rep SnapshotDelayRange = D1 ('MetaData "SnapshotDelayRange" "Ouroboros.Consensus.Storage.LedgerDB.Snapshots" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "SnapshotDelayRange" 'PrefixI 'True) (S1 ('MetaSel ('Just "minimumDelay") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 DiffTime) :*: S1 ('MetaSel ('Just "maximumDelay") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 DiffTime)))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots

datadata SnapshotFailure blk

Constructors

InitFailureRead ReadSnapshotErr
InitFailureTooRecent DiskSnapshot (Point blk)
InitFailureGenesis

Instances4Eq, Show, Generic, Rep

StandardHash blk => Eq (SnapshotFailure blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
StandardHash blk => Show (SnapshotFailure blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
Generic (SnapshotFailure blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
type Rep (SnapshotFailure blk) = D1 ('MetaData "SnapshotFailure" "Ouroboros.Consensus.Storage.LedgerDB.Snapshots" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "InitFailureRead" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ReadSnapshotErr)) :+: (C1 ('MetaCons "InitFailureTooRecent" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DiskSnapshot) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point blk))) :+: C1 ('MetaCons "InitFailureGenesis" 'PrefixI 'False) U1))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots

datadata SnapshotFrequency

Constructors

SnapshotFrequency SnapshotFrequencyArgs
DisableSnapshots

Instances2Eq, Show

Eq SnapshotFrequencyDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
Show SnapshotFrequencyDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots

datadata SnapshotFrequencyArgs

Constructors

SnapshotFrequencyArgs
- sfaInterval :: SnapshotInterval
- sfaOffset :: SlotNo
- sfaRateLimit :: DiffTime
- sfaDelaySnapshotRange :: SnapshotDelayRange

Instances2Eq, Show

Eq SnapshotFrequencyArgsDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
Show SnapshotFrequencyArgsDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots

datadata SnapshotInterval

Constructors

DefaultSnapshotInterval
RequestedSnapshotInterval (NonZero Word64)

Instances2Eq, Show

Eq SnapshotIntervalDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
Show SnapshotIntervalDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots

datadata SnapshotManager (m :: Type -> Type) blk st

Constructors

SnapshotManager
- listSnapshots :: m [DiskSnapshot]
- deleteSnapshotIfTemporary :: DiskSnapshot -> m ()
- takeSnapshot :: Maybe String -> st -> m (Maybe (DiskSnapshot, RealPoint blk))

datadata SnapshotMetadata

Constructors

SnapshotMetadata
- snapshotBackend :: SnapshotBackend
- snapshotChecksum :: CRC
- snapshotTablesCodecVersion :: TablesCodecVersion

Instances4Eq, Show, FromJSON, ToJSON

Eq SnapshotMetadataDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
Show SnapshotMetadataDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
FromJSON SnapshotMetadataDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
ToJSON SnapshotMetadataDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots

datadata SnapshotPolicy

Constructors

SnapshotPolicy
- onDiskNumSnapshots :: NumOfDiskSnapshots
- onDiskSnapshotSelector :: SnapshotSelectorContext -> [SlotNo]
- onDiskSnapshotDelayRange :: SnapshotDelayRange

Instances1NoThunks

NoThunks SnapshotPolicyDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots

datadata SnapshotPolicyArgs

Constructors

SnapshotPolicyArgs
- spaFrequency :: SnapshotFrequency
- spaNum :: NumOfDiskSnapshots

Instances2Eq, Show

Eq SnapshotPolicyArgsDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
Show SnapshotPolicyArgsDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots

datadata SnapshotRequest (m :: Type -> Type)

Constructors

SnapshotRequest
- snapshotRequestedAt :: !Time
- snapshotRequestSlots :: !NonEmpty SlotNo
- writeSnapshots :: !m ()

datadata SnapshotRequestQueue (m :: Type -> Type)

Instances1NoThunks

NoThunks (SnapshotRequestQueue m)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots

datadata SnapshotSelectorContext

Constructors

SnapshotSelectorContext
- sscTimeSinceLast :: Maybe DiffTime
- sscSnapshotSlots :: [SlotNo]

Instances1Show

Show SnapshotSelectorContextDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots

datadata TablesCodecVersion

TablesCodecVersion1

Instances4Eq, Show, FromJSON, ToJSON

Eq TablesCodecVersionDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
Show TablesCodecVersionDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
FromJSON TablesCodecVersionDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
ToJSON TablesCodecVersionDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots

datadata TraceSnapshotEvent blk

Constructors

InvalidSnapshot DiskSnapshot (SnapshotFailure blk)
SnapshotRequestDelayed Time DiffTime (NonEmpty SlotNo)
SnapshotRequestCompleted
TookSnapshot DiskSnapshot (RealPoint blk) EnclosingTimed
DeletedSnapshot DiskSnapshot

Instances4Eq, Show, Generic, Rep

StandardHash blk => Eq (TraceSnapshotEvent blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
StandardHash blk => Show (TraceSnapshotEvent blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
Generic (TraceSnapshotEvent blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots
type Rep (TraceSnapshotEvent blk) = D1 ('MetaData "TraceSnapshotEvent" "Ouroboros.Consensus.Storage.LedgerDB.Snapshots" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) ((C1 ('MetaCons "InvalidSnapshot" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DiskSnapshot) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SnapshotFailure blk))) :+: C1 ('MetaCons "SnapshotRequestDelayed" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Time) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DiffTime) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NonEmpty SlotNo))))) :+: (C1 ('MetaCons "SnapshotRequestCompleted" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "TookSnapshot" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DiskSnapshot) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk)) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 EnclosingTimed))) :+: C1 ('MetaCons "DeletedSnapshot" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DiskSnapshot)))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Snapshots

newtypenewtype Flag (name :: Symbol)

Constructors

Flag
- getFlag :: Bool

Instances4Eq, Show, Generic, Rep

Eq (Flag name)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Util
Show (Flag name)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Util
Generic (Flag name)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Util
type Rep (Flag name) = D1 ('MetaData "Flag" "Ouroboros.Consensus.Util" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'True) (C1 ('MetaCons "Flag" 'PrefixI 'True) (S1 ('MetaSel ('Just "getFlag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Util

datadata CRCError

CRCInvalid CRCNoFile

Instances2Eq, Show

Eq CRCErrorDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Util.CRC
Show CRCErrorDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Util.CRC