kvstore

Documentation

Index

• Variables
• func Variadic(opts ...Option) variadic
• type Event
• type KV
• type KeepAliveCallback
• type Option
  • func Count() Option
  • func FromKey() Option
  • func IgnoreLease() Option
  • func KeepAlive(f KeepAliveCallback) Option
  • func KeyOnly() Option
  • func Limit(val uint32) Option
  • func MatchPrefix() Option
  • func TTL(val uint32) Option
• type Param
  • func WithValue(parent Param, key, val any) Param
• type Result
• type Type
• type Watcher

Variables

var (
	ErrWatcherStopped = errors.New("watcher is stopped")
	ErrNotImplement   = errors.New("the method is not implement")
)

Functions

func Variadic

func Variadic(opts ...Option) variadic

Types

type Event

type Event interface {
	Len() int
	Key(i int) string
	Value(i int) []byte
	Type(i int) Type // PUT, DELETE
}

type KV

type KV interface {
	Set(ctx context.Context, key string, val []byte, opts ...Option) error
	Get(ctx context.Context, key string, opts ...Option) (Result, error)
	Del(ctx context.Context, key string, opts ...Option) error
	Watch(ctx context.Context, opts ...Option) Watcher
	Close() error
	String() string
}

KV is the source from which config is loaded.

type KeepAliveCallback

type KeepAliveCallback func(id, ttl int64, cancel func())

type Option

type Option func(Param) Param

func Count

func Count() Option

get num of key-value pairs

func FromKey

func FromKey() Option

分页查询开始key, 如果为空则从第一个开始 nextKey = $(lastKey) + "\x00", 在 etcd 中，键是按字典序排序的。通过追加 \x00，可以确保下一个键是当前键的后一个键

func IgnoreLease

func IgnoreLease() Option

ignore expired keys

func KeepAlive

func KeepAlive(f KeepAliveCallback) Option

func KeyOnly

func KeyOnly() Option

func Limit

func Limit(val uint32) Option

set the batch size of get

func MatchPrefix

func MatchPrefix() Option

func TTL

func TTL(val uint32) Option

type Param

type Param interface {
	Value(key any) any
}

func WithValue

func WithValue(parent Param, key, val any) Param

type Result

type Result interface {
	Len() int
	Key(i int) string
	Value(i int) []byte
}

type Type

type Type string

const (
	NONE   Type = "NONE"
	PUT    Type = "PUT"
	DELETE Type = "DELETE"
)

type Watcher

type Watcher interface {
	Next(ctx context.Context) (Event, error)
	Stop() error
}

Watcher watches a source for changes.