PDScheduleConfig

(Appears on: PDConfig)

ScheduleConfig is the schedule configuration.

FieldDescription
max-snapshot-count
uint64
(Optional)

If the snapshot count of one store is greater than this value, it will never be used as a source or target store. Immutable, change should be made through pd-ctl after cluster creation Optional: Defaults to 3

max-pending-peer-count
uint64
(Optional)

Immutable, change should be made through pd-ctl after cluster creation Optional: Defaults to 16

max-merge-region-size
uint64
(Optional)

If both the size of region is smaller than MaxMergeRegionSize and the number of rows in region is smaller than MaxMergeRegionKeys, it will try to merge with adjacent regions. Immutable, change should be made through pd-ctl after cluster creation Optional: Defaults to 20

max-merge-region-keys
uint64
(Optional)

Immutable, change should be made through pd-ctl after cluster creation Optional: Defaults to 200000

split-merge-interval
string
(Optional)

SplitMergeInterval is the minimum interval time to permit merge after split. Immutable, change should be made through pd-ctl after cluster creation Optional: Defaults to 1h

patrol-region-interval
string
(Optional)

PatrolRegionInterval is the interval for scanning region during patrol. Immutable, change should be made through pd-ctl after cluster creation

max-store-down-time
string
(Optional)

MaxStoreDownTime is the max duration after which a store will be considered to be down if it hasn’t reported heartbeats. Immutable, change should be made through pd-ctl after cluster creation Optional: Defaults to 30m

leader-schedule-limit
uint64
(Optional)

LeaderScheduleLimit is the max coexist leader schedules. Immutable, change should be made through pd-ctl after cluster creation. Optional: Defaults to 4. Imported from v3.1.0

region-schedule-limit
uint64
(Optional)

RegionScheduleLimit is the max coexist region schedules. Immutable, change should be made through pd-ctl after cluster creation Optional: Defaults to 2048

replica-schedule-limit
uint64
(Optional)

ReplicaScheduleLimit is the max coexist replica schedules. Immutable, change should be made through pd-ctl after cluster creation Optional: Defaults to 64

merge-schedule-limit
uint64
(Optional)

MergeScheduleLimit is the max coexist merge schedules. Immutable, change should be made through pd-ctl after cluster creation Optional: Defaults to 8

hot-region-schedule-limit
uint64
(Optional)

HotRegionScheduleLimit is the max coexist hot region schedules. Immutable, change should be made through pd-ctl after cluster creation Optional: Defaults to 4

hot-region-cache-hits-threshold
uint64
(Optional)

HotRegionCacheHitThreshold is the cache hits threshold of the hot region. If the number of times a region hits the hot cache is greater than this threshold, it is considered a hot region. Immutable, change should be made through pd-ctl after cluster creation

tolerant-size-ratio
float64
(Optional)

TolerantSizeRatio is the ratio of buffer size for balance scheduler. Immutable, change should be made through pd-ctl after cluster creation. Imported from v3.1.0

low-space-ratio
float64
(Optional)
  1. high space stage transition stage low space stage

|——————–|—————————–|————————-| ^ ^ ^ ^ 0 HighSpaceRatio capacity LowSpaceRatio capacity capacity

LowSpaceRatio is the lowest usage ratio of store which regraded as low space. When in low space, store region score increases to very large and varies inversely with available size. Immutable, change should be made through pd-ctl after cluster creation

high-space-ratio
float64
(Optional)

HighSpaceRatio is the highest usage ratio of store which regraded as high space. High space means there is a lot of spare capacity, and store region score varies directly with used size. Immutable, change should be made through pd-ctl after cluster creation

disable-raft-learner,string
bool
(Optional)

DisableLearner is the option to disable using AddLearnerNode instead of AddNode Immutable, change should be made through pd-ctl after cluster creation

disable-remove-down-replica,string
bool
(Optional)

DisableRemoveDownReplica is the option to prevent replica checker from removing down replicas. Immutable, change should be made through pd-ctl after cluster creation

disable-replace-offline-replica,string
bool
(Optional)

DisableReplaceOfflineReplica is the option to prevent replica checker from repalcing offline replicas. Immutable, change should be made through pd-ctl after cluster creation

disable-make-up-replica,string
bool
(Optional)

DisableMakeUpReplica is the option to prevent replica checker from making up replicas when replica count is less than expected. Immutable, change should be made through pd-ctl after cluster creation

disable-remove-extra-replica,string
bool
(Optional)

DisableRemoveExtraReplica is the option to prevent replica checker from removing extra replicas. Immutable, change should be made through pd-ctl after cluster creation

disable-location-replacement,string
bool
(Optional)

DisableLocationReplacement is the option to prevent replica checker from moving replica to a better location. Immutable, change should be made through pd-ctl after cluster creation

disable-namespace-relocation,string
bool
(Optional)

DisableNamespaceRelocation is the option to prevent namespace checker from moving replica to the target namespace. Immutable, change should be made through pd-ctl after cluster creation

schedulers-v2
PDSchedulerConfigs
(Optional)

Schedulers support for loding customized schedulers Immutable, change should be made through pd-ctl after cluster creation

schedulers-payload
map[string]string
(Optional)

Only used to display

enable-one-way-merge,string
bool
(Optional)

EnableOneWayMerge is the option to enable one way merge. This means a Region can only be merged into the next region of it. Imported from v3.1.0

enable-cross-table-merge,string
bool
(Optional)

EnableCrossTableMerge is the option to enable cross table merge. This means two Regions can be merged with different table IDs. This option only works when key type is “table”. Imported from v3.1.0