gcworker

Documentation

Index

• Constants
• func RunDistributedGCJob(ctx context.Context, regionLockResolver tikv.RegionLockResolver, ...) error
• func RunGCJob(ctx context.Context, regionLockResolver tikv.RegionLockResolver, ...) error
• func RunResolveLocks(ctx context.Context, s tikv.Storage, pd pd.Client, safePoint uint64, ...) error
• type GCWorker
  • func NewGCWorker(store kv.Storage, pdClient pd.Client) (*GCWorker, error)
  • func (w *GCWorker) Close()
  • func (w *GCWorker) GetScope(status string) variable.ScopeFlag
  • func (w *GCWorker) Start()
  • func (w *GCWorker) Stats(vars *variable.SessionVars) (map[string]any, error)
• type MockGCWorker
  • func NewMockGCWorker(store kv.Storage) (*MockGCWorker, error)
  • func (w *MockGCWorker) DeleteRanges(ctx context.Context, safePoint uint64) error

Constants

const (
	// ConcurrencyDivisor reduces the input concurrency to avoid overwhelming the system
	ConcurrencyDivisor = 4
	// RequestsPerThread is the number of requests handled by a single thread
	RequestsPerThread = 100000
)

Functions

func RunDistributedGCJob

func RunDistributedGCJob(ctx context.Context, regionLockResolver tikv.RegionLockResolver, s tikv.Storage, pd pd.Client, safePoint uint64, identifier string, concurrency int) error

RunDistributedGCJob notifies TiKVs to do GC. It is exported for kv api, do not use it with GCWorker at the same time. This function may not finish immediately because it may take some time to do resolveLocks. Param concurrency specifies the concurrency of resolveLocks phase.

func RunGCJob

func RunGCJob(ctx context.Context, regionLockResolver tikv.RegionLockResolver, s tikv.Storage, pd pd.Client, safePoint uint64, identifier string, concurrency int) error

RunGCJob sends GC command to KV. It is exported for kv api, do not use it with GCWorker at the same time. only use for test

func RunResolveLocks

func RunResolveLocks(ctx context.Context, s tikv.Storage, pd pd.Client, safePoint uint64, identifier string, concurrency int) error

RunResolveLocks resolves all locks before the safePoint. It is exported only for test, do not use it in the production environment.

Types

type GCWorker

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

GCWorker periodically triggers GC process on tikv server.

func NewGCWorker

func NewGCWorker(store kv.Storage, pdClient pd.Client) (*GCWorker, error)

NewGCWorker creates a GCWorker instance.

func (*GCWorker) Close

func (w *GCWorker) Close()

Close stops background goroutines.

func (*GCWorker) GetScope

func (w *GCWorker) GetScope(status string) variable.ScopeFlag

GetScope gets the status variables scope.

func (*GCWorker) Start

func (w *GCWorker) Start()

Start starts the worker.

func (*GCWorker) Stats

func (w *GCWorker) Stats(vars *variable.SessionVars) (map[string]any, error)

Stats returns the server statistics.

type MockGCWorker

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

MockGCWorker is for test.

func NewMockGCWorker

func NewMockGCWorker(store kv.Storage) (*MockGCWorker, error)

NewMockGCWorker creates a MockGCWorker instance ONLY for test.

func (*MockGCWorker) DeleteRanges

func (w *MockGCWorker) DeleteRanges(ctx context.Context, safePoint uint64) error

DeleteRanges calls deleteRanges internally, just for test.