engine

Documentation

Index

• Variables
• type Batch
• type Driver
• type Iterator
• type Snapshot

Variables

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

Types

type Batch

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

	Commit() error
}

WriteBatch write batch

type Driver

type Driver interface {
	Get(key []byte) (value []byte, err error)
	Put(key []byte, value []byte) error
	Delete(key []byte) error
	Close() error

	NewIterator(startKey, endKey []byte) Iterator

	// 批量写入，提交时保证batch里的修改同时对外可见
	NewBatch() Batch

	GetSnapshot() (Snapshot, error)
}

Driver

type Iterator

type Iterator interface {
	// return false if over or error
	Next() bool

	Key() []byte
	Value() []byte

	Error() error

	// Release iterator使用完需要释放
	Release()
}

Iterator iterator

type Snapshot

type Snapshot interface {
	NewIterator(startKey, endKey []byte) Iterator
	Get(key []byte) ([]byte, error)

	// Release snapshot使用完需要释放
	Release()
}

Snapshot snapshot