badger

Documentation

Index

• type DB
  • func OpenDB(path string) (*DB, error)
  • func (db *DB) Close()
  • func (db *DB) Del(keys []string) error
  • func (db *DB) GC() error
  • func (db *DB) Get(k store.Key) (string, error)
  • func (db *DB) Scan(scannerOpt store.ScannerOptions) error
  • func (db *DB) Set(k store.Key, v string) error
  • func (db *DB) Size() int64

Types

type DB

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

DB - represents a badger db implementation

func OpenDB

func OpenDB(path string) (*DB, error)

OpenDB - Opens the specified path

func (*DB) Close

func (db *DB) Close()

Close

func (*DB) Del

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

Del - removes key(s) from the store

func (*DB) GC

func (db *DB) GC() error

GC - runs the garbage collector

func (*DB) Get

func (db *DB) Get(k store.Key) (string, error)

Get - fetches the value of the specified key

func (*DB) Scan

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

Scan - iterate over the whole store using the handler function

func (*DB) Set

func (db *DB) Set(k store.Key, v string) error

Set - sets a key with the specified value if the version doesn't exist

func (*DB) Size

func (db *DB) Size() int64

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