Categorygithub.com/hashicorp/raft-mdb
modulepackage
0.0.0-20230125174814-72c811a7bc28
Repository: https://github.com/hashicorp/raft-mdb.git
Documentation: pkg.go.dev

# README

raft-mdb Build Status

This repository provides the raftmdb package. The package exports the MDBStore which is an implementation of both a LogStore and StableStore.

It is meant to be used as a backend for the raft package here.

This implementation uses LMDB. LMDB has a number of advantages to other embedded databases includes transactions, MVCC, and lack of compaction.

The one disadvantage is because it is a C library, it requires the use of cgo which complicates cross compilation. For that reason, this is in a separate package from raft, so that clients can avoid cgo if they so choose.

Documentation

The documentation for this package can be found on Godoc here.

# Functions

NewMDBStore returns a new MDBStore and potential error.
NewMDBStore returns a new MDBStore and potential error.

# Structs

MDBStore provides an implementation of LogStore and StableStore, all backed by a single MDB database.