raftbadger

README

raft-badger

The package exports the BadgerStore which is an implementation of both a LogStore and StableStore on top of Badger, an embeddable, persistent, simple and fast key-value (KV) store, written natively in Go.

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

Documentation

Index

• Variables
• type LogStore
  • func NewLogStore(dir string, opt *badger.Options) (LogStore, error)
• type StableStore
  • func NewStableStore(dir string, opt *badger.Options) (StableStore, error)

Variables

var ErrKeyNotFound = errors.New("not found")

Types

type LogStore

type LogStore interface {
	raft.LogStore
	io.Closer
}

LogStore combines raft.LogStore and io.Closer

func NewLogStore

func NewLogStore(dir string, opt *badger.Options) (LogStore, error)

NewLogStore uses the supplied options to open a log store. badger.DefaultOptions will be used, if nil is passed for opt.

type StableStore

type StableStore interface {
	raft.StableStore
	io.Closer
}

StableStore combines raft.StableStore and io.Closer

func NewStableStore

func NewStableStore(dir string, opt *badger.Options) (StableStore, error)

NewStableStore uses the supplied options to open a stable store. badger.DefaultOptions will be used, if nil is passed for opt.