Documentation
¶
Index ¶
- Constants
- Variables
- func MVCCEncode(key []byte, version int64) (dst []byte)
- func MVCCKeyCompare(a, b []byte) int
- func SplitMVCCKey(mvccKey []byte) (key, version []byte, ok bool)
- type Batch
- type Database
- func (db *Database) ApplyChangeset(version int64, cs *proto.NamedChangeSet) error
- func (db *Database) Close() error
- func (db *Database) Get(storeKey string, targetVersion int64, key []byte) ([]byte, error)
- func (db *Database) GetEarliestVersion() (int64, error)
- func (db *Database) GetLatestVersion() (int64, error)
- func (db *Database) Has(storeKey string, version int64, key []byte) (bool, error)
- func (db *Database) Import(version int64, ch <-chan types.SnapshotNode) error
- func (db *Database) Iterator(storeKey string, version int64, start, end []byte) (types.DBIterator, error)
- func (db *Database) Prune(version int64) error
- func (db *Database) RawIterate(storeKey string, fn func(key []byte, value []byte, version int64) bool) (bool, error)
- func (db *Database) ReverseIterator(storeKey string, version int64, start, end []byte) (types.DBIterator, error)
- func (db *Database) SetEarliestVersion(version int64) error
- func (db *Database) SetLatestVersion(version int64) error
Constants ¶
const ( VersionSize = 8 PrefixStore = "s/k:" LenPrefixStore = 4 StorePrefixTpl = "s/k:%s/" // s/k:<storeKey> // TODO: Make configurable ImportCommitBatchSize = 10000 PruneCommitBatchSize = 50 )
Variables ¶
var MVCCComparer = &pebble.Comparer{ Name: "ss_pebbledb_comparator", Compare: MVCCKeyCompare, AbbreviatedKey: func(k []byte) uint64 { key, _, ok := SplitMVCCKey(k) if !ok { return 0 } return pebble.DefaultComparer.AbbreviatedKey(key) }, Equal: func(a, b []byte) bool { return MVCCKeyCompare(a, b) == 0 }, Separator: func(dst, a, b []byte) []byte { aKey, _, ok := SplitMVCCKey(a) if !ok { return append(dst, a...) } bKey, _, ok := SplitMVCCKey(b) if !ok { return append(dst, a...) } if bytes.Equal(aKey, bKey) { return append(dst, a...) } n := len(dst) dst = pebble.DefaultComparer.Separator(dst, aKey, bKey) buf := dst[n:] if bytes.Equal(aKey, buf) { return append(dst[:n], a...) } return append(dst, 0) }, ImmediateSuccessor: func(dst, a []byte) []byte { return append(append(dst, a...), 0) }, Successor: func(dst, a []byte) []byte { aKey, _, ok := SplitMVCCKey(a) if !ok { return append(dst, a...) } n := len(dst) dst = pebble.DefaultComparer.Successor(dst, aKey) buf := dst[n:] if bytes.Equal(aKey, buf) { return append(dst[:n], a...) } return append(dst, 0) }, FormatKey: func(k []byte) fmt.Formatter { return mvccKeyFormatter{key: k} }, Split: func(k []byte) int { key, _, ok := SplitMVCCKey(k) if !ok { return len(k) } return len(key) + 1 }, }
MVCCComparer returns a PebbleDB Comparer with encoding and decoding routines for MVCC control, used to compare and store versioned keys.
Note: This Comparer implementation is largely based on PebbleDB's internal MVCC example, which can be found here: https://github.com/cockroachdb/pebble/blob/master/cmd/pebble/mvcc.go
Functions ¶
func MVCCEncode ¶
<key>\x00[<version>]<#version-bytes>
func SplitMVCCKey ¶
SplitMVCCKey accepts an MVCC key and returns the "user" key, the MVCC version, and a boolean indicating if the provided key is an MVCC key.
Note, internally, we must make a copy of the provided mvccKey argument, which typically comes from the Key() method as it's not safe.
Types ¶
type Database ¶
type Database struct {
// contains filtered or unexported fields
}
func (*Database) ApplyChangeset ¶
func (db *Database) ApplyChangeset(version int64, cs *proto.NamedChangeSet) error
func (*Database) GetEarliestVersion ¶ added in v0.0.18
func (*Database) GetLatestVersion ¶
func (*Database) Import ¶
func (db *Database) Import(version int64, ch <-chan types.SnapshotNode) error
Import loads the initial version of the state in parallel with numWorkers goroutines TODO: Potentially add retries instead of panics
func (*Database) Prune ¶
Prune attempts to prune all versions up to and including the current version Get the range of keys, manually iterate over them and delete them We add a heuristic to skip over a module's keys during pruning if it hasn't been updated since the last time pruning occurred. NOTE: There is a rare case when a module's keys are skipped during pruning even though it has been updated. This occurs when that module is updated in between pruning runs, the node after is restarted. This is not a large issue given the next time that module is updated, it will be properly pruned thereafter.
func (*Database) RawIterate ¶ added in v0.0.23
func (db *Database) RawIterate(storeKey string, fn func(key []byte, value []byte, version int64) bool) (bool, error)
RawIterate iterates over all keys and values for a store
Source Files