badger

Documentation

Overview

Package badger provides a Badger-backed node database.

Index

• Variables
• func CheckSanity(ctx context.Context, cfg *api.Config, display DisplayHelper) error
• func Migrate(cfg *api.Config, helper MigrationHelper) (uint64, error)
• func New(cfg *api.Config) (api.NodeDB, error)
• func RenameNamespace(cfg *api.Config, newNamespace common.Namespace) error
• type DisplayHelper
• type MigrationHelper

Variables

var (
	// ErrVersionNotFound can be returned by the migration helper when the
	// relevant version can't be found in the history database.
	ErrVersionNotFound = fmt.Errorf("version not found")
)

var Factory = &factory{}

Factory is the node database factory for the Badger backend.

Functions

func CheckSanity

func CheckSanity(ctx context.Context, cfg *api.Config, display DisplayHelper) error

CheckSanity checks the sanity of the node database by traversing all stored trees.

func Migrate

func Migrate(cfg *api.Config, helper MigrationHelper) (uint64, error)

Migrate performs forward migrations between database versions.

func New

func New(cfg *api.Config) (api.NodeDB, error)

New creates a new BadgerDB-backed node database.

func RenameNamespace

func RenameNamespace(cfg *api.Config, newNamespace common.Namespace) error

RenameNamespace changes the namespace specified in the database.

Types

type DisplayHelper

type DisplayHelper interface {
	Display(msg string)
	DisplayStepBegin(msg string)
	DisplayStepEnd(msg string)
	DisplayStep(msg string)
	DisplayProgress(msg string, current, total uint64)
}

type MigrationHelper

type MigrationHelper interface {
	DisplayHelper
	GetRootForHash(root hash.Hash, version uint64) ([]node.Root, error)
}