keyvalue

Documentation

Index

• Variables
• func NewBloomFilterStub(params BloomFilterParams) bloomFilterStub
• func NewStore(path string) *storeImpl
• func SafeKey(k KeyInter) []byte
• func SafeValue(k ValueInter) []byte
• type Batch
• type BloomFilter
• type BloomFilterParams
  • func NewBloomFilterParams(N int, FalsePositiveProbability float64, store store) BloomFilterParams
• type CacheParams
• type IterableKeyVal
• type Iterator
• type KeyInter
• type KeyVal
  • func NewKeyVal(path string, params KeyValParams) (*KeyVal, error)
  • func (k *KeyVal) Close() error
  • func (k *KeyVal) Delete(key []byte) error
  • func (k *KeyVal) Flush(b1 Batch) error
  • func (k *KeyVal) Get(key []byte) ([]byte, error)
  • func (k *KeyVal) Has(key []byte) (bool, error)
  • func (k *KeyVal) NewBatch() (Batch, error)
  • func (k *KeyVal) NewKeyIterator(prefix []byte) (Iterator, error)
  • func (k *KeyVal) Put(key, val []byte) error
• type KeyValParams
• type KeyValue
• type NoOpStore
  • func (NoOpStore) WithPath(string)
• type ValueInter

Variables

var ErrNotFound = errors.New("not found")

Functions

func NewBloomFilterStub

func NewBloomFilterStub(params BloomFilterParams) bloomFilterStub

func NewStore

func NewStore(path string) *storeImpl

func SafeKey

func SafeKey(k KeyInter) []byte

func SafeValue

func SafeValue(k ValueInter) []byte

Types

type Batch

type Batch interface {
	Delete(key []byte)
	Put(key, val []byte)
	Reset()
}

type BloomFilter

type BloomFilter interface {
	Params() BloomFilterParams
	io.WriterTo
	// contains filtered or unexported methods
}

type BloomFilterParams

type BloomFilterParams struct {
	// N is how many items will be added to the filter.
	N int
	// FalsePositiveProbability is acceptable false positive rate {0..1}.
	FalsePositiveProbability float64
	// Bloom store.
	Store store
	// Disable bloom filter.
	Disable bool
}

func NewBloomFilterParams

func NewBloomFilterParams(N int, FalsePositiveProbability float64, store store) BloomFilterParams

type CacheParams

type CacheParams struct {
	Size int
}

type IterableKeyVal

type IterableKeyVal interface {
	KeyValue
	NewKeyIterator(prefix []byte) (Iterator, error)
}

type Iterator

type Iterator interface {
	Key() []byte
	Value() []byte
	Next() bool
	Prev() bool

	First() bool
	Last() bool

	Error() error
	Release()
}

type KeyInter

type KeyInter interface {
	Key() []byte
}

type KeyVal

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

func NewKeyVal

func NewKeyVal(path string, params KeyValParams) (*KeyVal, error)

func (*KeyVal) Close

func (k *KeyVal) Close() error

func (*KeyVal) Delete

func (k *KeyVal) Delete(key []byte) error

func (*KeyVal) Flush

func (k *KeyVal) Flush(b1 Batch) error

func (*KeyVal) Get

func (k *KeyVal) Get(key []byte) ([]byte, error)

func (*KeyVal) Has

func (k *KeyVal) Has(key []byte) (bool, error)

func (*KeyVal) NewBatch

func (k *KeyVal) NewBatch() (Batch, error)

func (*KeyVal) NewKeyIterator

func (k *KeyVal) NewKeyIterator(prefix []byte) (Iterator, error)

func (*KeyVal) Put

func (k *KeyVal) Put(key, val []byte) error

type KeyValParams

type KeyValParams struct {
	CacheParams
	BloomFilterParams
	WriteBuffer            int
	CompactionTableSize    int
	CompactionTotalSize    int
	OpenFilesCacheCapacity int
}

type KeyValue

type KeyValue interface {
	NewBatch() (Batch, error)
	Has(key []byte) (bool, error)
	Put(key, val []byte) error
	Get(key []byte) ([]byte, error)
	Delete(key []byte) error
	Flush(batch Batch) error
	Close() error
}

type NoOpStore

type NoOpStore struct {
}

func (NoOpStore) WithPath

func (NoOpStore) WithPath(string)

type ValueInter

type ValueInter interface {
	Value() []byte
}