kv

Documentation

Index

• Constants
• func New(options basedb.Options) (basedb.IDb, error)
• type BadgerDb
  • func (b *BadgerDb) Close()
  • func (b *BadgerDb) CountByCollection(prefix []byte) (int64, error)
  • func (b *BadgerDb) Delete(prefix []byte, key []byte) error
  • func (b *BadgerDb) Get(prefix []byte, key []byte) (basedb.Obj, bool, error)
  • func (b *BadgerDb) GetAll(prefix []byte, handler func(int, basedb.Obj) error) error
  • func (b *BadgerDb) GetMany(prefix []byte, keys [][]byte, iterator func(basedb.Obj) error) 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(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) Close

func (b *BadgerDb) Close()

Close close db

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) 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(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(prefix []byte, keys [][]byte, iterator func(basedb.Obj) error) error

GetMany return values for the given keys

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