Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.LMDB

Contents

Opening a database
Streaming
Exposed for testing

Description

A BackingStore implementation based on LMDB.

Synopsis

data LMDB
class Backend (m ∷ Type → Type) backend (l ∷ LedgerStateKind) where
- data Args (m ∷ Type → Type) backend
- data Trace (m ∷ Type → Type) backend
- isRightBackendForSnapshot ∷ Proxy l → Args m backend → SnapshotBackend → Bool
- newBackingStoreInitialiser ∷ Tracer m SomeBackendTrace → Args m backend → SnapshotsFS m → BackingStoreInitialiser m l
data family Args (m ∷ Type → Type) backend
data LMDBLimits where
- pattern LMDBLimits ∷ Int → Int → Int → LMDBLimits
mkLMDBArgs ∷ ∀ (m ∷ Type → Type) blk a. (MonadIOPrim m, HasLedgerTables (LedgerState blk), IOLike m) ⇒ FlushFrequency → FilePath → LMDBLimits → a → (LedgerDbBackendArgs m blk, a)
data family YieldArgs (m ∷ Type → Type) backend (l ∷ (Type → Type → Type) → Type)
mkLMDBYieldArgs ∷ (HasCallStack, HasLedgerTables l, MemPackIdx l EmptyMK ~ l EmptyMK) ⇒ FilePath → LMDBLimits → l EmptyMK → ResourceRegistry IO → IO (YieldArgs IO LMDB l)
data family SinkArgs (m ∷ Type → Type) backend (l ∷ (Type → Type → Type) → Type)
mkLMDBSinkArgs ∷ (HasCallStack, HasLedgerTables l, MemPackIdx l EmptyMK ~ l EmptyMK) ⇒ FilePath → LMDBLimits → l EmptyMK → ResourceRegistry IO → IO (SinkArgs IO LMDB l)
data LMDBErr
- = LMDBErrNoDbSeqNo
- | LMDBErrNonMonotonicSeq !(WithOrigin SlotNo) !(WithOrigin SlotNo)
- | LMDBErrInitialisingNonEmpty !String
- | LMDBErrInitialisingAlreadyHasState
- | LMDBErrNoValueHandle !Int
- | LMDBErrUnableToReadSeqNo
- | LMDBErrBadRead
- | LMDBErrBadRangeRead
- | LMDBErrDirExists !FilePath
- | LMDBErrDirDoesntExist !FilePath
- | LMDBErrDirIsNotLMDB !FilePath
- | LMDBErrNotADir !FsPath
- | LMDBErrClosed

Opening a database

data LMDB Source #

Instances

Instances details

(Ord (TxIn l), GetTip l, Monad m) ⇒ StreamingBackend m LMDB l Source #

Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.LMDB

Associated Types

data YieldArgs m LMDB l
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.LMDB data YieldArgs m LMDB l = YieldLMDB Int (LedgerBackingStoreValueHandle m l)
data SinkArgs m LMDB l
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.LMDB data SinkArgs m LMDB l = SinkLMDB Int (SlotNo → (l EmptyMK, l EmptyMK) → LedgerTables l DiffMK → m ()) (l EmptyMK → m ())

Methods

yield ∷ Proxy LMDB → YieldArgs m LMDB l → Yield m l Source #

sink ∷ Proxy LMDB → SinkArgs m LMDB l → Sink m l Source #

(HasLedgerTables l, MonadIO m, IOLike m, MemPackIdx l EmptyMK ~ l EmptyMK) ⇒ Backend m LMDB l Source #

Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.LMDB

Associated Types

data Args m LMDB
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.LMDB data Args m LMDB = LMDBBackingStoreArgs FilePath LMDBLimits (Dict MonadIOPrim m)
data Trace m LMDB
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.LMDB data Trace m LMDB = OnDiskBackingStoreInitialise Limits \| OnDiskBackingStoreTrace BackingStoreTrace

Methods

isRightBackendForSnapshot ∷ Proxy l → Args m LMDB → SnapshotBackend → Bool Source #

newBackingStoreInitialiser ∷ Tracer m SomeBackendTrace → Args m LMDB → SnapshotsFS m → BackingStoreInitialiser m l Source #

Show (Trace m LMDB) Source #

Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.LMDB

Methods

showsPrec ∷ Int → Trace m LMDB → ShowS #

show ∷ Trace m LMDB → String #

showList ∷ [Trace m LMDB] → ShowS #

Eq (Trace m LMDB) Source #

Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.LMDB

Methods

(==) ∷ Trace m LMDB → Trace m LMDB → Bool #

(/=) ∷ Trace m LMDB → Trace m LMDB → Bool #

data SinkArgs m LMDB l Source #

Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.LMDB

data SinkArgs m LMDB l = SinkLMDB Int (SlotNo → (l EmptyMK, l EmptyMK) → LedgerTables l DiffMK → m ()) (l EmptyMK → m ())

data YieldArgs m LMDB l Source #

Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.LMDB

data YieldArgs m LMDB l = YieldLMDB Int (LedgerBackingStoreValueHandle m l)

data Args m LMDB Source #

Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.LMDB

data Args m LMDB = LMDBBackingStoreArgs FilePath LMDBLimits (Dict MonadIOPrim m)

data Trace m LMDB Source #

Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.LMDB

data Trace m LMDB

= OnDiskBackingStoreInitialise Limits
| OnDiskBackingStoreTrace BackingStoreTrace

class Backend (m ∷ Type → Type) backend (l ∷ LedgerStateKind) where Source #

Associated Types

data Args (m ∷ Type → Type) backend Source #

data Trace (m ∷ Type → Type) backend Source #

Methods

isRightBackendForSnapshot ∷ Proxy l → Args m backend → SnapshotBackend → Bool Source #

newBackingStoreInitialiser ∷ Tracer m SomeBackendTrace → Args m backend → SnapshotsFS m → BackingStoreInitialiser m l Source #

Instances

Instances details

(IOLike m, HasLedgerTables l, CanUpgradeLedgerTables l, SerializeTablesWithHint l) ⇒ Backend m Mem l

Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.InMemory

Associated Types

data Args m Mem
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.InMemory data Args m Mem = InMemArgs
data Trace m Mem
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.InMemory data Trace m Mem = InMemoryBackingStoreInitialise \| InMemoryBackingStoreTrace BackingStoreTrace

Methods

isRightBackendForSnapshot ∷ Proxy l → Args m Mem → SnapshotBackend → Bool Source #

newBackingStoreInitialiser ∷ Tracer m SomeBackendTrace → Args m Mem → SnapshotsFS m → BackingStoreInitialiser m l Source #

(HasLedgerTables l, MonadIO m, IOLike m, MemPackIdx l EmptyMK ~ l EmptyMK) ⇒ Backend m LMDB l Source #

Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.LMDB

Associated Types

data Args m LMDB
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.LMDB data Args m LMDB = LMDBBackingStoreArgs FilePath LMDBLimits (Dict MonadIOPrim m)
data Trace m LMDB
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.LMDB data Trace m LMDB = OnDiskBackingStoreInitialise Limits \| OnDiskBackingStoreTrace BackingStoreTrace

Methods

isRightBackendForSnapshot ∷ Proxy l → Args m LMDB → SnapshotBackend → Bool Source #

newBackingStoreInitialiser ∷ Tracer m SomeBackendTrace → Args m LMDB → SnapshotsFS m → BackingStoreInitialiser m l Source #

data family Args (m ∷ Type → Type) backend Source #

Instances

Instances details

data Args m Mem
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.InMemory data Args m Mem = InMemArgs
data Args m LMDB Source #
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.LMDB data Args m LMDB = LMDBBackingStoreArgs FilePath LMDBLimits (Dict MonadIOPrim m)

data LMDBLimits where Source #

Bundled Patterns

pattern LMDBLimits ∷ Int → Int → Int → LMDBLimits

Configuration to use for LMDB backing store initialisation.

Keep the following in mind:

lmdbMapSize should be a multiple of the OS page size.
lmdbMaxDatabases should be set to at least 2, since the backing store has 2 internal LMDB databases by default: 1 for the actual tables, and 1 for the database state DbSeqNo.

Instances

Instances details

Show LMDBLimits Source #
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.LMDB Methods showsPrec ∷ Int → LMDBLimits → ShowS # show ∷ LMDBLimits → String # showList ∷ [LMDBLimits] → ShowS #
Eq LMDBLimits Source #
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.LMDB Methods (==) ∷ LMDBLimits → LMDBLimits → Bool # (/=) ∷ LMDBLimits → LMDBLimits → Bool #

mkLMDBArgs ∷ ∀ (m ∷ Type → Type) blk a. (MonadIOPrim m, HasLedgerTables (LedgerState blk), IOLike m) ⇒ FlushFrequency → FilePath → LMDBLimits → a → (LedgerDbBackendArgs m blk, a) Source #

Create arguments for initializing the LedgerDB using the LMDB backend.

Streaming

data family YieldArgs (m ∷ Type → Type) backend (l ∷ (Type → Type → Type) → Type) Source #

Instances

Instances details

data YieldArgs m Mem l
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory data YieldArgs m Mem l = YieldInMemory (MountPoint → SomeHasFS m) FilePath (Decoders l)
data YieldArgs m LMDB l Source #
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.LMDB data YieldArgs m LMDB l = YieldLMDB Int (LedgerBackingStoreValueHandle m l)

mkLMDBYieldArgs ∷ (HasCallStack, HasLedgerTables l, MemPackIdx l EmptyMK ~ l EmptyMK) ⇒ FilePath → LMDBLimits → l EmptyMK → ResourceRegistry IO → IO (YieldArgs IO LMDB l) Source #

Create Yield args for LMDB

data family SinkArgs (m ∷ Type → Type) backend (l ∷ (Type → Type → Type) → Type) Source #

Instances

Instances details

data SinkArgs m Mem l
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory data SinkArgs m Mem l = SinkInMemory Int (TxIn l → Encoding) (TxOut l → Encoding) (SomeHasFS m) FilePath
data SinkArgs m LMDB l Source #
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.LMDB data SinkArgs m LMDB l = SinkLMDB Int (SlotNo → (l EmptyMK, l EmptyMK) → LedgerTables l DiffMK → m ()) (l EmptyMK → m ())

mkLMDBSinkArgs ∷ (HasCallStack, HasLedgerTables l, MemPackIdx l EmptyMK ~ l EmptyMK) ⇒ FilePath → LMDBLimits → l EmptyMK → ResourceRegistry IO → IO (SinkArgs IO LMDB l) Source #

Create Sink args for LMDB

Exposed for testing

data LMDBErr Source #

Errors that can be thrown by LMDB.

WARNING: these errors will be thrown in IO as having a corrupt database is critical for the functioning of Consensus.

Constructors

LMDBErrNoDbSeqNo	The database state can not be found on-disk.
LMDBErrNonMonotonicSeq !(WithOrigin SlotNo) !(WithOrigin SlotNo)	The sequence number of a `Db` should be monotonically increasing across calls to `bsWrite`, since we use `bsWrite` to flush immutable changes. That is, we can only flush with a newer sequence number because the changes should be immutable. Note that this does not mean that values can not be changed in the future, only that we can not change values in the past.
LMDBErrInitialisingNonEmpty !String	The database table that is being initialised is non-empty.
LMDBErrInitialisingAlreadyHasState	The database that is being initialized already had a DbSeqNo table
LMDBErrNoValueHandle !Int	Trying to use a non-existing value handle.
LMDBErrUnableToReadSeqNo	Couldn't create a value handle because we couldn't read the sequence number
LMDBErrBadRead	Failed to read a value from a database table.
LMDBErrBadRangeRead	Failed to read a range of values from a database table.
LMDBErrDirExists !FilePath	A database directory should not exist already.
LMDBErrDirDoesntExist !FilePath	A database directory should exist already.
LMDBErrDirIsNotLMDB !FilePath	The directory exists but is not an LMDB directory!
LMDBErrNotADir !FsPath	What should be a directory is in fact a file
LMDBErrClosed	The database has been closed, so all backing store operations should throw an error.

Instances

Instances details

Exception LMDBErr Source #
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.LMDB Methods toException ∷ LMDBErr → SomeException # fromException ∷ SomeException → Maybe LMDBErr # displayException ∷ LMDBErr → String # backtraceDesired ∷ LMDBErr → Bool #
Show LMDBErr Source #	Show instance for pretty printing `LMDBErr`s as error messages that include: (i) an indication of the probable cause of the error, and (ii) a descriptive error message for the specific `LMDBErr`.
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.BackingStore.Impl.LMDB Methods showsPrec ∷ Int → LMDBErr → ShowS # show ∷ LMDBErr → String # showList ∷ [LMDBErr] → ShowS #