kv

Documentation

Index

• Variables
• type HandoverCallback
• type IndexOptions
  • func IndexWithLogger(l *logger.Logger) IndexOptions
• type IndexStore
  • func OpenIndexStore(shardID int, path string, options ...IndexOptions) (IndexStore, error)
• type Iterable
• type Iterator
• type Reader
• type ScanFunc
• type ScanOpts
• type Store
  • func OpenStore(shardID int, path string, options ...StoreOptions) (Store, error)
• type StoreOptions
  • func StoreWithLogger(l *logger.Logger) StoreOptions
  • func StoreWithNamedLogger(name string, l *logger.Logger) StoreOptions
• type TimeSeriesOptions
  • func TSSWithEncoding(encoderPool encoding.SeriesEncoderPool, decoderPool encoding.SeriesDecoderPool) TimeSeriesOptions
  • func TSSWithFlushCallback(callback func()) TimeSeriesOptions
  • func TSSWithLogger(l *logger.Logger) TimeSeriesOptions
• type TimeSeriesReader
• type TimeSeriesStore
  • func OpenTimeSeriesStore(shardID int, path string, options ...TimeSeriesOptions) (TimeSeriesStore, error)
• type TimeSeriesWriter
• type Writer

Variables

var (
	ErrStopScan     = errors.New("stop scanning")
	DefaultScanOpts = ScanOpts{
		PrefetchSize:   100,
		PrefetchValues: true,
	}
)

var (
	ErrKeyNotFound = badger.ErrKeyNotFound
)

Types

type HandoverCallback

type HandoverCallback func()

type IndexOptions

type IndexOptions func(store IndexStore)

func IndexWithLogger

func IndexWithLogger(l *logger.Logger) IndexOptions

IndexWithLogger sets a external logger into underlying IndexStore

type IndexStore

type IndexStore interface {
	Iterable
	Reader
	Handover(iterator Iterator) error
	Close() error
}

func OpenIndexStore

func OpenIndexStore(shardID int, path string, options ...IndexOptions) (IndexStore, error)

OpenIndexStore creates a new IndexStore

type Iterable

type Iterable interface {
	NewIterator(opt ScanOpts) Iterator
}

type Iterator

type Iterator interface {
	Next()
	Rewind()
	Seek(key []byte)
	Key() []byte
	Val() []byte
	Valid() bool
	Close() error
}

type Reader

type Reader interface {
	Iterable
	// Get a value by its key
	Get(key []byte) ([]byte, error)
	GetAll(key []byte, applyFn func([]byte) error) error
	Scan(prefix, seekKey []byte, opt ScanOpts, f ScanFunc) error
}

type ScanFunc

type ScanFunc func(shardID int, key []byte, getVal func() ([]byte, error)) error

type ScanOpts

type ScanOpts struct {
	PrefetchSize   int
	PrefetchValues bool
	Reverse        bool
	Prefix         []byte
}

type Store

type Store interface {
	observability.Observable
	io.Closer
	Writer
	Reader
}

Store is a common kv storage with auto-generated key

func OpenStore

func OpenStore(shardID int, path string, options ...StoreOptions) (Store, error)

OpenStore creates a new Store

type StoreOptions

type StoreOptions func(Store)

func StoreWithLogger

func StoreWithLogger(l *logger.Logger) StoreOptions

StoreWithLogger sets a external logger into underlying Store

func StoreWithNamedLogger

func StoreWithNamedLogger(name string, l *logger.Logger) StoreOptions

StoreWithNamedLogger sets a external logger with a name into underlying Store

type TimeSeriesOptions

type TimeSeriesOptions func(TimeSeriesStore)

func TSSWithEncoding

func TSSWithEncoding(encoderPool encoding.SeriesEncoderPool, decoderPool encoding.SeriesDecoderPool) TimeSeriesOptions

func TSSWithFlushCallback

func TSSWithFlushCallback(callback func()) TimeSeriesOptions

func TSSWithLogger

func TSSWithLogger(l *logger.Logger) TimeSeriesOptions

TSSWithLogger sets a external logger into underlying TimeSeriesStore

type TimeSeriesReader

type TimeSeriesReader interface {
	// Get a value by its key and timestamp/version
	Get(key []byte, ts uint64) ([]byte, error)
	// GetAll values with an identical key
	GetAll(key []byte) ([][]byte, error)
}

type TimeSeriesStore

type TimeSeriesStore interface {
	observability.Observable
	io.Closer
	TimeSeriesWriter
	TimeSeriesReader
}

TimeSeriesStore is time series storage

func OpenTimeSeriesStore

func OpenTimeSeriesStore(shardID int, path string, options ...TimeSeriesOptions) (TimeSeriesStore, error)

OpenTimeSeriesStore creates a new TimeSeriesStore

type TimeSeriesWriter

type TimeSeriesWriter interface {
	// Put a value with a timestamp/version
	Put(key, val []byte, ts uint64) error
	// PutAsync a value with a timestamp/version asynchronously.
	// Injected "f" func will notice the result of value write.
	PutAsync(key, val []byte, ts uint64, f func(error)) error
}

type Writer

type Writer interface {
	// Put a value
	Put(key, val []byte) error
	PutWithVersion(key, val []byte, version uint64) error
}