store

Documentation

Index

• func NewInmem() *inmemKV
• func NewLevelDB(dir string) (*leveldbKV, error)
• type KV
  • func NewTestKV(t testing.TB, kv string, path string, opts ...TestKVOption) (KV, func())
• type TestKVConfig
• type TestKVOption
  • func WithKeepExisting() TestKVOption
• type WriteBatch

Functions

func NewInmem

func NewInmem() *inmemKV

func NewLevelDB

func NewLevelDB(dir string) (*leveldbKV, error)

Types

type KV

type KV interface {
	io.Closer

	Get(key []byte) ([]byte, error)
	MultiGet(keys ...[]byte) ([][]byte, error)

	Put(key, value []byte) error

	NewWriteBatch() WriteBatch
	CommitWriteBatch(batch WriteBatch) error

	Delete(key []byte) error

	Dir() string
}

func NewTestKV

func NewTestKV(t testing.TB, kv string, path string, opts ...TestKVOption) (KV, func())

NewTestKV returns a KV store for testing purposes.

type TestKVConfig

type TestKVConfig struct {
	RemoveExisting bool
}

type TestKVOption

type TestKVOption func(cfg *TestKVConfig)

func WithKeepExisting

func WithKeepExisting() TestKVOption

type WriteBatch

type WriteBatch interface {
	Put(key, value []byte)

	Clear()
	Count() int
	Destroy()
}