badger

package module

Go to main page

Versions in this module

v1

v1.5.0

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

v1.4.0

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

v1.3.0

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)

v1.2.0

Nov 30, 2017

Changes in this version

type Entry

+ ExpiresAt uint64

type Txn

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

v1.1.1

Nov 28, 2017

v1.1.0

Nov 13, 2017

Changes in this version

type Item

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

v1.0.1

Nov 6, 2017

v1.0.0

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

v0

v0.9.0

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

v0.8.1

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

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL