db

Documentation

Index

• func GetRaft(ctx context.Context) *badger.DB
• func Observe(ctx context.Context, prefix []byte, obs func(context.Context, *badger.KVList))
• func Open(ctx context.Context, path string, logLevel ...string) (context.Context, *badger.DB)
• func OpenRaft(ctx context.Context, path string) (context.Context, *badger.DB)
• func Path(dbPath string) string
• func Set(ctx context.Context, p Provider) context.Context
• type Iter
• type IterOpts
• type Provider
  • func Get(ctx context.Context) Provider
• type Txn

Functions

func GetRaft

func GetRaft(ctx context.Context) *badger.DB

func Observe

func Observe(ctx context.Context, prefix []byte, obs func(context.Context, *badger.KVList))

Observe watches for database changes on key prefix and call obs withe changed keys.

func Open

func Open(ctx context.Context, path string, logLevel ...string) (context.Context, *badger.DB)

func OpenRaft

func OpenRaft(ctx context.Context, path string) (context.Context, *badger.DB)

func Path

func Path(dbPath string) string

Path returns full path where badger db is created. We also store socket file to mysql inside dbPath directory to avoid having non badger managed files in its directory we create a subdirectory for badger.

func Set

func Set(ctx context.Context, p Provider) context.Context

Types

type Iter

type Iter interface {
	Rewind()
	Valid() bool
	Next()
	Key() []byte
	Value(value func([]byte) error) error
	Close()
}

type IterOpts

type IterOpts struct {
	Prefix         []byte
	PrefetchValues bool
	PrefetchSize   int
	Reverse        bool
}

type Provider

type Provider interface {
	With(func(db *badger.DB) error) error
	NewTransaction(update bool) Txn
	Txn(update bool, f func(txn Txn) error) error
}

func Get

func Get(ctx context.Context) Provider

type Txn

type Txn interface {
	Set(key, value []byte) error
	SetTTL(key, value []byte, ttl time.Duration) error

	// Get retrieves a key and calls value with the data. When the key is not found
	// and nofFound is present then notFound is called.
	Get(key []byte, value func(val []byte) error, notFound ...func() error) error
	Has(key []byte) bool
	Delete(key []byte, notFound ...func() error) error
	Close() error

	Iter(IterOpts) Iter
}