badger

Sep 10, 2020

Changes in this version

+ var ErrPlan9NotSupported = errors.New("Read-only mode is not supported on Plan 9")

Mar 26, 2020

Changes in this version

type DB

+ func (db *DB) NewWriteBatchAt(commitTs uint64) *WriteBatch

+ type KVList = pb.KVList

type Options

+ BypassLockGuard bool

+ EventLogging bool

+ VerifyValueChecksum bool

+ func (opt Options) WithBypassLockGuard(b bool) Options

+ func (opt Options) WithEventLogging(enabled bool) Options

+ func (opt Options) WithVerifyValueChecksum(val bool) Options

Jul 2, 2019

Changes in this version

+ const FILE_ATTRIBUTE_TEMPORARY — windows/amd64

+ const FILE_FLAG_DELETE_ON_CLOSE — windows/amd64

+ const ValueThresholdLimit

+ var ErrInvalidKey = errors.New("Key is using a reserved !badger! prefix")

+ var ErrNilCallback = errors.New("Callback cannot be nil")

+ var ErrUnsortedKey = errors.New("Keys not in sorted order")

type DB

+ func (db *DB) DropAll() error

+ func (db *DB) DropPrefix(prefix []byte) error

+ func (db *DB) Flatten(workers int) error

+ func (db *DB) KeySplits(prefix []byte) []string

+ func (db *DB) NewKVLoader(maxPendingWrites int) *KVLoader

+ func (db *DB) NewStream() *Stream

+ func (db *DB) NewStreamAt(readTs uint64) *Stream

+ func (db *DB) NewStreamWriter() *StreamWriter

+ func (db *DB) NewTransactionAt(readTs uint64, update bool) *Txn

+ func (db *DB) NewWriteBatch() *WriteBatch

+ func (db *DB) PrintHistogram(keyPrefix []byte)

+ func (db *DB) SetDiscardTs(ts uint64)

+ func (db *DB) Subscribe(ctx context.Context, cb callback, prefix []byte, prefixes ...[]byte) error

+ func (db *DB) Sync() error

type Entry

+ func NewEntry(key, value []byte) *Entry

+ func (e *Entry) WithDiscard() *Entry

+ func (e *Entry) WithMeta(meta byte) *Entry

+ func (e *Entry) WithTTL(dur time.Duration) *Entry

type Item

+ func (item *Item) KeySize() int64

+ func (item *Item) ValueSize() int64

type IteratorOptions

+ InternalAccess bool

+ Prefix []byte

+ type KVLoader struct

+ func (l *KVLoader) Finish() error

+ func (l *KVLoader) Set(kv *pb.KV) error

+ type Logger interface

+ Debugf func(string, ...interface{})

+ Errorf func(string, ...interface{})

+ Infof func(string, ...interface{})

+ Warningf func(string, ...interface{})

type Options

+ CompactL0OnClose bool

+ LogRotatesToFlush int32

+ Logger Logger

+ func (opt *Options) Debugf(format string, v ...interface{})

+ func (opt *Options) Errorf(format string, v ...interface{})

+ func (opt *Options) Infof(format string, v ...interface{})

+ func (opt *Options) Warningf(format string, v ...interface{})

+ func (opt Options) WithCompactL0OnClose(val bool) Options

+ func (opt Options) WithDir(val string) Options

+ func (opt Options) WithLevelOneSize(val int64) Options

+ func (opt Options) WithLevelSizeMultiplier(val int) Options

+ func (opt Options) WithLogRotatesToFlush(val int32) Options

+ func (opt Options) WithLogger(val Logger) Options

+ func (opt Options) WithMaxLevels(val int) Options

+ func (opt Options) WithMaxTableSize(val int64) Options

+ func (opt Options) WithNumCompactors(val int) Options

+ func (opt Options) WithNumLevelZeroTables(val int) Options

+ func (opt Options) WithNumLevelZeroTablesStall(val int) Options

+ func (opt Options) WithNumMemtables(val int) Options

+ func (opt Options) WithNumVersionsToKeep(val int) Options

+ func (opt Options) WithReadOnly(val bool) Options

+ func (opt Options) WithSyncWrites(val bool) Options

+ func (opt Options) WithTableLoadingMode(val options.FileLoadingMode) Options

+ func (opt Options) WithTruncate(val bool) Options

+ func (opt Options) WithValueDir(val string) Options

+ func (opt Options) WithValueLogFileSize(val int64) Options

+ func (opt Options) WithValueLogLoadingMode(val options.FileLoadingMode) Options

+ func (opt Options) WithValueLogMaxEntries(val uint32) Options

+ func (opt Options) WithValueThreshold(val int) Options

+ type Stream struct

+ ChooseKey func(item *Item) bool

+ KeyToList func(key []byte, itr *Iterator) (*pb.KVList, error)

+ LogPrefix string

+ NumGo int

+ Prefix []byte

+ Send func(*pb.KVList) error

+ func (st *Stream) Orchestrate(ctx context.Context) error

+ func (st *Stream) ToList(key []byte, itr *Iterator) (*pb.KVList, error)

+ func (stream *Stream) Backup(w io.Writer, since uint64) (uint64, error)

+ type StreamWriter struct

+ func (sw *StreamWriter) Flush() error

+ func (sw *StreamWriter) Prepare() error

+ func (sw *StreamWriter) Write(kvs *pb.KVList) error

type TableInfo

+ KeyCount uint64

type TableManifest

+ Checksum []byte

type Txn

+ func (txn *Txn) CommitWith(cb func(error))

+ func (txn *Txn) NewKeyIterator(key []byte, opt IteratorOptions) *Iterator

+ func (txn *Txn) ReadTs() uint64

+ type WriteBatch struct

+ func (wb *WriteBatch) Cancel()

+ func (wb *WriteBatch) Delete(k []byte) error

+ func (wb *WriteBatch) Error() error

+ func (wb *WriteBatch) Flush() error

+ func (wb *WriteBatch) Set(k, v []byte) error

+ func (wb *WriteBatch) SetEntry(e *Entry) error

+ func (wb *WriteBatch) SetMaxPendingTxns(max int)

Sep 19, 2018

Changes in this version

+ var ErrBlockedWrites = errors.New("Writes are blocked possibly due to DropAll")

type DB

+ func (db *DB) MaxBatchCount() int64

+ func (db *DB) MaxBatchSize() int64

type ManagedDB

+ func (db *ManagedDB) DropAll() error

+ func (db *ManagedDB) SetDiscardTs(ts uint64)

May 9, 2018

Changes in this version

type Item

+ func (item *Item) DiscardEarlierVersions() bool

type Options

+ NumVersionsToKeep int

+ ValueLogMaxEntries uint32

type Txn

+ func (txn *Txn) SetWithDiscard(key, val []byte, meta byte) error

May 2, 2018

Changes in this version

+ var ErrInvalidLoadingMode = errors.New("Invalid ValueLogLoadingMode, must be FileIO or MemoryMap")

+ var ErrReplayNeeded = errors.New("Database was not properly closed, cannot open read-only")

+ var ErrTruncateNeeded = errors.New(...)

+ var ErrValueThreshold = errors.New("Invalid ValueThreshold, must be lower than uint16.")

+ var ErrWindowsNotSupported = errors.New("Read-only mode is not supported on Windows")

+ var LSMOnlyOptions = Options

type DB

+ func (db *DB) GetMergeOperator(key []byte, f MergeFunc, dur time.Duration) *MergeOperator

+ func (db *DB) Tables() []TableInfo

type Item

+ func (item *Item) IsDeletedOrExpired() bool

+ func (item *Item) KeyCopy(dst []byte) []byte

+ func (item *Item) String() string

+ type MergeFunc func(existing, val []byte) []byte

+ type MergeOperator struct

+ func (op *MergeOperator) Add(val []byte) error

+ func (op *MergeOperator) Get() ([]byte, error)

+ func (op *MergeOperator) Stop()

type Options

+ ReadOnly bool

+ Truncate bool

+ ValueLogLoadingMode options.FileLoadingMode

type Sequence

+ func (seq *Sequence) Release() error

+ type TableInfo struct

+ ID uint64

+ Left []byte

+ Level int

+ Right []byte

Dec 12, 2017

Changes in this version

+ var ErrZeroBandwidth = errors.New("Bandwidth must be greater than zero")

type DB

+ func (db *DB) GetSequence(key []byte, bandwidth uint64) (*Sequence, error)

+ func (db *DB) Size() (lsm int64, vlog int64)

type ManagedDB

+ func (db *ManagedDB) GetSequence(_ []byte, _ uint64) (*Sequence, error)

+ type Sequence struct

+ func (seq *Sequence) Next() (uint64, error)

Nov 30, 2017

Changes in this version

type Entry

+ ExpiresAt uint64

type Txn

+ func (txn *Txn) SetEntry(e *Entry) error

Nov 13, 2017

Changes in this version

type Item

+ func (item *Item) ValueCopy(dst []byte) ([]byte, error)

Nov 2, 2017

Changes in this version

type Item

+ func (item *Item) ExpiresAt() uint64

type Txn

+ func (txn *Txn) SetWithMeta(key, val []byte, meta byte) error

+ func (txn *Txn) SetWithTTL(key, val []byte, dur time.Duration) error

Oct 31, 2017

Changes in this version

+ var ErrConflict = errors.New("Transaction Conflict. Please retry")

+ var ErrDiscardedTxn = errors.New("This transaction has been discarded. Create a new one")

+ var ErrEmptyKey = errors.New("Key cannot be empty")

+ var ErrInvalidDump = errors.New("Data dump cannot be read")

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

+ var ErrManagedTxn = errors.New("Invalid API request. Not allowed to perform this action using ManagedDB")

+ var ErrReadOnlyTxn = errors.New("No sets or deletes are allowed in a read-only transaction")

+ var ErrTxnTooBig = errors.New("Txn is too big to fit into one request")

+ type DB struct

+ func Open(opt Options) (db *DB, err error)

+ func (db *DB) Backup(w io.Writer, since uint64) (uint64, error)

+ func (db *DB) Close() (err error)

+ func (db *DB) Load(r io.Reader) error

+ func (db *DB) NewTransaction(update bool) *Txn

+ func (db *DB) PurgeOlderVersions() error

+ func (db *DB) PurgeVersionsBelow(key []byte, ts uint64) error

+ func (db *DB) RunValueLogGC(discardRatio float64) error

+ func (db *DB) Update(fn func(txn *Txn) error) error

+ func (db *DB) View(fn func(txn *Txn) error) error

+ type Item struct

+ func (item *Item) EstimatedSize() int64

+ func (item *Item) Key() []byte

+ func (item *Item) ToString() string

+ func (item *Item) UserMeta() byte

+ func (item *Item) Value() ([]byte, error)

+ func (item *Item) Version() uint64

type IteratorOptions

+ AllVersions bool

+ type ManagedDB struct

+ func OpenManaged(opts Options) (*ManagedDB, error)

+ func (db *ManagedDB) NewTransaction(update bool)

+ func (db *ManagedDB) NewTransactionAt(readTs uint64, update bool) *Txn

+ func (db *ManagedDB) PurgeVersionsBelow(key []byte, ts uint64) error

+ type Txn struct

+ func (txn *Txn) Commit(callback func(error)) error

+ func (txn *Txn) CommitAt(commitTs uint64, callback func(error)) error

+ func (txn *Txn) Delete(key []byte) error

+ func (txn *Txn) Discard()

+ func (txn *Txn) Get(key []byte) (item *Item, rerr error)

+ func (txn *Txn) NewIterator(opt IteratorOptions) *Iterator

+ func (txn *Txn) Set(key, val []byte, userMeta byte) error

Oct 30, 2017

Changes in this version

+ const BitDelete

+ const BitSetIfAbsent

+ const BitUnused

+ const BitValuePointer

+ const M

+ const ManifestFilename

+ var DefaultIteratorOptions = IteratorOptions

+ var DefaultOptions = Options

+ var ErrCasMismatch = errors.New("CompareAndSet failed due to counter mismatch")

+ var ErrInvalidDir = errors.New("Invalid Dir, directory does not exist")

+ var ErrInvalidRequest = errors.New("Invalid request")

+ var ErrKeyExists = errors.New("SetIfAbsent failed since key already exists")

+ var ErrNoRewrite = errors.New("Value log GC attempt didn't result in any cleanup")

+ var ErrRejected = errors.New("Value log GC request rejected")

+ var ErrRetry = errors.New("Unable to find log file. Please retry")

+ var ErrThresholdZero = errors.New("Value log GC can't run because threshold is set to zero")

+ var ErrValueLogSize = errors.New("Invalid ValueLogFileSize, must be between 1MB and 2GB")

+ func OpenDir(path string) (*os.File, error)

+ type DirectoryLockGuard struct

+ func AcquireDirectoryLock(dirPath string, pidFileName string) (*DirectoryLockGuard, error)

+ func (g *DirectoryLockGuard) Release() error

+ func (guard *DirectoryLockGuard) Release() error

+ type Entry struct

+ CASCounterCheck uint64

+ Error error

+ Key []byte

+ Meta byte

+ UserMeta byte

+ Value []byte

+ func EntriesDelete(s []*Entry, key []byte) []*Entry

+ func EntriesSet(s []*Entry, key, val []byte) []*Entry

+ type Iterator struct

+ func (it *Iterator) Close()

+ func (it *Iterator) Item() *KVItem

+ func (it *Iterator) Next()

+ func (it *Iterator) Rewind()

+ func (it *Iterator) Seek(key []byte)

+ func (it *Iterator) Valid() bool

+ func (it *Iterator) ValidForPrefix(prefix []byte) bool

+ type IteratorOptions struct

+ PrefetchSize int

+ PrefetchValues bool

+ Reverse bool

+ type KV struct

+ func NewKV(optParam *Options) (out *KV, err error)

+ func (db *KV) Backup(w io.Writer) error

+ func (s *KV) BatchSet(entries []*Entry) error

+ func (s *KV) BatchSetAsync(entries []*Entry, f func(error))

+ func (s *KV) Close() (err error)

+ func (s *KV) CompareAndDelete(key []byte, casCounter uint64) error

+ func (s *KV) CompareAndDeleteAsync(key []byte, casCounter uint64, f func(error))

+ func (s *KV) CompareAndSet(key []byte, val []byte, casCounter uint64) error

+ func (s *KV) CompareAndSetAsync(key []byte, val []byte, casCounter uint64, f func(error))

+ func (s *KV) Delete(key []byte) error

+ func (s *KV) DeleteAsync(key []byte, f func(error))

+ func (s *KV) Exists(key []byte) (bool, error)

+ func (s *KV) Get(key []byte, item *KVItem) error

+ func (s *KV) NewIterator(opt IteratorOptions) *Iterator

+ func (s *KV) RunValueLogGC(discardRatio float64) error

+ func (s *KV) Set(key, val []byte, userMeta byte) error

+ func (s *KV) SetAsync(key, val []byte, userMeta byte, f func(error))

+ func (s *KV) SetIfAbsent(key, val []byte, userMeta byte) error

+ func (s *KV) SetIfAbsentAsync(key, val []byte, userMeta byte, f func(error)) error

+ type KVItem struct

+ func (item *KVItem) Counter() uint64

+ func (item *KVItem) EstimatedSize() int64

+ func (item *KVItem) Key() []byte

+ func (item *KVItem) UserMeta() byte

+ func (item *KVItem) Value(consumer func([]byte) error) error

+ type LevelManifest struct

+ Tables map[uint64]struct{}

+ type Manifest struct

+ Creations int

+ Deletions int

+ Levels []LevelManifest

+ Tables map[uint64]TableManifest

+ func ReplayManifestFile(fp *os.File) (ret Manifest, truncOffset int64, err error)

+ type Options struct

+ Dir string

+ DoNotCompact bool

+ LevelOneSize int64

+ LevelSizeMultiplier int

+ MaxLevels int

+ MaxTableSize int64

+ NumCompactors int

+ NumLevelZeroTables int

+ NumLevelZeroTablesStall int

+ NumMemtables int

+ SyncWrites bool

+ TableLoadingMode options.FileLoadingMode

+ ValueDir string

+ ValueLogFileSize int64

+ ValueThreshold int

+ type TableManifest struct

+ Level uint8