badger

Documentation

Overview

Package badger implements a CometBFT DB, backed by BadgerDB.

Index

• Constants
• Variables
• func New(fn string, noSuffix bool) (dbm.DB, error)

Constants

const (
	// BackendName is the name of this implementation.
	BackendName = "badger"
)

Variables

var (

	// DBProvider is a DBProvider to be used when initializing
	// a CometBFT node.
	DBProvider node.DBProvider = badgerDBProvider
)

Functions

func New

func New(fn string, noSuffix bool) (dbm.DB, error)

New constructs a new CometBFT DB, backed by a Badger database at the provided path.

Note: This should only be used by CometBFT, all other places that need a K/V store should favor using BadgerDB directly.