badgerdb

README

badgerdb

version v1.6.0

Documentation

Index

• type BadgerDB
  • func NewBadgerDB(path string) (*BadgerDB, error)
  • func (db *BadgerDB) Close()
  • func (db *BadgerDB) Del(keys []string) error
  • func (db *BadgerDB) GC() error
  • func (db *BadgerDB) Get(k string) (string, error)
  • func (db *BadgerDB) Incr(k string, by int64) (int64, error)
  • func (db *BadgerDB) MGet(keys []string) (data []string)
  • func (db *BadgerDB) MSet(data map[string]string) error
  • func (db *BadgerDB) Name() string
  • func (db *BadgerDB) Scan(scannerOpt store.ScannerOptions) error
  • func (db *BadgerDB) Set(k, v string, ttl int) error
  • func (db *BadgerDB) Size() int64
  • func (db *BadgerDB) TTL(key string) int64

Types

type BadgerDB

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

BadgerDB - represents a badger db implementation

func NewBadgerDB

func NewBadgerDB(path string) (*BadgerDB, error)

OpenBadger - Opens the specified path

func (*BadgerDB) Close

func (db *BadgerDB) Close()

Close ...

func (*BadgerDB) Del

func (db *BadgerDB) Del(keys []string) error

Del - removes key(s) from the store

func (*BadgerDB) GC

func (db *BadgerDB) GC() error

GC - runs the garbage collector

func (*BadgerDB) Get

func (db *BadgerDB) Get(k string) (string, error)

Get - fetches the value of the specified k

func (*BadgerDB) Incr

func (db *BadgerDB) Incr(k string, by int64) (int64, error)

Incr - increment the key by the specified value

func (*BadgerDB) MGet

func (db *BadgerDB) MGet(keys []string) (data []string)

MGet - fetch multiple values of the specified keys

func (*BadgerDB) MSet

func (db *BadgerDB) MSet(data map[string]string) error

MSet - sets multiple key-value pairs

func (*BadgerDB) Name

func (db *BadgerDB) Name() string

func (*BadgerDB) Scan

func (db *BadgerDB) Scan(scannerOpt store.ScannerOptions) error

Scan - iterate over the whole store using the handler function

func (*BadgerDB) Set

func (db *BadgerDB) Set(k, v string, ttl int) error

Set - sets a key with the specified value and optional ttl

func (*BadgerDB) Size

func (db *BadgerDB) Size() int64

Size - returns the size of the database (LSM + ValueLog) in bytes

func (*BadgerDB) TTL

func (db *BadgerDB) TTL(key string) int64

TTL - returns the time to live of the specified key's value