kv

Documentation

Index

• Constants
• func New(logger *zap.Logger, options basedb.Options) (basedb.IDb, error)
• type BadgerDb
  • func (b *BadgerDb) Badger() *badger.DB
  • func (b *BadgerDb) Close(logger *zap.Logger) error
  • func (b *BadgerDb) CountByCollection(prefix []byte) (int64, error)
  • func (b *BadgerDb) Delete(prefix []byte, key []byte) error
  • func (b *BadgerDb) DeleteByPrefix(prefix []byte) (int, error)
  • func (b *BadgerDb) FullGC(ctx context.Context) error
  • func (b *BadgerDb) Get(prefix []byte, key []byte) (basedb.Obj, bool, error)
  • func (b *BadgerDb) GetAll(logger *zap.Logger, prefix []byte, handler func(int, basedb.Obj) error) error
  • func (b *BadgerDb) GetMany(logger *zap.Logger, prefix []byte, keys [][]byte, ...) error
  • func (b *BadgerDb) QuickGC(ctx context.Context) error
  • func (b *BadgerDb) RemoveAllByCollection(prefix []byte) error
  • func (b *BadgerDb) Set(prefix []byte, key []byte, value []byte) error
  • func (b *BadgerDb) SetMany(prefix []byte, n int, next func(int) (basedb.Obj, error)) error
  • func (b *BadgerDb) Update(fn func(basedb.Txn) error) error

Constants

const (
	// EntryNotFoundError is an error for a storage entry not found
	EntryNotFoundError = "EntryNotFoundError"
)

Functions

func New

func New(logger *zap.Logger, options basedb.Options) (basedb.IDb, error)

New create new instance of Badger db

Types

type BadgerDb

type BadgerDb struct {
	// contains filtered or unexported fields
}

BadgerDb struct

func (*BadgerDb) Badger

func (b *BadgerDb) Badger() *badger.DB

Badger returns the underlying badger.DB

func (*BadgerDb) Close

func (b *BadgerDb) Close(logger *zap.Logger) error

Close closes the database.

func (*BadgerDb) CountByCollection

func (b *BadgerDb) CountByCollection(prefix []byte) (int64, error)

CountByCollection return the object count for all keys under specified prefix(bucket)

func (*BadgerDb) Delete

func (b *BadgerDb) Delete(prefix []byte, key []byte) error

Delete key in specific prefix

func (*BadgerDb) DeleteByPrefix

func (b *BadgerDb) DeleteByPrefix(prefix []byte) (int, error)

DeleteByPrefix all items with this prefix

func (*BadgerDb) FullGC

func (b *BadgerDb) FullGC(ctx context.Context) error

FullGC runs a long garbage collection cycle to reclaim (ideally) all unused disk space. Designed to be called when the database is not being used.

func (*BadgerDb) Get

func (b *BadgerDb) Get(prefix []byte, key []byte) (basedb.Obj, bool, error)

Get return value for specified key

func (*BadgerDb) GetAll

func (b *BadgerDb) GetAll(logger *zap.Logger, prefix []byte, handler func(int, basedb.Obj) error) error

GetAll returns all the items of a given collection

func (*BadgerDb) GetMany

func (b *BadgerDb) GetMany(logger *zap.Logger, prefix []byte, keys [][]byte, iterator func(basedb.Obj) error) error

GetMany return values for the given keys

func (*BadgerDb) QuickGC

func (b *BadgerDb) QuickGC(ctx context.Context) error

QuickGC runs a short garbage collection cycle to reclaim some unused disk space. Designed to be called periodically while the database is being used.

func (*BadgerDb) RemoveAllByCollection

func (b *BadgerDb) RemoveAllByCollection(prefix []byte) error

RemoveAllByCollection cleans all items in a collection

func (*BadgerDb) Set

func (b *BadgerDb) Set(prefix []byte, key []byte, value []byte) error

Set save value with key to storage

func (*BadgerDb) SetMany

func (b *BadgerDb) SetMany(prefix []byte, n int, next func(int) (basedb.Obj, error)) error

SetMany save many values with the given keys in a single badger transaction

func (*BadgerDb) Update

func (b *BadgerDb) Update(fn func(basedb.Txn) error) error

Update is a gateway to badger db Update function creating and managing a read-write transaction