Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Cardano.SnapshotConversion

Description

Convert snapshots among different formats. This is exposed in cardano-node as a subcommand and also via the snapshot-converter executable.

Synopsis

data SnapshotsDirectory = SnapshotsDirectory {
- getSnapshotDir ∷ FilePath
}
data ExportedSnapshotPath = ExportedSnapshotPath {
- getExportedSnapshotPath ∷ FilePath
}
data Snapshot = Snapshot {
- snapshotSnapShotDir ∷ SnapshotsDirectoryWithFormat
- snapshotDiskSnapshot ∷ DiskSnapshot
}
data SnapshotsDirectoryWithFormat
- = StandaloneSnapshot SnapshotsDirectory StandaloneFormat
- | ExportedLSMSnapshot SnapshotsDirectory ExportedSnapshotPath
snapshotDirectory ∷ SnapshotsDirectoryWithFormat → SnapshotsDirectory
data StandaloneFormat = Mem
convertSnapshot ∷ Bool → ProtocolInfo (CardanoBlock StandardCrypto) → Snapshot → Snapshot → ExceptT (Error (CardanoBlock StandardCrypto)) IO ()

Documentation

data SnapshotsDirectory Source #

Constructors

SnapshotsDirectory
Fields getSnapshotDir ∷ FilePath

data ExportedSnapshotPath Source #

The directory holding a standalone (exported) LSM snapshot, i.e. the LSM ledger tables exported out of a session via lsm-tree's exportSnapshot.

This is paired with a SnapshotsDirectory that holds the state/meta files, just like the parts of an LSM snapshot inside a running node are split between the ChainDB ledger directory and the LSM session directory.

Constructors

ExportedSnapshotPath
Fields getExportedSnapshotPath ∷ FilePath

data Snapshot Source #

Constructors

Snapshot
Fields snapshotSnapShotDir ∷ SnapshotsDirectoryWithFormat snapshotDiskSnapshot ∷ DiskSnapshot

data SnapshotsDirectoryWithFormat Source #

Constructors

StandaloneSnapshot SnapshotsDirectory StandaloneFormat
ExportedLSMSnapshot SnapshotsDirectory ExportedSnapshotPath	A standalone (exported) LSM snapshot. Conversions never operate on a live LSM database; they only ever read from or write to exported snapshots (see `ExportedSnapshotPath`).

snapshotDirectory ∷ SnapshotsDirectoryWithFormat → SnapshotsDirectory Source #

data StandaloneFormat Source #

Constructors

Mem

convertSnapshot ∷ Bool → ProtocolInfo (CardanoBlock StandardCrypto) → Snapshot → Snapshot → ExceptT (Error (CardanoBlock StandardCrypto)) IO () Source #