db

Documentation

Index

• Variables
• type DB
  • func NewDB(path string, timeout time.Duration) (*DB, error)
  • func (db *DB) Close(delete bool) error
  • func (db *DB) Delete(key string) error
  • func (db *DB) Get(key string) ([]byte, error)
  • func (db *DB) Keys() ([]string, error)
  • func (db *DB) Purge() error
  • func (db *DB) Put(key string, val []byte) error

Variables

var (
	ErrNotFound = errors.New("key not found")
	ErrNilValue = errors.New("value is nil")
)

Package vars

Types

type DB

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

DB describes local BoltDB database

func NewDB

func NewDB(path string, timeout time.Duration) (*DB, error)

NewDB creates new instance of DB

func (*DB) Close

func (db *DB) Close(delete bool) error

Close closes the DB

func (*DB) Delete

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

Delete removes the value from DB by provided bucket and key

func (*DB) Get

func (db *DB) Get(key string) ([]byte, error)

Get acquires value from DB by provided key

func (*DB) Keys

func (db *DB) Keys() ([]string, error)

Keys returns a list of available keys in the global bucket, sorted alphabetically

func (*DB) Purge

func (db *DB) Purge() error

Purge removes the bucket from DB

func (*DB) Put

func (db *DB) Put(key string, val []byte) error

Put sets/updates the value in DB by provided bucket and key