db

Documentation

Overview

Package db implements key-value database functionality with prefix feature.

Index

• Variables
• type Batch
  • func (b *Batch) Del(key []byte)
  • func (b *Batch) Set(key, value []byte)
• type DB
  • func NewDB(path string) (*DB, error)
  • func NewInMemoryDB() (*DB, error)
  • func (db *DB) Close() error
  • func (db *DB) Del(key []byte)
  • func (db *DB) DropAll()
  • func (db *DB) Exist(key []byte) bool
  • func (db *DB) Get(key []byte) ([]byte, bool)
  • func (db *DB) Iterate(prefix []byte, limit int, reverse bool) []KeyValue
  • func (db *DB) IterateKey(prefix []byte, limit int, reverse bool) [][]byte
  • func (db *DB) IterateRange(start, end []byte, limit int, reverse bool) []KeyValue
  • func (db *DB) NewBatch() *Batch
  • func (db *DB) NewReader() *Reader
  • func (db *DB) Set(key, value []byte)
  • func (db *DB) Write(batch *Batch)
• type KeyValue
  • func NewKeyValue(key, value []byte) KeyValue
• type Reader
  • func (r *Reader) Close() error
  • func (r *Reader) Exist(key []byte) bool
  • func (r *Reader) Get(key []byte) ([]byte, bool)
  • func (r *Reader) Iterate(prefix []byte, limit int, reverse bool) []KeyValue
  • func (r *Reader) IterateKey(prefix []byte, limit int, reverse bool) [][]byte
  • func (r *Reader) IterateRange(start, end []byte, limit int, reverse bool) []KeyValue

Variables

var (
	ErrDataNotFound = errors.New("data was not found")
)

Types

type Batch

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

func (*Batch) Del

func (b *Batch) Del(key []byte)

func (*Batch) Set

func (b *Batch) Set(key, value []byte)

type DB

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

func NewDB

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

func NewInMemoryDB

func NewInMemoryDB() (*DB, error)

NewInMemoryDB returns new instance of in-memory db.

func (*DB) Close

func (db *DB) Close() error

func (*DB) Del

func (db *DB) Del(key []byte)

func (*DB) DropAll

func (db *DB) DropAll()

func (*DB) Exist

func (db *DB) Exist(key []byte) bool

func (*DB) Get

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

func (*DB) Iterate

func (db *DB) Iterate(prefix []byte, limit int, reverse bool) []KeyValue

func (*DB) IterateKey

func (db *DB) IterateKey(prefix []byte, limit int, reverse bool) [][]byte

func (*DB) IterateRange

func (db *DB) IterateRange(start, end []byte, limit int, reverse bool) []KeyValue

func (*DB) NewBatch

func (db *DB) NewBatch() *Batch

func (*DB) NewReader

func (db *DB) NewReader() *Reader

func (*DB) Set

func (db *DB) Set(key, value []byte)

func (*DB) Write

func (db *DB) Write(batch *Batch)

type KeyValue

type KeyValue interface {
	Key() []byte
	Value() []byte
}

func NewKeyValue

func NewKeyValue(key, value []byte) KeyValue

type Reader

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

func (*Reader) Close

func (r *Reader) Close() error

func (*Reader) Exist

func (r *Reader) Exist(key []byte) bool

func (*Reader) Get

func (r *Reader) Get(key []byte) ([]byte, bool)

func (*Reader) Iterate

func (r *Reader) Iterate(prefix []byte, limit int, reverse bool) []KeyValue

func (*Reader) IterateKey

func (r *Reader) IterateKey(prefix []byte, limit int, reverse bool) [][]byte

func (*Reader) IterateRange

func (r *Reader) IterateRange(start, end []byte, limit int, reverse bool) []KeyValue