distro

Documentation

Overview

Package distro provides a type-safe distribution resource framework. Distribution resource determines how component names are displayed in errors, logs and so on. For example, a distribution resource can define "TiDB" to be displayed as "MyTiDB".

Index

• func ReplaceGlobal(r DistributionResource) func()
• type DistributionResource
  • func R() *DistributionResource

Functions

func ReplaceGlobal

func ReplaceGlobal(r DistributionResource) func()

ReplaceGlobal replaces the global distribution resource with the specified one. Missing fields in the resource will be filled using default values.

Types

type DistributionResource

type DistributionResource struct {
	TiDB    string `json:"tidb,omitempty"`
	TiKV    string `json:"tikv,omitempty"`
	PD      string `json:"pd,omitempty"`
	TiFlash string `json:"tiflash,omitempty"`
}

func R

func R() *DistributionResource

R gets the current global distribution resource. The returned value must NOT be modified.