storageUnit

Documentation

Index

• func NewBloomFilter(conf BloomConfig) (storage.BloomFilter, error)
• func NewCache(cacheType CacheType, size uint32, shards uint32) (storage.Cacher, error)
• func NewDB(dbType DBType, path string, batchDelaySeconds int, maxBatchSize int) (storage.Persister, error)
• type BloomConfig
• type CacheConfig
• type CacheType
• type DBConfig
• type DBType
• type HasherType
  • func (h HasherType) NewHasher() (hashing.Hasher, error)
• type Unit
  • func NewShardedStorageUnitFromConf(cacheConf CacheConfig, dbConf DBConfig, bloomFilterConf BloomConfig, ...) (*Unit, error)
  • func NewStorageUnit(c storage.Cacher, p storage.Persister) (*Unit, error)
  • func NewStorageUnitFromConf(cacheConf CacheConfig, dbConf DBConfig, bloomFilterConf BloomConfig) (*Unit, error)
  • func NewStorageUnitWithBloomFilter(c storage.Cacher, p storage.Persister, b storage.BloomFilter) (*Unit, error)
  • func (s *Unit) ClearCache()
  • func (s *Unit) DestroyUnit() error
  • func (s *Unit) Get(key []byte) ([]byte, error)
  • func (s *Unit) Has(key []byte) error
  • func (s *Unit) HasOrAdd(key []byte, value []byte) error
  • func (s *Unit) Put(key, data []byte) error
  • func (s *Unit) Remove(key []byte) error
• type UnitConfig

Functions

func NewBloomFilter

func NewBloomFilter(conf BloomConfig) (storage.BloomFilter, error)

NewBloomFilter creates a new bloom filter from bloom filter config

func NewCache

func NewCache(cacheType CacheType, size uint32, shards uint32) (storage.Cacher, error)

NewCache creates a new cache from a cache config TODO: add a cacher factory or a cacheConfig param instead

func NewDB

func NewDB(dbType DBType, path string, batchDelaySeconds int, maxBatchSize int) (storage.Persister, error)

NewDB creates a new database from database config

Types

type BloomConfig

type BloomConfig struct {
	Size     uint
	HashFunc []HasherType
}

BloomConfig holds the configurable elements of a bloom filter

type CacheConfig

type CacheConfig struct {
	Size   uint32
	Type   CacheType
	Shards uint32
}

CacheConfig holds the configurable elements of a cache

type CacheType

type CacheType string

CacheType represents the type of the supported caches

const (
	LRUCache         CacheType = "LRU"
	FIFOShardedCache CacheType = "FIFOSharded"
)

LRUCache is currently the only supported Cache type

type DBConfig

type DBConfig struct {
	FilePath          string
	Type              DBType
	BatchDelaySeconds int
	MaxBatchSize      int
}

DBConfig holds the configurable elements of a database

type DBType

type DBType string

DBType represents the type of the supported databases

const (
	LvlDB       DBType = "LvlDB"
	LvlDbSerial DBType = "LvlDBSerial"
	BadgerDB    DBType = "BadgerDB"
	BoltDB      DBType = "BoltDB"
)

LvlDB currently the only supported DBs More to be added

type HasherType

type HasherType string

HasherType represents the type of the supported hash functions

const (
	// Keccak is the string representation of the keccak hashing function
	Keccak HasherType = "Keccak"
	// Blake2b is the string representation of the blake2b hashing function
	Blake2b HasherType = "Blake2b"
	// Fnv is the string representation of the fnv hashing function
	Fnv HasherType = "Fnv"
)

func (HasherType) NewHasher

func (h HasherType) NewHasher() (hashing.Hasher, error)

NewHasher will return a hasher implementation form the string HasherType

type Unit

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

Unit represents a storer's data bank holding the cache, persistance unit and bloom filter

func NewShardedStorageUnitFromConf

func NewShardedStorageUnitFromConf(cacheConf CacheConfig, dbConf DBConfig, bloomFilterConf BloomConfig, shardId uint32) (*Unit, error)

NewShardedStorageUnitFromConf creates a new sharded storage unit from a storage unit config

func NewStorageUnit

func NewStorageUnit(c storage.Cacher, p storage.Persister) (*Unit, error)

NewStorageUnit is the constructor for the storage unit, creating a new storage unit from the given cacher and persister.

func NewStorageUnitFromConf

func NewStorageUnitFromConf(cacheConf CacheConfig, dbConf DBConfig, bloomFilterConf BloomConfig) (*Unit, error)

NewStorageUnitFromConf creates a new storage unit from a storage unit config

func NewStorageUnitWithBloomFilter

func NewStorageUnitWithBloomFilter(c storage.Cacher, p storage.Persister, b storage.BloomFilter) (*Unit, error)

NewStorageUnitWithBloomFilter is the constructor for the storage unit, creating a new storage unit from the given cacher, persister and bloom filter.

func (*Unit) ClearCache

func (s *Unit) ClearCache()

ClearCache cleans up the entire cache

func (*Unit) DestroyUnit

func (s *Unit) DestroyUnit() error

DestroyUnit cleans up the bloom filter, the cache, and the db

func (*Unit) Get

func (s *Unit) Get(key []byte) ([]byte, error)

Get searches the key in the cache. In case it is not found, it searches for the key in bloom filter first and if found it further searches it in the associated database. In case it is found in the database, the cache is updated with the value as well.

func (*Unit) Has

func (s *Unit) Has(key []byte) error

Has checks if the key is in the Unit. It first checks the cache. If it is not found, it checks the bloom filter and if present it checks the db

func (*Unit) HasOrAdd

func (s *Unit) HasOrAdd(key []byte, value []byte) error

HasOrAdd checks if the key is present in the storage and if not adds it. it updates the cache either way it returns if the value was originally found

func (*Unit) Put

func (s *Unit) Put(key, data []byte) error

Put adds data to both cache and persistance medium and updates the bloom filter

func (*Unit) Remove

func (s *Unit) Remove(key []byte) error

Remove removes the data associated to the given key from both cache and persistance medium

type UnitConfig

type UnitConfig struct {
	CacheConf CacheConfig
	DBConf    DBConfig
	BloomConf BloomConfig
}

UnitConfig holds the configurable elements of the storage unit