kv

Documentation

Index

• func NewCompareFailedError(err error) error
• type BaseKV
• type CompareFailedError
  • func (e *CompareFailedError) Error() string
• type MetaKv
• type SnapShotKV
• type TxnKV
• type WatchKV

Functions

func NewCompareFailedError

func NewCompareFailedError(err error) error

NewCompareFailedError wraps error into NewCompareFailedError

Types

type BaseKV

type BaseKV interface {
	Load(ctx context.Context, key string) (string, error)
	MultiLoad(ctx context.Context, keys []string) ([]string, error)
	LoadWithPrefix(ctx context.Context, key string) ([]string, []string, error)
	Save(ctx context.Context, key, value string) error
	MultiSave(ctx context.Context, kvs map[string]string) error
	Remove(ctx context.Context, key string) error
	MultiRemove(ctx context.Context, keys []string) error
	RemoveWithPrefix(ctx context.Context, key string) error
	Has(ctx context.Context, key string) (bool, error)
	HasPrefix(ctx context.Context, prefix string) (bool, error)
	Close()
}

BaseKV contains base operations of kv. Include save, load and remove.

type CompareFailedError

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

CompareFailedError is a helper type for checking MetaKv CompareAndSwap series func error type

func (*CompareFailedError) Error

func (e *CompareFailedError) Error() string

Error implements error interface

type MetaKv

type MetaKv interface {
	TxnKV
	GetPath(key string) string
	LoadWithPrefix(ctx context.Context, key string) ([]string, []string, error)
	CompareVersionAndSwap(ctx context.Context, key string, version int64, target string) (bool, error)
	WalkWithPrefix(ctx context.Context, prefix string, paginationSize int, fn func([]byte, []byte) error) error
}

MetaKv is TxnKV for metadata. It should save data with lease.

type SnapShotKV

type SnapShotKV interface {
	Save(ctx context.Context, key string, value string, ts typeutil.Timestamp) error
	Load(ctx context.Context, key string, ts typeutil.Timestamp) (string, error)
	MultiSave(ctx context.Context, kvs map[string]string, ts typeutil.Timestamp) error
	LoadWithPrefix(ctx context.Context, key string, ts typeutil.Timestamp) ([]string, []string, error)
	MultiSaveAndRemove(ctx context.Context, saves map[string]string, removals []string, ts typeutil.Timestamp) error
	MultiSaveAndRemoveWithPrefix(ctx context.Context, saves map[string]string, removals []string, ts typeutil.Timestamp) error
}

SnapShotKV is TxnKV for snapshot data. It must save timestamp.

type TxnKV

type TxnKV interface {
	BaseKV
	MultiSaveAndRemove(ctx context.Context, saves map[string]string, removals []string, preds ...predicates.Predicate) error
	MultiSaveAndRemoveWithPrefix(ctx context.Context, saves map[string]string, removals []string, preds ...predicates.Predicate) error
}

TxnKV contains extra txn operations of kv. The extra operations is transactional.

type WatchKV

type WatchKV interface {
	MetaKv
	Watch(ctx context.Context, key string) clientv3.WatchChan
	WatchWithPrefix(ctx context.Context, key string) clientv3.WatchChan
	WatchWithRevision(ctx context.Context, key string, revision int64) clientv3.WatchChan
}

WatchKV is watchable MetaKv. As of today(2023/06/24), it's coupled with etcd.