store

Documentation

Overview

Package store provides the badger db to be used by higher level packages

Index

• type Config
  • func NewConfig(c general.Config) (Config, error)
  • func NewConfigInMem() Config
• type Sequence
• type Store
  • func New(config Config) (Store, error)

Types

type Config

type Config interface {
	// DataPath must return the path of the directory where the database is or will be created
	DataPath() string
}

Config provides config values for store

func NewConfig

func NewConfig(c general.Config) (Config, error)

NewConfig provides a Config

func NewConfigInMem

func NewConfigInMem() Config

NewConfigInMem provides a Config with an empty string DataPath causing an in memory database

type Sequence

type Sequence interface {
	Next() (uint64, error)
}

Sequence provides a way to get ever incressing numbers *** needs to be moved somwhere more general

type Store

type Store interface {
	BadgerDB() *badger.DB
	WriteBuffered(*badger.Entry)
	GetSequence(key []byte) (Sequence, error)
}

Store allows writting, reading and searching records

func New

func New(config Config) (Store, error)

New creates a Store