truncator

Documentation

Index

• Variables
• type Truncator
  • func NewTruncator(db database.DB, retentionPeriod time.Duration, ...) *Truncator
  • func (t *Truncator) Start() error
  • func (t *Truncator) Stop() error
  • func (t *Truncator) Truncate(ctx context.Context, retentionPeriod time.Duration) error

Variables

var (
	ErrTruncatorAlreadyRunning = errors.New("truncator already running")
	ErrTruncatorAlreadyStopped = errors.New("truncator already stopped")
)

Types

type Truncator

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

func NewTruncator

func NewTruncator(
	db database.DB,
	retentionPeriod time.Duration,
	truncationFrequency time.Duration,
	logger logger.Logger) *Truncator

func (*Truncator) Start

func (t *Truncator) Start() error

runTruncator triggers periodically to truncate multiple appendable logs

func (*Truncator) Stop

func (t *Truncator) Stop() error

func (*Truncator) Truncate

func (t *Truncator) Truncate(ctx context.Context, retentionPeriod time.Duration) error

Truncate discards all data from the database that is older than the retention period. Truncation discards an appendable log upto a given offset before time ts. First, the transaction is fetched which lies before the specified time period, and then the values are discarded upto the specified offset.

  discard point
		|
		|
		v

--------+-------+--------+----------

	|       |        |
tn-1:vx  tn:vx   tn+1:vx