pruning

Documentation

Index

• Constants
• Variables
• type Events
• type Manager
  • func NewPruningManager(log *logger.Logger, storage *storagepkg.Storage, ...) *Manager
  • func (p *Manager) HandleNewConfirmedMilestoneEvent(ctx context.Context, confirmedMilestoneIndex iotago.MilestoneIndex)
  • func (p *Manager) IsPruning() bool
  • func (p *Manager) PruneDatabaseByDepth(ctx context.Context, depth iotago.MilestoneIndex) (iotago.MilestoneIndex, error)
  • func (p *Manager) PruneDatabaseBySize(ctx context.Context, targetSizeBytes int64) (iotago.MilestoneIndex, error)
  • func (p *Manager) PruneDatabaseByTargetIndex(ctx context.Context, targetIndex iotago.MilestoneIndex) (iotago.MilestoneIndex, error)
• type Metrics

Constants

const (
	// AdditionalPruningThreshold is the additional threshold (to BMD), which is needed, because the blocks in the getMilestoneParents call in solidEntryPoints
	// can reference older blocks as well.
	AdditionalPruningThreshold = 5
)

Variables

var (
	ErrNotEnoughHistory                                        = errors.New("not enough history")
	ErrNoPruningNeeded                                         = errors.New("no pruning needed")
	ErrPruningAborted                                          = errors.New("pruning was aborted")
	ErrDatabaseCompactionNotSupported                          = errors.New("database compaction not supported")
	ErrDatabaseCompactionRunning                               = errors.New("database compaction is running")
	ErrExistingDeltaSnapshotWrongFullSnapshotTargetMilestoneID = errors.New("existing delta ledger snapshot has wrong full snapshot target milestone ID")
)

Types

type Events

type Events struct {
	PruningMilestoneIndexChanged *event.Event1[iotago.MilestoneIndex]
	PruningMetricsUpdated        *event.Event1[*Metrics]
}

type Manager

type Manager struct {
	// the logger used to log events.
	*logger.WrappedLogger

	Events *Events
	// contains filtered or unexported fields
}

Manager handles pruning of the database.

func NewPruningManager

func NewPruningManager(
	log *logger.Logger,
	storage *storagepkg.Storage,
	syncManager *syncmanager.SyncManager,
	tangleDatabase *database.Database,
	utxoDatabase *database.Database,
	getMinimumTangleHistory getMinimumTangleHistoryFunc,
	pruningMilestonesEnabled bool,
	pruningMilestonesMaxMilestonesToKeep syncmanager.MilestoneIndexDelta,
	pruningSizeEnabled bool,
	pruningSizeTargetSizeBytes int64,
	pruningSizeThresholdPercentage float64,
	pruningSizeCooldownTime time.Duration,
	pruneReceipts bool) *Manager

NewPruningManager creates a new pruning manager instance.

func (*Manager) HandleNewConfirmedMilestoneEvent

func (p *Manager) HandleNewConfirmedMilestoneEvent(ctx context.Context, confirmedMilestoneIndex iotago.MilestoneIndex)

HandleNewConfirmedMilestoneEvent handles new confirmed milestone events which may trigger a snapshot creation.

func (*Manager) IsPruning

func (p *Manager) IsPruning() bool

func (*Manager) PruneDatabaseByDepth

func (p *Manager) PruneDatabaseByDepth(ctx context.Context, depth iotago.MilestoneIndex) (iotago.MilestoneIndex, error)

func (*Manager) PruneDatabaseBySize

func (p *Manager) PruneDatabaseBySize(ctx context.Context, targetSizeBytes int64) (iotago.MilestoneIndex, error)

func (*Manager) PruneDatabaseByTargetIndex

func (p *Manager) PruneDatabaseByTargetIndex(ctx context.Context, targetIndex iotago.MilestoneIndex) (iotago.MilestoneIndex, error)

type Metrics

type Metrics struct {
	DurationPruneUnreferencedBlocks      time.Duration
	DurationTraverseMilestoneCone        time.Duration
	DurationPruneMilestone               time.Duration
	DurationPruneBlocks                  time.Duration
	DurationSetSnapshotInfo              time.Duration
	DurationPruningMilestoneIndexChanged time.Duration
	DurationTotal                        time.Duration
}

Metrics holds metrics about a database pruning run.