raftboltdb

README

raft-boltdb

This repository provides the raftboltdb package. The package exports the BoltStore 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 BoltDB. BoltDB is a simple key/value store implemented in pure Go, and inspired by LMDB.

Documentation

Index

• Variables
• type BoltStore
  • func New(options Options) (*BoltStore, error)
  • func NewBoltStore(path string) (*BoltStore, error)
  • func (b *BoltStore) Close() error
  • func (b *BoltStore) Delete(k []byte) error
  • func (b *BoltStore) DeleteRange(min, max uint64) error
  • func (b *BoltStore) FirstIndex() (uint64, error)
  • func (b *BoltStore) Get(k []byte) ([]byte, error)
  • func (b *BoltStore) GetLog(idx uint64, log *raft.Log) error
  • func (b *BoltStore) GetUint64(key []byte) (uint64, error)
  • func (b *BoltStore) LastIndex() (uint64, error)
  • func (b *BoltStore) Set(k, v []byte) error
  • func (b *BoltStore) SetUint64(key []byte, val uint64) error
  • func (b *BoltStore) StoreLog(log *raft.Log) error
  • func (b *BoltStore) StoreLogs(logs []*raft.Log) error
  • func (b *BoltStore) Sync() error
• type Options

Variables

var (

	// An error indicating a given key does not exist
	ErrKeyNotFound = errors.New("not found")
)

Types

type BoltStore

type BoltStore struct {
	// contains filtered or unexported fields
}

BoltStore provides access to BoltDB for Raft to store and retrieve log entries. It also provides key/value storage, and can be used as a LogStore and StableStore.

func New

func New(options Options) (*BoltStore, error)

New uses the supplied options to open the BoltDB and prepare it for use as a raft backend.

func NewBoltStore

func NewBoltStore(path string) (*BoltStore, error)

NewBoltStore takes a file path and returns a connected Raft backend.

func (*BoltStore) Close

func (b *BoltStore) Close() error

Close is used to gracefully close the DB connection.

func (*BoltStore) Delete

func (b *BoltStore) Delete(k []byte) error

Delete is used to remove a value from the k/v store by key

func (*BoltStore) DeleteRange

func (b *BoltStore) DeleteRange(min, max uint64) error

DeleteRange is used to delete logs within a given range inclusively.

func (*BoltStore) FirstIndex

func (b *BoltStore) FirstIndex() (uint64, error)

FirstIndex returns the first known index from the Raft log.

func (*BoltStore) Get

func (b *BoltStore) Get(k []byte) ([]byte, error)

Get is used to retrieve a value from the k/v store by key

func (*BoltStore) GetLog

func (b *BoltStore) GetLog(idx uint64, log *raft.Log) error

GetLog is used to retrieve a log from BoltDB at a given index.

func (*BoltStore) GetUint64

func (b *BoltStore) GetUint64(key []byte) (uint64, error)

GetUint64 is like Get, but handles uint64 values

func (*BoltStore) LastIndex

func (b *BoltStore) LastIndex() (uint64, error)

LastIndex returns the last known index from the Raft log.

func (*BoltStore) Set

func (b *BoltStore) Set(k, v []byte) error

Set is used to set a key/value set outside of the raft log

func (*BoltStore) SetUint64

func (b *BoltStore) SetUint64(key []byte, val uint64) error

SetUint64 is like Set, but handles uint64 values

func (*BoltStore) StoreLog

func (b *BoltStore) StoreLog(log *raft.Log) error

StoreLog is used to store a single raft log

func (*BoltStore) StoreLogs

func (b *BoltStore) StoreLogs(logs []*raft.Log) error

StoreLogs is used to store a set of raft logs

func (*BoltStore) Sync

func (b *BoltStore) Sync() error

Sync performs an fsync on the database file handle. This is not necessary under normal operation unless NoSync is enabled, in which this forces the database file to sync against the disk.

type Options

type Options struct {
	// Path is the file path to the BoltDB to use
	Path string

	// BoltOptions contains any specific BoltDB options you might
	// want to specify [e.g. open timeout]
	BoltOptions *bolt.Options

	// NoSync causes the database to skip fsync calls after each
	// write to the log. This is unsafe, so it should be used
	// with caution.
	NoSync bool
}

Options contains all the configuraiton used to open the BoltDB