package
0.43.0
Repository: https://github.com/nspcc-dev/neofs-node.git
Documentation: pkg.go.dev

# Functions

IsErrRemoved checks if error returned by Shard Exists/Get/Put method corresponds to removed object.
New creates and returns new Metabase instance.
WithBoltDBOptions returns option to specify BoltDB options.
WithEpochState return option to specify a source of current epoch height.
WithLogger returns option to set logger of DB.
WithMaxBatchDelay returns option to specify maximum time to wait before the batch of concurrent transactions is processed.
WithMaxBatchSize returns option to specify maximum concurrent operations to be processed in a single transactions.
WithPath returns option to set system path to Metabase.
WithPermissions returns option to specify permission bits of Metabase system path.

# Variables

ErrDegradedMode is returned when metabase is in a degraded mode.
ErrEndOfListing is returned from object listing with cursor when storage can't return any more objects after provided cursor.
No description provided by the author
No description provided by the author
ErrInterruptIterator is returned by iteration handlers as a "break" keyword.
No description provided by the author
ErrLockObjectRemoval is returned when inhume operation is being performed on lock object, and it is not a forced object removal.
ErrObjectIsExpired is returned when the requested object's epoch is less than the current one.
ErrOutdatedVersion is returned on initializing an existing metabase that is not compatible with the current code version.
ErrReadOnlyMode is returned when metabase is in a read-only mode.
No description provided by the author

# Structs

BucketValue pairs a bucket index and a value that relates an object.
Cursor is a type for continuous object listing.
DB represents local metabase of storage node.
DeletePrm groups the parameters of Delete operation.
DeleteRes groups the resulting values of Delete operation.
DoNotMovePrm groups the parameters of DoNotMove operation.
DoNotMoveRes groups the resulting values of DoNotMove operation.
ExistsPrm groups the parameters of Exists operation.
ExistsRes groups the resulting values of Exists operation.
ExpiredObject is a descriptor of expired object from DB.
GarbageIterationPrm groups parameters of the garbage iteration process.
GarbageObject represents descriptor of the object that has been marked with GC.
GetPrm groups the parameters of Get operation.
GetRes groups the resulting values of Get operation.
GraveyardIterationPrm groups parameters of the graveyard iteration process.
Info groups the information about DB.
InhumePrm encapsulates parameters for Inhume operation.
InhumeRes encapsulates results of Inhume operation.
IsLockedPrm groups the parameters of IsLocked operation.
IsLockedRes groups the resulting values of IsLocked operation.
ListPrm contains parameters for ListWithCursor operation.
ListRes contains values returned from ListWithCursor operation.
MovablePrm groups the parameters of Movable operation.
MovableRes groups the resulting values of Movable operation.
ObjectCounters groups object counter according to metabase state.
ObjectStatus represents the status of the object in the Metabase.
PutPrm groups the parameters of Put operation.
PutRes groups the resulting values of Put operation.
SelectPrm groups the parameters of Select operation.
SelectRes groups the resulting values of Select operation.
StorageIDPrm groups the parameters of StorageID operation.
StorageIDRes groups the resulting values of StorageID operation.
TombstonedObject represents descriptor of the object that has been covered with tombstone.
ToMoveItPrm groups the parameters of ToMoveIt operation.
ToMoveItRes groups the resulting values of ToMoveIt operation.
UpdateStorageIDPrm groups the parameters of UpdateStorageID operation.
UpdateStorageIDRes groups the resulting values of UpdateStorageID operation.

# Interfaces

EpochState is an interface that provides access to the current epoch number.

# Type aliases

ExpiredObjectHandler is an ExpiredObject handling function.
GarbageHandler is a GarbageObject handling function.
Option is an option of DB constructor.
TombstonedHandler is a TombstonedObject handling function.