retire

Documentation

Overview

Package retire contains a utility for removing old mutations.

Index

• Variables
• type Retire
  • func ProvideRetire(cfg *sequencer.Config, pool *types.StagingPool, stagers types.Stagers) *Retire
  • func (r *Retire) Start(ctx *stopper.Context, group *types.TableGroup, bounds *notify.Var[hlc.Range]) *notify.Var[hlc.Time]

Variables

var Set = wire.NewSet(ProvideRetire)

Set is used by Wire.

Types

type Retire

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

Retire implements a utility process for removing old mutations.

func ProvideRetire

func ProvideRetire(cfg *sequencer.Config, pool *types.StagingPool, stagers types.Stagers) *Retire

ProvideRetire is called by Wire.

func (*Retire) Start

func (r *Retire) Start(
	ctx *stopper.Context, group *types.TableGroup, bounds *notify.Var[hlc.Range],
) *notify.Var[hlc.Time]

Start a goroutine to ensure that old mutations are eventually discarded. Any staged mutations whose timestamp is less than the minimum value will be purged. This method will return a notification variable that emits the time before which all applied, staged mutations will have been purged.