Documentation ¶
Index ¶
- Variables
- type BadgerStore
- func (b *BadgerStore) Close() error
- func (b *BadgerStore) DeleteRange(min, max uint64) error
- func (b *BadgerStore) FirstIndex() (uint64, error)
- func (b *BadgerStore) Get(k []byte) ([]byte, error)
- func (b *BadgerStore) GetLog(idx uint64, log *raft.Log) error
- func (b *BadgerStore) GetUint64(key []byte) (uint64, error)
- func (b *BadgerStore) LastIndex() (uint64, error)
- func (b *BadgerStore) Set(k, v []byte) error
- func (b *BadgerStore) SetUint64(key []byte, val uint64) error
- func (b *BadgerStore) StoreLog(log *raft.Log) error
- func (b *BadgerStore) StoreLogs(logs []*raft.Log) error
- func (b *BadgerStore) Sync() error
Constants ¶
This section is empty.
Variables ¶
var ( // An error indicating a given key does not exist ErrKeyNotFound = errors.New("not found") )
Functions ¶
This section is empty.
Types ¶
type BadgerStore ¶
type BadgerStore struct {
// contains filtered or unexported fields
}
BadgerStore provides access to BadgerDB 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 badger.Options) (*BadgerStore, error)
New uses the supplied options to open the BadgerDB and prepare it for use as a raft backend.
func NewBadgerStore ¶
func NewBadgerStore(path string) (*BadgerStore, error)
NewBadgerStore takes a file path and returns a connected Raft backend.
func (*BadgerStore) Close ¶
func (b *BadgerStore) Close() error
Close is used to gracefully close the DB connection.
func (*BadgerStore) DeleteRange ¶
func (b *BadgerStore) DeleteRange(min, max uint64) error
DeleteRange is used to delete logs within a given range inclusively.
func (*BadgerStore) FirstIndex ¶
func (b *BadgerStore) FirstIndex() (uint64, error)
func (*BadgerStore) Get ¶
func (b *BadgerStore) Get(k []byte) ([]byte, error)
Get is used to retrieve a value from the k/v store by key
func (*BadgerStore) GetLog ¶
func (b *BadgerStore) GetLog(idx uint64, log *raft.Log) error
GetLog is used to retrieve a log from BadgerDB at a given index.
func (*BadgerStore) GetUint64 ¶
func (b *BadgerStore) GetUint64(key []byte) (uint64, error)
GetUint64 is like Get, but handles uint64 values
func (*BadgerStore) LastIndex ¶
func (b *BadgerStore) LastIndex() (uint64, error)
LastIndex returns the last known index from the Raft log.
func (*BadgerStore) Set ¶
func (b *BadgerStore) Set(k, v []byte) error
Set is used to set a key/value set outside of the raft log
func (*BadgerStore) SetUint64 ¶
func (b *BadgerStore) SetUint64(key []byte, val uint64) error
SetUint64 is like Set, but handles uint64 values
func (*BadgerStore) StoreLog ¶
func (b *BadgerStore) StoreLog(log *raft.Log) error
StoreLog is used to store a single raft log
func (*BadgerStore) StoreLogs ¶
func (b *BadgerStore) StoreLogs(logs []*raft.Log) error
StoreLogs is used to store a set of raft logs
func (*BadgerStore) Sync ¶
func (b *BadgerStore) 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.