# Packages
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Functions
IsNotFoundInStorageErr returns whether an error is a "not found in storage" error.
# Constants
DefaultDBPath is the default path for nodes databases.
DefaultEpochString is the default folder root name for node per epoch databases.
DefaultShardString is the default folder root name for per shard databases.
DefaultStaticDbString is the default name for the static databases (not changing with epoch).
MaxRetriesToCreateDB represents the maximum number of times to try to create DB if it failed.
PathEpochPlaceholder represents the placeholder for the epoch number in paths.
PathIdentifierPlaceholder represents the placeholder for the identifier in paths.
PathShardPlaceholder represents the placeholder for the shard ID in paths.
SleepTimeBetweenCreateDBRetries represents the number of seconds to sleep between DB creates.
TxPoolNumTxsToPreemptivelyEvict instructs tx pool eviction algorithm to remove this many transactions when eviction takes place.
# Variables
ErrBootstrapDataNotFoundInStorage signals that no BootstrapData was find in the storage.
ErrCacheSizeInvalid signals that size of cache is less than 1.
ErrCacheSizeIsLowerThanBatchSize signals that size of cache is lower than size of batch.
ErrCannotComputeStorageOldestEpoch signals an issue when computing the oldest epoch for storage.
ErrClosingPersisters signals that not all persisters were closed.
ErrDBIsClosed is raised when the DB is closed.
ErrDestroyingUnit signals that the destroy unit method did not manage to destroy all the persisters in a pruning storer.
ErrEpochKeepIsLowerThanNumActive signals that num epochs to keep is lower than num active epochs.
ErrInvalidConfig signals an invalid config.
ErrInvalidFilePath signals that an invalid file path has been provided.
ErrInvalidNumberOfActivePersisters signals that an invalid number of active persisters has been provided.
ErrInvalidNumberOfEpochsToSave signals that an invalid number of epochs to save has been provided.
ErrInvalidNumberOfOldPersisters signals that an invalid number of old persisters has been provided.
ErrInvalidNumberOfPersisters signals that an invalid number of persisters has been provided.
ErrKeyNotFound is raised when a key is not found.
ErrNilBootstrapDataProvider signals that a nil bootstrap data provider has been provided.
ErrNilCustomDatabaseRemover signals that a nil custom database remover has been provided.
ErrNilDBConfigHandler signals that a nil db config handler has been provided.
ErrNilDirectoryReader signals that a nil directory reader has been provided.
ErrNilEpochStartNotifier signals that a nil epoch start notifier has been provided.
ErrNilLatestStorageDataProvider signals that a nil latest storage data provider has been provided.
ErrNilManagedPeersHolder signals that a nil managed peers holder has been provided.
ErrNilMarshalizer signals that a nil marshalizer has been provided.
ErrNilNodeTypeProvider signals that a nil node type provider has been provided.
ErrNilOldDataCleanerProvider signals that a nil old data cleaner provider has been provided.
ErrNilPathManager signals that a nil path manager has been provided.
ErrNilPersisterFactory signals that a nil persister factory has been provided.
ErrNilPersistersTracker signals that a nil persisters tracker has been provided.
ErrNilShardCoordinator signals that a nil shard coordinator has been provided.
ErrNilShardIDProvider signals that a nil shard id provider has been provided.
ErrNilStatsCollector signals that a nil stats collector has been provided.
ErrNilStorageListProvider signals that a nil storage list provided has been provided.
ErrNotSupportedCacheType is raised when an unsupported cache type is provided.
ErrNotSupportedDBType is raised when an unsupported database type is provided.
ErrNotSupportedShardIDProviderType is raised when an unsupported shard id provider type is provided.
ErrWrongTypeAssertion is thrown when a wrong type assertion is spotted.
# Interfaces
AdaptedSizedLRUCache defines a cache that returns the evicted value.
Batcher allows to batch the data first then write the batch to the persister in one go.
Cacher provides caching services.
CustomDatabaseRemoverHandler defines the behaviour of a component that should tell if a database is removable or not.
DBConfigHandler defines the behaviour of a component that will handle db config.
DirectoryReaderHandler defines which actions should be done by a directory reader.
LatestStorageDataProviderHandler defines which actions be done by a component who fetches the latest data from storage.
ManagedPeersHolder defines the operations of an entity that holds managed identities for a node.
PathManagerHandler defines which actions should be done for generating paths for databases directories.
PersisterFactory defines which actions should be done for creating a persister.
PersisterFactoryHandler defines the behaviour of a component which is able to create persisters.
ShardCoordinator defines what a shard state coordinator should hold.
ShardIDProvider defines what a component which is able to provide persister id per key should do.
SizedLRUCacheHandler is the interface for size capable LRU cache.
StateStatsHandler defines the behaviour needed to handler storage statistics.
StoredDataFactory creates empty objects of the stored data type.
Storer provides storage services in a two layered storage construct, where the first layer is represented by a cache and second layer by a persistent storage (DB-like).
StorerWithPutInEpoch is an extended storer with the ability to set the epoch which will be used for put operations.
TimeCacher defines the cache that can keep a record for a bounded time.
UnitOpenerHandler defines which actions should be done for opening storage units.
# Type aliases
LatestDataFromStorage represents the DTO structure to return from storage.
Persister provides storage of data services in a database like construct.
PersisterCreator defines the behavour of a component which is able to create a persister.