store

Documentation

Index

• Variables
• type KVPair
• type OpType
• type ScanStore
  • func NewBoltStore(path string) (ScanStore, error)
  • func NewRbMemoryStore() ScanStore
• type ScanTTLStore
• type ScanTTLTxn
• type ScanTxn
• type Store
  • func NewMemoryStore() Store
• type TTLStore
  • func NewMemoryStoreDefaultTTL() TTLStore
  • func NewMemoryStoreWithExpire(interval time.Duration) TTLStore
  • func NewRbMemoryStoreDefaultTTL() TTLStore
  • func NewRbMemoryStoreWithExpire(interval time.Duration) TTLStore
• type TTLTxn
• type Txn

Variables

var ErrKeyNotFound = errors.New("not found")

var ErrNotSupported = errors.New("not supported")

var ErrUnknownOp = errors.New("unknown op")

var Tombstone = []byte{0x00}

Types

type KVPair

type KVPair struct {
	Key   []byte
	Value []byte
}

type OpType

type OpType uint8

const (
	OpTypePut OpType = iota
	OpTypeDelete
)

type ScanStore

type ScanStore interface {
	Store
	Scan(ctx context.Context, start []byte, end []byte, limit int) ([]*KVPair, error)
}

func NewBoltStore

func NewBoltStore(path string) (ScanStore, error)

func NewRbMemoryStore

func NewRbMemoryStore() ScanStore

type ScanTTLStore

type ScanTTLStore interface {
	ScanStore
	TTLStore
}

type ScanTTLTxn

type ScanTTLTxn interface {
	ScanTxn
	TTLTxn
}

type ScanTxn

type ScanTxn interface {
	Txn
	Scan(ctx context.Context, start []byte, end []byte, limit int) ([]*KVPair, error)
}

type Store

type Store interface {
	Get(ctx context.Context, key []byte) ([]byte, error)
	Put(ctx context.Context, key []byte, value []byte) error
	Delete(ctx context.Context, key []byte) error
	Exists(ctx context.Context, key []byte) (bool, error)
	Snapshot() (io.ReadWriter, error)
	Restore(buf io.Reader) error
	Txn(ctx context.Context, f func(ctx context.Context, txn Txn) error) error
	Close() error
}

func NewMemoryStore

func NewMemoryStore() Store

type TTLStore

type TTLStore interface {
	Store
	Expire(ctx context.Context, key []byte, ttl int64) error
	PutWithTTL(ctx context.Context, key []byte, value []byte, ttl int64) error
	TxnWithTTL(ctx context.Context, f func(ctx context.Context, txn TTLTxn) error) error
}

func NewMemoryStoreDefaultTTL

func NewMemoryStoreDefaultTTL() TTLStore

func NewMemoryStoreWithExpire

func NewMemoryStoreWithExpire(interval time.Duration) TTLStore

func NewRbMemoryStoreDefaultTTL

func NewRbMemoryStoreDefaultTTL() TTLStore

func NewRbMemoryStoreWithExpire

func NewRbMemoryStoreWithExpire(interval time.Duration) TTLStore

type TTLTxn

type TTLTxn interface {
	Txn
	Expire(ctx context.Context, key []byte, ttl int64) error
	PutWithTTL(ctx context.Context, key []byte, value []byte, ttl int64) error
}

type Txn

type Txn interface {
	Get(ctx context.Context, key []byte) ([]byte, error)
	Put(ctx context.Context, key []byte, value []byte) error
	Delete(ctx context.Context, key []byte) error
	Exists(ctx context.Context, key []byte) (bool, error)
}