kv

Documentation

Index

• Constants
• type BinaryStreamFileIterator
  • func OpenKVStreamFile(fname string) (*BinaryStreamFileIterator, error)
  • func (fs *BinaryStreamFileIterator) Close() error
• type BinaryStreamFileWriter
  • func CreateKVStreamFile(fname string) (*BinaryStreamFileWriter, error)
  • func (fw *BinaryStreamFileWriter) Close() error
• type BinaryStreamIterator
  • func NewBinaryStreamIterator(r io.Reader) *BinaryStreamIterator
  • func (b BinaryStreamIterator) Iterate(fun func(k []byte, v []byte) bool) error
• type BinaryStreamWriter
  • func NewBinaryStreamWriter(w io.Writer) *BinaryStreamWriter
  • func (b *BinaryStreamWriter) Stats() (int, int)
  • func (b *BinaryStreamWriter) Write(key, value []byte) error
• type DBError
  • func (d *DBError) Error() string
  • func (d *DBError) Unwrap() error
• type HiveKVStoreReader
  • func NewHiveKVStoreReader(db kvstore.KVStore) *HiveKVStoreReader
  • func (h *HiveKVStoreReader) Get(key Key) []byte
  • func (h *HiveKVStoreReader) Has(key Key) bool
  • func (h *HiveKVStoreReader) Iterate(prefix Key, f func(key Key, value []byte) bool)
  • func (h *HiveKVStoreReader) IterateKeys(prefix Key, f func(key Key) bool)
  • func (h *HiveKVStoreReader) IterateKeysSorted(prefix Key, f func(key Key) bool)
  • func (h *HiveKVStoreReader) IterateSorted(prefix Key, f func(key Key, value []byte) bool)
• type Item
  • func (it *Item) Format(format string) string
• type Items
  • func (items Items) Len() int
  • func (items Items) Less(i, j int) bool
  • func (items Items) Swap(i, j int)
• type KVIterator
• type KVReader
• type KVStore
• type KVStoreReader
  • func NewCachedKVStoreReader(r KVStoreReader, cacheSize int) KVStoreReader
• type KVWriter
• type Key
  • func (k Key) HasPrefix(prefix Key) bool
  • func (k Key) Hex() string
• type StreamIterator
• type StreamWriter

Constants

const EmptyPrefix = Key("")

Types

type BinaryStreamFileIterator

type BinaryStreamFileIterator struct {
	*BinaryStreamIterator
	File *os.File
}

func OpenKVStreamFile

func OpenKVStreamFile(fname string) (*BinaryStreamFileIterator, error)

OpenKVStreamFile opens existing file with k/v stream

func (*BinaryStreamFileIterator) Close

func (fs *BinaryStreamFileIterator) Close() error

type BinaryStreamFileWriter

type BinaryStreamFileWriter struct {
	*BinaryStreamWriter
	File *os.File
}

func CreateKVStreamFile

func CreateKVStreamFile(fname string) (*BinaryStreamFileWriter, error)

CreateKVStreamFile create a new k/v file

func (*BinaryStreamFileWriter) Close

func (fw *BinaryStreamFileWriter) Close() error

type BinaryStreamIterator

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

func NewBinaryStreamIterator

func NewBinaryStreamIterator(r io.Reader) *BinaryStreamIterator

func (BinaryStreamIterator) Iterate

func (b BinaryStreamIterator) Iterate(fun func(k []byte, v []byte) bool) error

type BinaryStreamWriter

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

BinaryStreamWriter writes stream of k/v pairs in binary format.

func NewBinaryStreamWriter

func NewBinaryStreamWriter(w io.Writer) *BinaryStreamWriter

func (*BinaryStreamWriter) Stats

func (b *BinaryStreamWriter) Stats() (int, int)

func (*BinaryStreamWriter) Write

func (b *BinaryStreamWriter) Write(key, value []byte) error

type DBError

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

func (*DBError) Error

func (d *DBError) Error() string

func (*DBError) Unwrap

func (d *DBError) Unwrap() error

type HiveKVStoreReader

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

HiveKVStoreReader is an implementation of KVStoreReader with an instance of hive's kvstore.KVStore as backend.

func NewHiveKVStoreReader

func NewHiveKVStoreReader(db kvstore.KVStore) *HiveKVStoreReader

func (*HiveKVStoreReader) Get

func (h *HiveKVStoreReader) Get(key Key) []byte

Get returns the value, or nil if not found

func (*HiveKVStoreReader) Has

func (h *HiveKVStoreReader) Has(key Key) bool

func (*HiveKVStoreReader) Iterate

func (h *HiveKVStoreReader) Iterate(prefix Key, f func(key Key, value []byte) bool)

func (*HiveKVStoreReader) IterateKeys

func (h *HiveKVStoreReader) IterateKeys(prefix Key, f func(key Key) bool)

func (*HiveKVStoreReader) IterateKeysSorted

func (h *HiveKVStoreReader) IterateKeysSorted(prefix Key, f func(key Key) bool)

func (*HiveKVStoreReader) IterateSorted

func (h *HiveKVStoreReader) IterateSorted(prefix Key, f func(key Key, value []byte) bool)

type Item

type Item struct {
	Key   Key
	Value []byte
}

func (*Item) Format

func (it *Item) Format(format string) string

type Items

type Items []Item

func (Items) Len

func (items Items) Len() int

func (Items) Less

func (items Items) Less(i, j int) bool

func (Items) Swap

func (items Items) Swap(i, j int)

type KVIterator

type KVIterator interface {
	Iterate(prefix Key, f func(key Key, value []byte) bool)
	IterateKeys(prefix Key, f func(key Key) bool)
	IterateSorted(prefix Key, f func(key Key, value []byte) bool)
	IterateKeysSorted(prefix Key, f func(key Key) bool)
}

type KVReader

type KVReader interface {
	// Get returns the value, or nil if not found
	Get(key Key) []byte
	Has(key Key) bool
}

type KVStore

type KVStore interface {
	KVWriter
	KVStoreReader
}

KVStore represents a key-value store where both keys and values are arbitrary byte slices.

type KVStoreReader

type KVStoreReader interface {
	KVReader
	KVIterator
}

func NewCachedKVStoreReader

func NewCachedKVStoreReader(r KVStoreReader, cacheSize int) KVStoreReader

NewCachedKVStoreReader wraps a KVStoreReader with an in-memory cache. IMPORTANT: there is no logic for cache invalidation, so make sure that the underlying KVStoreReader is never mutated.

type KVWriter

type KVWriter interface {
	Set(key Key, value []byte)
	Del(key Key)
}

type Key

type Key string

Key represents a key in the KVStore, to avoid unnecessary conversions between string and []byte, we use string as key data type, but it does not necessarily have to be a valid UTF-8 string.

func (Key) HasPrefix

func (k Key) HasPrefix(prefix Key) bool

func (Key) Hex

func (k Key) Hex() string

type StreamIterator

type StreamIterator interface {
	Iterate(func(k, v []byte) bool) error
}

StreamIterator is an interface to iterate stream

type StreamWriter

type StreamWriter interface {
	Write(key, value []byte) error
	Stats() (int, int) // num k/v pairs and num bytes so far
}

StreamWriter represents an interface specific to write a sequence of key/value pairs