modulepackage
0.7.0
Repository: https://github.com/filecoin-project/dagstore.git
Documentation: pkg.go.dev
# README
DAG store
This README will be populated soon. In the meantime, please refer to the design document.
License
Dual-licensed: MIT, Apache Software License v2, by way of the Permissive License Stack.
# 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
Package throttle includes throttlers for composing in various contexts, such as inside Mounts for costly operations, and within the DAG store itself.
# Functions
NewDAGStore constructs a new DAG store with the supplied configuration.
No description provided by the author
RecoverImmediately takes a failureCh where DAGStore failures are sent, and attempts to recover the shard immediately up until maxAttempts for each unique shard.
# Constants
DoNotRecover will not recover any failed shards on start.
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
RecoverNow will eagerly trigger a recovery for all failed shards upon start.
RecoverOnAcquire will automatically queue a recovery for a failed shard on the first acquire attempt, and will park that acquire while recovery is in progress.
ShardStateAvailable indicates that the shard has been initialized and is active for serving queries.
ShardStateErrored indicates that an unexpected error was encountered during a shard operation, and therefore the shard needs to be recovered.
ShardStateInitializing indicates that the shard is being initialized by being fetched from the mount and being indexed.
ShardStateNew indicates that a shard has just been registered and is about to be processed for activation.
ShardStateRecovering indicates that the shard is recovering from an errored state.
ShardStateServing indicates the shard has active readers and thus is currently actively serving requests.
ShardStateUnknown indicates that it's not possible to determine the state of the shard.
# Variables
ErrShardExists is the error returned upon registering a duplicate shard.
ErrShardInitializationFailed is returned when shard initialization fails.
ErrShardInUse is returned when the user attempts to destroy a shard that is in use.
ErrShardUnknown is the error returned when the requested shard is not known to the DAG store.
StoreNamespace is the namespace under which shard state will be persisted.
# Structs
No description provided by the author
No description provided by the author
DAGStore is the central object of the DAG store.
No description provided by the author
GCResult is the result of performing a GC operation.
PersistedShard is the persistent representation of the Shard.
No description provided by the author
No description provided by the author
Shard encapsulates the state of a shard within the DAG store.
ShardAccessor provides various means to access the data contained in a shard.
No description provided by the author
ShardResult encapsulates a result from an asynchronous operation.
No description provided by the author
# Interfaces
Interface is the publicly exposed interface of the DAGStore.
ReadBlockstore is a read-only view of Blockstores.
# Type aliases
No description provided by the author
No description provided by the author
RecoverOnStartPolicy specifies the recovery policy for failed shards on DAGStore start.
No description provided by the author