ligodb

Documentation

Index

• Constants
• type Batch
• type Batcher
• type Compacter
• type Database
• type Iteratee
• type Iterator
• type KeyValueStore
• type Reader
• type Stater
• type Writer

Constants

const IdealBatchSize = 100 * 1024

Types

type Batch

type Batch interface {
	Writer

	ValueSize() int

	Write() error

	Reset()

	Replay(w Writer) error
}

type Batcher

type Batcher interface {
	NewBatch() Batch
}

type Compacter

type Compacter interface {
	Compact(start []byte, limit []byte) error
}

type Database

type Database interface {
	Reader
	Writer
	Batcher
	Iteratee
	Stater
	Compacter
	io.Closer
}

type Iteratee

type Iteratee interface {
	NewIterator() Iterator

	NewIteratorWithPrefix(prefix []byte) Iterator
}

type Iterator

type Iterator interface {
	Next() bool

	Error() error

	Key() []byte

	Value() []byte

	Release()
}

type KeyValueStore

type KeyValueStore interface {
	Reader
	Writer
	Batcher
	Iteratee
	Stater
	Compacter
	io.Closer
}

type Reader

type Reader interface {
	Has(key []byte) (bool, error)

	Get(key []byte) ([]byte, error)
}

type Stater

type Stater interface {
	Stat(property string) (string, error)
}

type Writer

type Writer interface {
	Put(key []byte, value []byte) error

	Delete(key []byte) error
}