db

Documentation

Index

• func GetRaft(ctx context.Context) *badger.DB
• 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 SetKeyChangeObserver(ctx context.Context, obs func(context.Context, *badger.KVList) error)
• type Iter
• type IterOpts
• type Observer
  • func (cb *Observer) Changed(kv *badger.KVList) error
• type Provider
  • func Get(ctx context.Context) Provider
• type Txn

Functions

func GetRaft

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

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 SetKeyChangeObserver

func SetKeyChangeObserver(ctx context.Context, obs func(context.Context, *badger.KVList) error)

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 Observer

type Observer struct {
	Silent   bool
	OnChange func(context.Context, *badger.KVList) error
	// contains filtered or unexported fields
}

func (*Observer) Changed

func (cb *Observer) Changed(kv *badger.KVList) error

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) error
	Close() error

	Iter(IterOpts) Iter
}