Categorygithub.com/polygon-io/raft-badger
modulepackage
0.1.4
Repository: https://github.com/polygon-io/raft-badger.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
7
Dependents
0
Files
305 SLOC

# README

Build Status Coverage GoReport GoDoc

raft-badger

This repository provides the raftbadger package. The package exports the BadgerStore 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 BadgerDB. BadgerDB is a simple persistent key-value store written in pure Go. It has a Log-Structured-Merge (LSM) design and it's meant to be a performant alternative to non-Go based stores like RocksDB.

Documentation

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

Contributions

Contributions are very welcome, see CONTRIBUTING.md or skim existing tickets to see where you could help out.

License

raft-badger is Open Source and available under the Apache 2 License.

# Functions

New uses the supplied options to open the Badger db and prepare it for use as a raft backend.
NewBadgerStore takes a file path and returns a connected Raft backend.

# Variables

ErrKeyNotFound is an error indicating a given key does not exist.

# Structs

BadgerStore provides access to Badger for Raft to store and retrieve log entries.
Options contains all the configuration used to open the Badger db.