reap

Documentation

Overview

Package reap contains the history reaping subsystem for horizon. This system is designed to remove data from the history database such that it does not grow indefinitely. The system can be configured with a number of ledgers to maintain at a minimum.

Index

• type System
  • func New(retention uint, dbSession db.SessionInterface, ledgerState *ledger.State) *System
  • func (r *System) DeleteUnretainedHistory(ctx context.Context) error
  • func (r *System) Run()
  • func (r *System) Shutdown()

Types

type System

type System struct {
	HistoryQ       *history.Q
	RetentionCount uint
	// contains filtered or unexported fields
}

System represents the history reaping subsystem of horizon.

func New

func New(retention uint, dbSession db.SessionInterface, ledgerState *ledger.State) *System

New initializes the reaper, causing it to begin polling the stellar-core database for now ledgers and ingesting data into the horizon database.

func (*System) DeleteUnretainedHistory

func (r *System) DeleteUnretainedHistory(ctx context.Context) error

DeleteUnretainedHistory removes all data associated with unretained ledgers.

func (*System) Run

func (r *System) Run()

Run triggers the reaper system to update itself, deleted unretained history if it is the appropriate time.

func (*System) Shutdown

func (r *System) Shutdown()