database

Documentation

Index

• Constants
• Variables
• func CreateDB(directory string, optionalOptions ...badger.Options) (*badger.DB, error)
• func GetBadgerInstance(optionalDirectory ...string) *badger.DB
• type Database
  • func Get(dbPrefix byte, optionalBadger ...*badger.DB) (Database, error)
• type Entry
• type Key
• type KeyOnlyEntry
• type KeyPrefix
• type Value

Constants

const (
	StreamNumGoRoutines = 16
)

Variables

var (
	ErrKeyNotFound = badger.ErrKeyNotFound
)

Functions

func CreateDB

func CreateDB(directory string, optionalOptions ...badger.Options) (*badger.DB, error)

func GetBadgerInstance

func GetBadgerInstance(optionalDirectory ...string) *badger.DB

Types

type Database

type Database interface {
	// Read
	Contains(key Key) (bool, error)
	Get(key Key) (Entry, error)
	GetKeyOnly(key Key) (KeyOnlyEntry, error)

	// Write
	Set(entry Entry) error
	Delete(key Key) error
	DeletePrefix(keyPrefix KeyPrefix) error

	// Iteration
	ForEach(func(entry Entry) (stop bool)) error
	ForEachPrefix(keyPrefix KeyPrefix, do func(entry Entry) (stop bool)) error
	ForEachPrefixKeyOnly(keyPrefix KeyPrefix, do func(entry KeyOnlyEntry) (stop bool)) error
	StreamForEach(func(entry Entry) error) error
	StreamForEachKeyOnly(func(entry KeyOnlyEntry) error) error
	StreamForEachPrefix(keyPrefix KeyPrefix, do func(entry Entry) error) error
	StreamForEachPrefixKeyOnly(keyPrefix KeyPrefix, do func(entry KeyOnlyEntry) error) error

	// Transactions
	Apply(set []Entry, delete []Key) error
}

func Get

func Get(dbPrefix byte, optionalBadger ...*badger.DB) (Database, error)

type Entry

type Entry struct {
	Key   Key
	Value Value
	Meta  byte
	TTL   time.Duration
}

type Key

type Key []byte

type KeyOnlyEntry

type KeyOnlyEntry struct {
	Key  Key
	Meta byte
}

type KeyPrefix

type KeyPrefix []byte

type Value

type Value []byte