storage

package
v0.24.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 8, 2019 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	DelimiterSegmentLength = -1
	VariadicSegmentLength  = 0
)

Variables

This section is empty.

Functions

func AddTreePrintTree added in v0.24.0 

func AddTreePrintTree(edge string, tree treeprint.Tree, rwt KVCallbackIterableReader)

func CompareKeys 

func CompareKeys(k1, k2 []byte) int

Sorts the keys as if they were compared lexicographically with their KeyOrder prepended

func EnsureKeyFormatStore added in v0.24.0 

func EnsureKeyFormatStore(ks interface{}) error

func KVCallbackIterator added in v0.24.0 

func KVCallbackIterator(rit KVCallbackIterable, ascending bool, low, high []byte) dbm.Iterator

func KeyOrder 

func KeyOrder(key []byte) int

KeyOrder maps []byte{} -> -1, []byte(nil) -> 1, and everything else to 0. This encodes the assumptions of the KVIterator domain endpoints

func MarshalCommitID added in v0.24.0 

func MarshalCommitID(hash []byte, version int64) ([]byte, error)

func NormaliseDomain 

func NormaliseDomain(low, high []byte) ([]byte, []byte)

NormaliseDomain encodes the assumption that when nil is used as a lower bound is interpreted as low rather than high

func Uniq 

func Uniq(source KVIterator) *uniqueIterator

Types

type ByteSlicable 

type ByteSlicable interface {
	Bytes() []byte
}

type CacheDB 

type CacheDB struct {
	// contains filtered or unexported fields
}

func NewCacheDB 

func NewCacheDB(backend KVIterableReader) *CacheDB

func (*CacheDB) Close 

func (cdb *CacheDB) Close()

func (*CacheDB) Commit 

func (cdb *CacheDB) Commit(writer KVWriter)

func (*CacheDB) Delete 

func (cdb *CacheDB) Delete(key []byte)

func (*CacheDB) DeleteSync 

func (cdb *CacheDB) DeleteSync(key []byte)

func (*CacheDB) Get 

func (cdb *CacheDB) Get(key []byte) []byte

DB implementation

func (*CacheDB) Has 

func (cdb *CacheDB) Has(key []byte) bool

func (*CacheDB) Iterator 

func (cdb *CacheDB) Iterator(low, high []byte) KVIterator

func (*CacheDB) NewBatch 

func (cdb *CacheDB) NewBatch() dbm.Batch

func (*CacheDB) Print 

func (cdb *CacheDB) Print()

func (*CacheDB) ReverseIterator 

func (cdb *CacheDB) ReverseIterator(low, high []byte) KVIterator

func (*CacheDB) Set 

func (cdb *CacheDB) Set(key, value []byte)

func (*CacheDB) SetSync 

func (cdb *CacheDB) SetSync(key, value []byte)

func (*CacheDB) Stats 

func (cdb *CacheDB) Stats() map[string]string

type ChannelIterator 

type ChannelIterator struct {
	// contains filtered or unexported fields
}

func NewChannelIterator 

func NewChannelIterator(ch <-chan KVPair, start, end []byte) *ChannelIterator

ChannelIterator wraps a stream of kvp KVPairs over a channel as a stateful KVIterator. The start and end keys provided are purely indicative (for Domain()) and are assumed to be honoured by the input channel - they are not checked and keys are not sorted. NewChannelIterator will block until the first value is received over the channel.

func (*ChannelIterator) Close 

func (it *ChannelIterator) Close()

func (*ChannelIterator) Domain 

func (it *ChannelIterator) Domain() ([]byte, []byte)

func (*ChannelIterator) Key 

func (it *ChannelIterator) Key() []byte

func (*ChannelIterator) Next 

func (it *ChannelIterator) Next()

func (*ChannelIterator) Valid 

func (it *ChannelIterator) Valid() bool

func (*ChannelIterator) Value 

func (it *ChannelIterator) Value() []byte

type CommitID added in v0.24.0 

type CommitID struct {
	Hash    binary.HexBytes
	Version int64
}

func UnmarshalCommitID added in v0.24.0 

func UnmarshalCommitID(bs []byte) (*CommitID, error)

func (CommitID) String added in v0.24.0 

func (cid CommitID) String() string

type ContentAddressedStore 

type ContentAddressedStore struct {
	// contains filtered or unexported fields
}

func NewContentAddressedStore 

func NewContentAddressedStore(db dbm.DB) *ContentAddressedStore

func (*ContentAddressedStore) Get 

func (cas *ContentAddressedStore) Get(hash []byte) ([]byte, error)

func (*ContentAddressedStore) Put 

func (cas *ContentAddressedStore) Put(data []byte) ([]byte, error)

Put data in the database by saving data with a key that is its sha256 hash

type ForestOption added in v0.24.0 

type ForestOption func(*ImmutableForest)
var WithOverwriting ForestOption = func(imf *ImmutableForest) { imf.overwriting = true }

type ForestReader added in v0.24.0 

type ForestReader interface {
	Reader(prefix []byte) (KVCallbackIterableReader, error)
}

type ImmutableForest added in v0.24.0 

type ImmutableForest struct {
	// contains filtered or unexported fields
}

func NewImmutableForest added in v0.24.0 

func NewImmutableForest(commitsTree KVCallbackIterableReader, treeDB dbm.DB, cacheSize int,
	options ...ForestOption) (*ImmutableForest, error)

func (*ImmutableForest) Dump added in v0.24.0 

func (imf *ImmutableForest) Dump() string

func (*ImmutableForest) Iterate added in v0.24.0 

func (imf *ImmutableForest) Iterate(start, end []byte, ascending bool, fn func(prefix []byte, tree KVCallbackIterableReader) error) error

func (*ImmutableForest) IterateRWTree added in v0.24.0 

func (imf *ImmutableForest) IterateRWTree(start, end []byte, ascending bool, fn func(prefix []byte, tree *RWTree) error) error

func (*ImmutableForest) Reader added in v0.24.0 

func (imf *ImmutableForest) Reader(prefix []byte) (KVCallbackIterableReader, error)

Get the tree at prefix for making reads

type ImmutableTree added in v0.24.0 

type ImmutableTree struct {
	*iavl.ImmutableTree
}

func (*ImmutableTree) Get added in v0.24.0 

func (imt *ImmutableTree) Get(key []byte) []byte

func (*ImmutableTree) Iterate added in v0.24.0 

func (imt *ImmutableTree) Iterate(start, end []byte, ascending bool, fn func(key []byte, value []byte) error) error

type KVCache 

type KVCache struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func NewKVCache 

func NewKVCache() *KVCache

Creates an in-memory cache wrapping a map that stores the provided tombstone value for deleted keys

func (*KVCache) Delete 

func (kvc *KVCache) Delete(key []byte)

func (*KVCache) Get 

func (kvc *KVCache) Get(key []byte) []byte

func (*KVCache) Has 

func (kvc *KVCache) Has(key []byte) bool

func (*KVCache) Info 

func (kvc *KVCache) Info(key []byte) (value []byte, deleted bool)

func (*KVCache) Iterator 

func (kvc *KVCache) Iterator(low, high []byte) KVIterator

func (*KVCache) Reset 

func (kvc *KVCache) Reset()

func (*KVCache) ReverseIterator 

func (kvc *KVCache) ReverseIterator(low, high []byte) KVIterator

func (*KVCache) Set 

func (kvc *KVCache) Set(key, value []byte)

func (*KVCache) WriteTo 

func (kvc *KVCache) WriteTo(writer KVWriter)

Writes contents of cache to backend without flushing the cache

type KVCacheIterator 

type KVCacheIterator struct {
	// contains filtered or unexported fields
}

func (*KVCacheIterator) Close 

func (kvi *KVCacheIterator) Close()

func (*KVCacheIterator) Domain 

func (kvi *KVCacheIterator) Domain() ([]byte, []byte)

func (*KVCacheIterator) Info 

func (kvi *KVCacheIterator) Info() (key, value []byte, deleted bool)

func (*KVCacheIterator) Key 

func (kvi *KVCacheIterator) Key() []byte

func (*KVCacheIterator) Next 

func (kvi *KVCacheIterator) Next()

func (*KVCacheIterator) Valid 

func (kvi *KVCacheIterator) Valid() bool

func (*KVCacheIterator) Value 

func (kvi *KVCacheIterator) Value() []byte

type KVCallbackIterable added in v0.24.0 

type KVCallbackIterable interface {
	// low must be lexicographically less than high. high is exclusive unless it is nil in which case it is inclusive.
	// ascending == false reverses order.
	Iterate(low, high []byte, ascending bool, fn func(key []byte, value []byte) error) error
}

Provides the native iteration for IAVLTree

type KVCallbackIterableReader added in v0.24.0 

type KVCallbackIterableReader interface {
	KVReader
	KVCallbackIterable
}

type KVCascade 

type KVCascade []KVIterableReader

func (KVCascade) Get 

func (kvc KVCascade) Get(key []byte) []byte

func (KVCascade) Has 

func (kvc KVCascade) Has(key []byte) bool

func (KVCascade) Iterator 

func (kvc KVCascade) Iterator(low, high []byte) KVIterator

func (KVCascade) ReverseIterator 

func (kvc KVCascade) ReverseIterator(low, high []byte) KVIterator

type KVIterable 

type KVIterable interface {
	// Iterator over a domain of keys in ascending order. high is exclusive.
	// low must be less than high, or the Iterator is invalid.
	// Iterator must be closed by caller.
	// To iterate over entire domain, use store.Iterator(nil, nil)
	// CONTRACT: No writes may happen within a domain while an iterator exists over it.
	Iterator(low, high []byte) KVIterator

	// Iterator over a domain of keys in descending order. high is exclusive.
	//  must be less than high, or the Iterator is invalid.
	// Iterator must be closed by caller.
	// CONTRACT: No writes may happen within a domain while an iterator exists over it.
	ReverseIterator(low, high []byte) KVIterator
}

This is partially extrated from Cosmos SDK for alignment but is more minimal, we should suggest this becomes an embedded interface

type KVIterableReader 

type KVIterableReader interface {
	KVReader
	KVIterable
}

type KVIterator 

type KVIterator = dbm.Iterator

type KVPair 

type KVPair struct {
	Key   []byte
	Value []byte
}

func (KVPair) String 

func (kv KVPair) String() string

type KVPairs 

type KVPairs []KVPair

func (KVPairs) Len 

func (kvp KVPairs) Len() int

func (KVPairs) Less 

func (kvp KVPairs) Less(i, j int) bool

func (KVPairs) Sorted 

func (kvp KVPairs) Sorted() KVPairs

func (KVPairs) Swap 

func (kvp KVPairs) Swap(i, j int)

type KVReader 

type KVReader interface {
	// Get returns nil iff key doesn't exist. Panics on nil key.
	Get(key []byte) []byte
	// Has checks if a key exists. Panics on nil key.
	Has(key []byte) bool
}

type KVReaderWriter 

type KVReaderWriter interface {
	KVReader
	KVWriter
}

KVStore is a simple interface to get/set data

type KVStore 

type KVStore interface {
	KVReaderWriter
	KVIterable
}

type KVWriter 

type KVWriter interface {
	// Set sets the key. Panics on nil key.
	Set(key, value []byte)
	// Delete deletes the key. Panics on nil key.
	Delete(key []byte)
}

type KeyFormat 

type KeyFormat struct {
	// contains filtered or unexported fields
}

Provides a fixed-width lexicographically sortable []byte key format

func NewKeyFormat 

func NewKeyFormat(prefix string, layout ...int) (*KeyFormat, error)

Create a []byte key format based on a single byte prefix and fixed width key segments each of whose length is specified by by the corresponding element of layout. A final segment length of 0 can be used to indicate a variadic final element that may be of arbitrary length.

For example, to store keys that could index some objects by a version number and their SHA256 hash using the form: 'c<version uint64><hash [32]byte>' then you would define the KeyFormat with: 

var keyFormat = NewKeyFormat('c', 8, 32)

Then you can create a key with: 

func ObjectKey(version uint64, objectBytes []byte) []byte {
	hasher := sha256.New()
	hasher.Sum(nil)
	return keyFormat.Key(version, hasher.Sum(nil))
}}

func (*KeyFormat) Fix 

func (kf *KeyFormat) Fix(args ...interface{}) (*KeyFormat, error)

Fixes the first args many segments as the prefix of a new KeyFormat by using the args to generate a key that becomes that prefix. Any remaining unassigned segments become the layout of the new KeyFormat.

func (*KeyFormat) Iterator 

func (kf *KeyFormat) Iterator(iterable KVIterable, start, end []byte, reverse ...bool) KVIterator

Returns an iterator over the underlying iterable using this KeyFormat's prefix. This is to support proper iteration over the prefix in the presence of nil start or end which requests iteration to the inclusive edges of the domain. An optional argument for reverse can be passed to get reverse iteration.

func (*KeyFormat) Key 

func (kf *KeyFormat) Key(args ...interface{}) ([]byte, error)

Format the args passed into the key format - will panic if the arguments passed do not match the length of the segment to which they correspond. When called with no arguments returns the raw prefix (useful as a start element of the entire keys space when sorted lexicographically).

func (*KeyFormat) KeyBytes 

func (kf *KeyFormat) KeyBytes(segments ...[]byte) ([]byte, error)

Format the byte segments into the key format - will panic if the segment lengths do not match the layout.

func (*KeyFormat) KeyNoPrefix added in v0.24.0 

func (kf *KeyFormat) KeyNoPrefix(args ...interface{}) (Prefix, error)

Like Key but removes the prefix string

func (*KeyFormat) Layout 

func (kf *KeyFormat) Layout() []int

func (*KeyFormat) NumSegments 

func (kf *KeyFormat) NumSegments() int

func (*KeyFormat) Prefix 

func (kf *KeyFormat) Prefix() Prefix

Return the Key as a prefix - may just be the literal prefix, or an entire key

func (*KeyFormat) Scan 

func (kf *KeyFormat) Scan(key []byte, args ...interface{}) error

Extracts the segments into the values pointed to by each of args. Each arg must be a pointer to int64, uint64, or []byte, and the width of the args must match layout.

func (*KeyFormat) ScanBytes 

func (kf *KeyFormat) ScanBytes(key []byte) [][]byte

Reads out the bytes associated with each segment of the key format from key.

func (*KeyFormat) ScanNoPrefix added in v0.24.0 

func (kf *KeyFormat) ScanNoPrefix(key []byte, args ...interface{}) error

Like Scan but adds expects a key with the KeyFormat's prefix trimmed

func (*KeyFormat) String 

func (kf *KeyFormat) String() string

func (*KeyFormat) Unprefixed 

func (kf *KeyFormat) Unprefixed() *KeyFormat

type MultiIterator 

type MultiIterator struct {
	// contains filtered or unexported fields
}

func NewMultiIterator 

func NewMultiIterator(reverse bool, iterators ...KVIterator) *MultiIterator

MultiIterator iterates in order over a series o

func (*MultiIterator) Close 

func (mi *MultiIterator) Close()

func (*MultiIterator) Domain 

func (mi *MultiIterator) Domain() ([]byte, []byte)

func (*MultiIterator) Key 

func (mi *MultiIterator) Key() []byte

func (*MultiIterator) Len 

func (mi *MultiIterator) Len() int

sort.Interface implementation

func (*MultiIterator) Less 

func (mi *MultiIterator) Less(i, j int) bool

func (*MultiIterator) Next 

func (mi *MultiIterator) Next()

func (*MultiIterator) Peek 

func (mi *MultiIterator) Peek() KVIterator

func (*MultiIterator) Pop 

func (mi *MultiIterator) Pop() interface{}

func (*MultiIterator) Push 

func (mi *MultiIterator) Push(x interface{})

func (*MultiIterator) Swap 

func (mi *MultiIterator) Swap(i, j int)

func (*MultiIterator) Valid 

func (mi *MultiIterator) Valid() bool

func (*MultiIterator) Value 

func (mi *MultiIterator) Value() []byte

type MustKeyFormat 

type MustKeyFormat struct {
	KeyFormat
}

MustKeyFormat for panicking early when a KeyFormat does not parse

func NewMustKeyFormat 

func NewMustKeyFormat(prefix string, layout ...int) *MustKeyFormat

func (*MustKeyFormat) Fix 

func (kf *MustKeyFormat) Fix(args ...interface{}) *MustKeyFormat

func (*MustKeyFormat) Key 

func (kf *MustKeyFormat) Key(args ...interface{}) []byte

func (*MustKeyFormat) KeyBytes 

func (kf *MustKeyFormat) KeyBytes(segments ...[]byte) []byte

func (*MustKeyFormat) KeyNoPrefix added in v0.24.0 

func (kf *MustKeyFormat) KeyNoPrefix(args ...interface{}) Prefix

func (*MustKeyFormat) Unprefixed added in v0.24.0 

func (kf *MustKeyFormat) Unprefixed() *MustKeyFormat

type MutableForest added in v0.24.0 

type MutableForest struct {
	*ImmutableForest
	// contains filtered or unexported fields
}

func NewMutableForest added in v0.24.0 

func NewMutableForest(db dbm.DB, cacheSize int) (*MutableForest, error)

func (*MutableForest) Delete added in v0.24.0 

func (muf *MutableForest) Delete(prefix []byte) (*CommitID, error)

Delete a tree - if the tree exists will return the CommitID of the latest saved version

func (*MutableForest) GetImmutable added in v0.24.0 

func (muf *MutableForest) GetImmutable(version int64) (*ImmutableForest, error)

func (*MutableForest) Hash added in v0.24.0 

func (muf *MutableForest) Hash() []byte

Get the current global hash for all trees in this forest

func (*MutableForest) Load added in v0.24.0 

func (muf *MutableForest) Load(version int64) error

Load mutable forest from database, pass overwriting = true if you wish to make writes to version version + 1. this will

func (*MutableForest) Save added in v0.24.0 

func (muf *MutableForest) Save() ([]byte, int64, error)

func (*MutableForest) Version added in v0.24.0 

func (muf *MutableForest) Version() int64

Get the current global version for all versions of all trees in this forest

func (*MutableForest) Writer added in v0.24.0 

func (muf *MutableForest) Writer(prefix []byte) (*RWTree, error)

Calls to writer should be serialised as should writes to the tree

type MutableTree added in v0.24.0 

type MutableTree struct {
	*iavl.MutableTree
}

func NewMutableTree added in v0.24.0 

func NewMutableTree(db dbm.DB, cacheSize int) *MutableTree

func (*MutableTree) Get added in v0.24.0 

func (mut *MutableTree) Get(key []byte) []byte

func (*MutableTree) GetImmutable added in v0.24.0 

func (mut *MutableTree) GetImmutable(version int64) (*ImmutableTree, error)

func (*MutableTree) Iterate added in v0.24.0 

func (mut *MutableTree) Iterate(start, end []byte, ascending bool, fn func(key []byte, value []byte) error) error

func (*MutableTree) IterateWriteTree added in v0.24.0 

func (mut *MutableTree) IterateWriteTree(start, end []byte, ascending bool, fn func(key []byte, value []byte) error) error

func (*MutableTree) Load added in v0.24.0 

func (mut *MutableTree) Load(version int64, overwriting bool) error

type Prefix 

type Prefix []byte

func NewPrefix 

func NewPrefix(bs []byte) Prefix

func (Prefix) Above 

func (p Prefix) Above() []byte

Get the lexicographical sibling above this prefix (i.e. the fixed length integer plus one)

func (Prefix) Below 

func (p Prefix) Below() []byte

Get the lexicographical sibling below this prefix (i.e. the fixed length integer minus one)

func (Prefix) CallbackIterable added in v0.24.0 

func (p Prefix) CallbackIterable(source KVCallbackIterable) *prefixCallbackIterable

func (Prefix) HexString 

func (p Prefix) HexString() string

func (Prefix) Iterable 

func (p Prefix) Iterable(source KVIterable) KVIterable

func (Prefix) Iterator 

func (p Prefix) Iterator(iteratorFn func(start, end []byte) dbm.Iterator, start, end []byte) KVIterator

func (Prefix) Key 

func (p Prefix) Key(key []byte) []byte

func (Prefix) Length 

func (p Prefix) Length() int

func (Prefix) Store 

func (p Prefix) Store(source KVStore) KVStore

func (Prefix) String 

func (p Prefix) String() string

func (Prefix) Suffix 

func (p Prefix) Suffix(key []byte) []byte

type PrefixDB 

type PrefixDB struct {
	// contains filtered or unexported fields
}

func NewPrefixDB 

func NewPrefixDB(db dbm.DB, prefix string) *PrefixDB

func (*PrefixDB) Close 

func (pdb *PrefixDB) Close()

func (*PrefixDB) Delete 

func (pdb *PrefixDB) Delete(key []byte)

func (*PrefixDB) DeleteSync 

func (pdb *PrefixDB) DeleteSync(key []byte)

func (*PrefixDB) Get 

func (pdb *PrefixDB) Get(key []byte) []byte

DB implementation

func (*PrefixDB) Has 

func (pdb *PrefixDB) Has(key []byte) bool

func (*PrefixDB) Iterator 

func (pdb *PrefixDB) Iterator(low, high []byte) KVIterator

func (*PrefixDB) NewBatch 

func (pdb *PrefixDB) NewBatch() dbm.Batch

func (*PrefixDB) Print 

func (pdb *PrefixDB) Print()

func (*PrefixDB) ReverseIterator 

func (pdb *PrefixDB) ReverseIterator(low, high []byte) KVIterator

func (*PrefixDB) Set 

func (pdb *PrefixDB) Set(key, value []byte)

func (*PrefixDB) SetSync 

func (pdb *PrefixDB) SetSync(key, value []byte)

func (*PrefixDB) Stats 

func (pdb *PrefixDB) Stats() map[string]string

type RWTree 

type RWTree struct {

	// Read-only tree serving previous state
	*ImmutableTree
	// contains filtered or unexported fields
}

func NewRWTree 

func NewRWTree(db dbm.DB, cacheSize int) *RWTree

Creates a concurrency safe version of an IAVL tree whereby reads are routed to the last saved tree. Writes must be serialised (as they are within a commit for example).

func (*RWTree) Delete 

func (rwt *RWTree) Delete(key []byte) ([]byte, bool)

func (*RWTree) Dump added in v0.24.0 

func (rwt *RWTree) Dump() string

func (*RWTree) GetImmutable added in v0.24.0 

func (rwt *RWTree) GetImmutable(version int64) (*ImmutableTree, error)

func (*RWTree) IterateWriteTree added in v0.24.0 

func (rwt *RWTree) IterateWriteTree(start, end []byte, ascending bool, fn func(key []byte, value []byte) error) error

func (*RWTree) Load 

func (rwt *RWTree) Load(version int64, overwriting bool) error

Tries to load the execution state from DB, returns nil with no error if no state found

func (*RWTree) Save 

func (rwt *RWTree) Save() ([]byte, int64, error)

Save the current write tree making writes accessible from read tree.

func (*RWTree) Set 

func (rwt *RWTree) Set(key, value []byte) bool

func (*RWTree) Updated added in v0.24.0 

func (rwt *RWTree) Updated() bool

Returns true if there have been any writes since last save

type Trie 

type Trie struct {
	Root *TrieNode
}

func NewTrie 

func NewTrie() *Trie

type TrieNode 

type TrieNode struct {
	// contains filtered or unexported fields
}

func (*TrieNode) Insert 

func (tn *TrieNode) Insert(key, value []byte)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.