kv

Documentation

Index

• type BadgerDB
  • func New(logger *zap.Logger, options basedb.Options) (*BadgerDB, error)
  • func NewInMemory(logger *zap.Logger, options basedb.Options) (*BadgerDB, error)
  • func (b *BadgerDB) Badger() *badger.DB
  • func (b *BadgerDB) Begin() basedb.Txn
  • func (b *BadgerDB) BeginRead() basedb.ReadTxn
  • func (b *BadgerDB) Close() error
  • func (b *BadgerDB) CountPrefix(prefix []byte) (int64, error)
  • func (b *BadgerDB) Delete(prefix []byte, key []byte) error
  • func (b *BadgerDB) DropPrefix(prefix []byte) 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(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) QuickGC(ctx context.Context) 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
  • func (b *BadgerDB) Using(rw basedb.ReadWriter) basedb.ReadWriter
  • func (b *BadgerDB) UsingReader(r basedb.Reader) basedb.Reader

Types

type BadgerDB

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

BadgerDB struct

func New

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

New creates a persistent DB instance.

func NewInMemory

func NewInMemory(logger *zap.Logger, options basedb.Options) (*BadgerDB, error)

NewInMemory creates an in-memory DB instance.

func (*BadgerDB) Badger

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

Badger returns the underlying badger.DB

func (*BadgerDB) Begin

func (b *BadgerDB) Begin() basedb.Txn

Begin creates a read-write transaction.

func (*BadgerDB) BeginRead

func (b *BadgerDB) BeginRead() basedb.ReadTxn

BeginRead creates a read-only transaction.

func (*BadgerDB) Close

func (b *BadgerDB) Close() error

Close closes the database.

func (*BadgerDB) CountPrefix

func (b *BadgerDB) CountPrefix(prefix []byte) (int64, error)

CountPrefix 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) DropPrefix

func (b *BadgerDB) DropPrefix(prefix []byte) error

DropPrefix cleans all items in a collection

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

func (*BadgerDB) Using

func (b *BadgerDB) Using(rw basedb.ReadWriter) basedb.ReadWriter

Using returns the given ReadWriter, falling back to the database if it's nil.

func (*BadgerDB) UsingReader

func (b *BadgerDB) UsingReader(r basedb.Reader) basedb.Reader

UsingReader returns the given Reader, falling back to the database if it's nil.