badgersimple

README

Simple Badger

Provides a simpler interface for the key-value store badger (https://github.com/dgraph-io/badger).

Usage

db, _ := badger.New("/tmp/db")

var value1 myStruct
var value2 myStruct

_ = db.Set("foo", &value1)

_ = db.Get("foo", &value2)

_ = db.Prefix("myPrefix", &myStruct{}, func(key string, value interface{}) error {
	castValue := value.(*myStruct)

  return nil
})

Documentation

Index

• type DB
  • func New(path string, logLevel LogLevel) (*DB, error)
  • func (db *DB) Close() error
  • func (db *DB) Delete(key string) error
  • func (db *DB) Exist(key string) bool
  • func (db *DB) Get(key string, value interface{}) error
  • func (db *DB) Prefix(prefix string, resultType interface{}, ...) error
  • func (db *DB) RunGC() error
  • func (db *DB) Set(key string, value interface{}) error
  • func (db *DB) SetWithTTL(key string, value interface{}, ttl time.Duration) error
• type LogLevel

Types

type DB

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

DB database

func New

func New(path string, logLevel LogLevel) (*DB, error)

New creates a new database reference

func (*DB) Close

func (db *DB) Close() error

Close closes a database

func (*DB) Delete

func (db *DB) Delete(key string) error

Delete removes a key from the db

func (*DB) Exist

func (db *DB) Exist(key string) bool

Exist check if a specific key exists

func (*DB) Get

func (db *DB) Get(key string, value interface{}) error

Get load entry for given key

func (*DB) Prefix

func (db *DB) Prefix(prefix string, resultType interface{}, fn func(key string, value interface{}) error) error

Prefix get all entries with given prefix

func (*DB) RunGC

func (db *DB) RunGC() error

RunGC run garbage collection

func (*DB) Set

func (db *DB) Set(key string, value interface{}) error

Set entry for given key

func (*DB) SetWithTTL

func (db *DB) SetWithTTL(key string, value interface{}, ttl time.Duration) error

SetWithTTL set an entry for given key with TTL

type LogLevel

type LogLevel uint8

LogLevel log level

const (
	LogLevelDebug   LogLevel = 0
	LogLevelInfo    LogLevel = 1
	LogLevelWarning LogLevel = 2
	LogLevelError   LogLevel = 3
	LogLevelNone    LogLevel = 4
)

LogLevels