package pdpb
Get desktop application:
View/edit binary Protocol Buffers messages
service PD
pdpb.proto:20rpc AdvanceGCSafePoint (, )
pdpb.proto:98message
pdpb.proto:1093optional header = 1
optional keyspace_scope = 2
uint64 target = 3
message
pdpb.proto:1100optional header = 1
uint64 old_gc_safe_point = 2
uint64 new_gc_safe_point = 3
rpc AdvanceTxnSafePoint (, )
pdpb.proto:100message
pdpb.proto:1107optional header = 1
optional keyspace_scope = 2
uint64 target = 3
message
pdpb.proto:1114optional header = 1
uint64 old_txn_safe_point = 2
uint64 new_txn_safe_point = 3
string blocker_description = 4
rpc AllocID (, )
pdpb.proto:35message
pdpb.proto:278optional header = 1
uint32 count = 2
message
pdpb.proto:284optional header = 1
uint64 id = 2
uint32 count = 3
rpc AskBatchSplit (, )
pdpb.proto:72message
pdpb.proto:693optional header = 1
optional region = 2
uint32 split_count = 3
SplitReason reason = 4
message
pdpb.proto:706optional header = 1
repeated ids = 2
rpc AskSplit (, )
pdpb.proto:62message
pdpb.proto:659optional header = 1
optional region = 2
message
pdpb.proto:665optional header = 1
uint64 new_region_id = 2
We split the region into two, first uses the origin parent region id, and the second uses the new_region_id. We must guarantee that the new_region_id is global unique.
repeated uint64 new_peer_ids = 3
The peer ids for the new split region.
rpc BatchScanRegions (, )
pdpb.proto:60rpc Bootstrap (, )
pdpb.proto:31message
pdpb.proto:256optional header = 1
optional store = 2
optional region = 3
message
pdpb.proto:263optional header = 1
optional replication_status = 2
rpc DeleteGCBarrier (, )
pdpb.proto:104message
pdpb.proto:1144optional header = 1
optional keyspace_scope = 2
string barrier_id = 3
message
pdpb.proto:1152optional header = 1
optional deleted_barrier_info = 2
rpc DeleteGlobalGCBarrier (, )
pdpb.proto:108message
pdpb.proto:1170optional header = 1
string barrier_id = 2
message
pdpb.proto:1175optional header = 1
optional deleted_barrier_info = 2
rpc GetAllGCSafePointV2 (, )
pdpb.proto:96message
pdpb.proto:1070optional header = 1
message
pdpb.proto:1079optional header = 1
repeated gc_safe_points = 2
int64 revision = 3
message
pdpb.proto:1208optional header = 1
bool exclude_gc_barriers = 2
bool exclude_global_gc_barriers = 3
message
pdpb.proto:1215optional header = 1
repeated gc_states = 2
repeated global_gc_barriers = 3
rpc GetAllStores (, )
pdpb.proto:43rpc GetClusterConfig (, )
pdpb.proto:76message
pdpb.proto:458optional header = 1
message
pdpb.proto:462optional header = 1
optional cluster = 2
rpc GetClusterInfo (, )
pdpb.proto:23GetClusterInfo get the information of this cluster. It does not require the cluster_id in request matchs the id of this cluster.
message
pdpb.proto:505optional header = 1
message
pdpb.proto:515optional header = 1
repeated ServiceMode serviceModes = 2
repeated string tso_urls = 3
If service mode is API_SVC_MODE, this field will be set to the registered tso service addresses.
rpc GetDCLocationInfo (, )
pdpb.proto:124message
pdpb.proto:1321optional header = 1
string dc_location = 2
message
pdpb.proto:1326optional header = 1
int32 suffix = 2
suffix sign
optional max_ts = 3
max_ts will be included into this response if PD leader think the receiver needs, which it's set when the number of the max suffix bits changes.
rpc GetExternalTimestamp (, )
pdpb.proto:138message
pdpb.proto:1405optional header = 1
message
pdpb.proto:1409optional header = 1
uint64 timestamp = 2
rpc GetGCSafePoint (, )
pdpb.proto:82message
pdpb.proto:967optional header = 1
message
pdpb.proto:971optional header = 1
uint64 safe_point = 2
rpc GetGCSafePointV2 (, )
pdpb.proto:88message
pdpb.proto:1005optional header = 1
uint32 keyspace_id = 2
message
pdpb.proto:1011optional header = 1
uint64 safe_point = 2
rpc GetGCState (, )
pdpb.proto:110message
pdpb.proto:1186optional header = 1
optional keyspace_scope = 2
bool exclude_gc_barriers = 3
message
pdpb.proto:1202optional header = 1
optional gc_state = 2
rpc GetMembers (, )
pdpb.proto:27GetMembers get the member list of this cluster. It does not require the cluster_id in request matchs the id of this cluster.
message
pdpb.proto:492optional header = 1
message
pdpb.proto:496optional header = 1
repeated members = 2
optional leader = 3
optional etcd_leader = 4
map<string, > tso_allocator_leaders = 5
rpc GetMinTS (, )
pdpb.proto:143Get the minimum timestamp across all keyspace groups from API server TODO: Currently, we need to ask API server to get the minimum timestamp. Once we support service discovery, we can remove it.
message
pdpb.proto:1415optional header = 1
message
pdpb.proto:1419optional header = 1
optional timestamp = 2
rpc GetOperator (, )
pdpb.proto:116message
pdpb.proto:1261optional header = 1
uint64 region_id = 2
message
pdpb.proto:1274optional header = 1
uint64 region_id = 2
bytes desc = 3
OperatorStatus status = 4
bytes kind = 5
rpc GetPrevRegion (, )
pdpb.proto:51rpc GetRegion (, )
pdpb.proto:49rpc GetRegionByID (, )
pdpb.proto:53rpc GetStore (, )
pdpb.proto:39rpc IsBootstrapped (, )
pdpb.proto:33message
pdpb.proto:268optional header = 1
message
pdpb.proto:272optional header = 1
bool bootstrapped = 2
rpc IsSnapshotRecovering (, )
pdpb.proto:37message
pdpb.proto:291optional header = 1
message
pdpb.proto:295optional header = 1
bool marked = 2
rpc LoadGlobalConfig (, )
pdpb.proto:128message
pdpb.proto:166repeated string names = 1
string config_path = 2
message
pdpb.proto:171repeated items = 1
int64 revision = 2
rpc PutClusterConfig (, )
pdpb.proto:78message
pdpb.proto:468optional header = 1
optional cluster = 2
message
pdpb.proto:474optional header = 1
rpc PutStore (, )
pdpb.proto:41message
pdpb.proto:313optional header = 1
optional store = 2
message
pdpb.proto:319optional header = 1
optional replication_status = 2
rpc QueryRegion (stream , stream )
pdpb.proto:55rpc RegionHeartbeat (stream , stream )
pdpb.proto:47message
pdpb.proto:529optional header = 1
optional region = 2
optional leader = 3
Leader Peer sending the heartbeat.
repeated down_peers = 4
Leader considers that these peers are down.
repeated pending_peers = 5
Pending peers are the peers that the leader can't consider as working followers.
uint64 bytes_written = 6
Bytes read/written during this period.
uint64 bytes_read = 7
uint64 keys_written = 8
Keys read/written during this period.
uint64 keys_read = 9
uint64 approximate_size = 10
Approximate region size.
optional interval = 12
Actually reported time interval
uint64 approximate_keys = 13
Approximate number of keys.
uint64 term = 14
Term is the term of raft group.
optional replication_status = 15
optional query_stats = 16
QueryStats reported write query stats, and there are read query stats in store heartbeat
uint64 cpu_usage = 17
cpu_usage is the total CPU time usage of the leader region since the last heartbeat, which is calculated by cpu_time_delta/heartbeat_reported_interval. Deprecated: use cpu_stats instead.
optional cpu_stats = 21
cpu_stats reports CPU usage breakdown for the leader region by kind (e.g. unified read).
uint64 approximate_kv_size = 18
Approximate size of row-based key-value pairs for billing. It's counted on size of user key & value (excluding metadata fields), before compression, and latest versions only.
uint64 approximate_columnar_kv_size = 19
Approximate size of column-based key-value pairs for billing. It's counted on size of user key & value (excluding metadata fields), before compression, and latest versions only.
optional bucket_meta = 20
BucketMeta is the bucket version and keys of this region if TiKV enabled the bucket feature
message
pdpb.proto:620optional header = 1
optional change_peer = 2
Notice, Pd only allows handling reported epoch >= current pd's. Leader peer reports region status with RegionHeartbeatRequest to pd regularly, pd will determine whether this region should do ChangePeer or not. E,g, max peer number is 3, region A, first only peer 1 in A. 1. Pd region state -> Peers (1), ConfVer (1). 2. Leader peer 1 reports region state to pd, pd finds the peer number is < 3, so first changes its current region state -> Peers (1, 2), ConfVer (1), and returns ChangePeer Adding 2. 3. Leader does ChangePeer, then reports Peers (1, 2), ConfVer (2), pd updates its state -> Peers (1, 2), ConfVer (2). 4. Leader may report old Peers (1), ConfVer (1) to pd before ConfChange finished, pd stills responses ChangePeer Adding 2, of course, we must guarantee the second ChangePeer can't be applied in TiKV.
optional transfer_leader = 3
Pd can return transfer_leader to let TiKV does leader transfer itself.
uint64 region_id = 4
ID of the region
optional region_epoch = 5
optional target_peer = 6
Leader of the region at the moment of the corresponding request was made.
optional merge = 7
optional split_region = 8
PD sends split_region to let TiKV split a region into two regions.
optional change_peer_v2 = 9
Multiple change peer operations atomically. Note: PD can use both ChangePeer and ChangePeerV2 at the same time (not in the same RegionHeartbeatResponse). Now, PD use ChangePeerV2 in following scenarios: 1. replacing peers 2. demoting voter directly
optional switch_witnesses = 10
optional change_split = 11
rpc ReportBatchSplit (, )
pdpb.proto:74message
pdpb.proto:712optional header = 1
repeated regions = 2
message
pdpb.proto:718optional header = 1
rpc ReportBuckets (stream , )
pdpb.proto:132message
pdpb.proto:1372optional header = 1
optional region_epoch = 2
optional buckets = 3
message
pdpb.proto:1379optional header = 1
rpc ReportMinResolvedTS (, )
pdpb.proto:134message
pdpb.proto:1383optional header = 1
uint64 store_id = 2
uint64 min_resolved_ts = 3
message
pdpb.proto:1391optional header = 1
rpc ReportSplit (, )
pdpb.proto:67message
pdpb.proto:676optional header = 1
optional left = 2
optional right = 3
message
pdpb.proto:683optional header = 1
rpc ScanRegions (, )
pdpb.proto:58Deprecated: use BatchScanRegions instead.
message
pdpb.proto:402Use GetRegionResponse as the response of GetRegionByIDRequest. Deprecated: use BatchScanRegionsRequest instead.
optional header = 1
bytes start_key = 2
int32 limit = 3
no limit when limit <= 0.
bytes end_key = 4
end_key is +inf when it is empty.
message
pdpb.proto:422optional header = 1
repeated region_metas = 2
Keep for backword compatibability.
repeated leaders = 3
repeated regions = 4
Extended region info with down/pending peers.
rpc ScatterRegion (, )
pdpb.proto:80message
pdpb.proto:941optional header = 1
uint64 region_id = 2
optional region = 3
PD will use these region information if it can't find the region. For example, the region is just split and hasn't report to PD yet.
optional leader = 4
string group = 5
If group is defined, the regions with the same group would be scattered as a whole group. If not defined, the regions would be scattered in a cluster level.
repeated uint64 regions_id = 6
If regions_id is defined, the region_id would be ignored.
uint64 retry_limit = 7
bool skip_store_limit = 8
message
pdpb.proto:961optional header = 1
uint64 finished_percentage = 2
repeated uint64 failed_regions_id = 3
rpc SetExternalTimestamp (, )
pdpb.proto:136message
pdpb.proto:1395optional header = 1
uint64 timestamp = 2
message
pdpb.proto:1401optional header = 1
rpc SetGCBarrier (, )
pdpb.proto:102message
pdpb.proto:1122optional header = 1
optional keyspace_scope = 2
string barrier_id = 3
uint64 barrier_ts = 4
int64 ttl_seconds = 5
message
pdpb.proto:1138optional header = 1
optional new_barrier_info = 2
rpc SetGlobalGCBarrier (, )
pdpb.proto:106message
pdpb.proto:1158optional header = 1
string barrier_id = 2
uint64 barrier_ts = 3
int64 ttl_seconds = 4
message
pdpb.proto:1165optional header = 1
optional new_barrier_info = 2
rpc SplitAndScatterRegions (, )
pdpb.proto:122message
pdpb.proto:1307optional header = 1
repeated bytes split_keys = 2
string group = 3
uint64 retry_limit = 4
message
pdpb.proto:1314optional header = 1
uint64 split_finished_percentage = 2
uint64 scatter_finished_percentage = 3
repeated uint64 regions_id = 4
rpc SplitRegions (, )
pdpb.proto:120message
pdpb.proto:1295optional header = 1
repeated bytes split_keys = 2
uint64 retry_limit = 3
message
pdpb.proto:1301optional header = 1
uint64 finished_percentage = 2
repeated uint64 regions_id = 3
rpc StoreGlobalConfig (, )
pdpb.proto:126message
pdpb.proto:157repeated changes = 1
string config_path = 2
message
pdpb.proto:162optional error = 1
rpc StoreHeartbeat (, )
pdpb.proto:45message
pdpb.proto:868optional header = 1
optional stats = 2
optional store_report = 3
Detailed store report that is only filled up on PD's demand for online unsafe recovery.
optional dr_autosync_status = 4
message
pdpb.proto:921optional header = 1
optional replication_status = 2
string cluster_version = 3
bool require_detailed_report = 4
Used by online unsafe recovery to request store report. Now it's substituted by reusing recovery_plan field. PD will send a empty recovery plan instead to request store report.
optional recovery_plan = 5
Operations of recovery. After the plan is executed, TiKV should attach the store report in store heartbeat.
optional awaken_regions = 6
Pd can return awaken_regions to let TiKV awaken hibernated regions itself.
optional control_grpc = 7
Pd can return operations to let TiKV forcely PAUSE | RESUME grpc server.
metapb.NodeState state = 8
NodeState is going to mark the state of the store.
rpc SyncMaxTS (, )
pdpb.proto:118message
pdpb.proto:1282optional header = 1
optional max_ts = 2
bool skip_check = 3
If skip_check is true, the sync will try to write the max_ts without checking whether it's bigger.
message
pdpb.proto:1289optional header = 1
optional max_local_ts = 2
repeated string synced_dcs = 3
rpc SyncRegions (stream , stream )
pdpb.proto:114message
pdpb.proto:1231optional header = 1
optional member = 2
uint64 start_index = 3
the follower PD will use the start index to locate historical changes that require synchronization.
message
pdpb.proto:1247optional header = 1
repeated regions = 2
the leader PD will send the repsonds include changed regions records and the index of the first record.
uint64 start_index = 3
repeated region_stats = 4
repeated region_leaders = 5
repeated buckets = 6
the buckets informations without stats.
repeated down_peers = 16
repeated pending_peers = 17
rpc Tso (stream , stream )
pdpb.proto:29message
pdpb.proto:234optional header = 1
uint32 count = 2
string dc_location = 3
message
pdpb.proto:249optional header = 1
uint32 count = 2
optional timestamp = 3
rpc UpdateGCSafePoint (, )
pdpb.proto:84message
pdpb.proto:977optional header = 1
uint64 safe_point = 2
message
pdpb.proto:983optional header = 1
uint64 new_safe_point = 2
rpc UpdateGCSafePointV2 (, )
pdpb.proto:92message
pdpb.proto:1035optional header = 1
uint32 keyspace_id = 2
uint64 safe_point = 3
message
pdpb.proto:1042optional header = 1
uint64 new_safe_point = 2
message
pdpb.proto:989optional header = 1
bytes service_id = 2
int64 TTL = 3
uint64 safe_point = 4
message
pdpb.proto:997optional header = 1
bytes service_id = 2
int64 TTL = 3
uint64 min_safe_point = 4
message
pdpb.proto:1048optional header = 1
uint32 keyspace_id = 2
bytes service_id = 3
uint64 safe_point = 4
int64 ttl = 5
Safe point will be set to expire on (PD Server time + TTL), pass in a ttl < 0 to remove target safe point; pass in MAX_INT64 to set a safe point that never expire. This should be set by component that may crash unexpectedly so that it doesn't block cluster garbage collection.
message
pdpb.proto:1062optional header = 1
bytes service_id = 2
int64 ttl = 3
uint64 min_safe_point = 4
rpc WatchGCSafePointV2 (, stream )
pdpb.proto:90message
pdpb.proto:1017optional header = 1
int64 revision = 2
message
pdpb.proto:1029optional header = 1
repeated events = 2
int64 revision = 3
rpc WatchGlobalConfig (, stream )
pdpb.proto:130message
pdpb.proto:146string config_path = 1
int64 revision = 2
message
pdpb.proto:151repeated changes = 1
int64 revision = 2
optional header = 3
message
pdpb.proto:905Used in:
repeated uint64 abnormal_stores = 1
Awake all regions if abnormal_stores is empty.
message
pdpb.proto:438Used as request type in: PD.BatchScanRegions, routerpb.Router.BatchScanRegions
optional header = 1
bool need_buckets = 2
repeated ranges = 3
the given ranges must be in order.
int32 limit = 4
limit the total number of regions to scan.
bool contain_all_key_range = 5
If contain_all_key_range is true, the output must contain all key ranges in the request. If the output does not contain all key ranges, the request is considered failed and returns an error(REGIONS_NOT_CONTAIN_ALL_KEY_RANGE).
message
pdpb.proto:451Used as response type in: PD.BatchScanRegions, routerpb.Router.BatchScanRegions
optional header = 1
repeated regions = 2
the returned regions are flattened into a list, because the given ranges can located in the same range, we do not return duplicated regions then.
message
pdpb.proto:605Used in: ,
repeated switch_witnesses = 1
message
pdpb.proto:1350CPU usage breakdown by kind. New kinds may be added in the future.
Used in: ,
uint64 UnifiedRead = 1
UnifiedRead is the CPU usage of the unified read pool.
uint64 Scheduler = 2
Scheduler is the CPU usage of the scheduler pool, it contains `sched-pool`, `sched-high`, and `sched-pri`.
message
pdpb.proto:576Used in: , ,
optional peer = 1
eraftpb.ConfChangeType change_type = 2
message
pdpb.proto:581Used in: ,
repeated changes = 1
If changes is empty, it means that to exit joint state.
message
pdpb.proto:615Used in: ,
bool auto_split_enabled = 1
auto_split_enabled configures whether the corresponding Region is allowed to be auto split by size or load.
Used in:
SCAN = 0
APPROXIMATE = 1
USEKEY = 2
message
pdpb.proto:917Used in:
ControlGrpcEvent ctrl_event = 1
Used in:
PAUSE = 0
Pause TiKV grpc server.
RESUME = 1
Resume TiKV grpc server.
message
pdpb.proto:877Used in:
uint64 region_id = 1
repeated failed_voters = 2
message
pdpb.proto:824Used in:
optional scope = 1
uint64 written_bytes = 2
Number of bytes written to DFS.
uint64 write_requests = 3
Number of write requests sent to DFS.
message
pdpb.proto:815Used in:
bool is_global = 1
When true, the statistic is not tied to any keyspace.
uint32 keyspace_id = 2
The keyspace of this statistic. Ignore when is_global is true.
string component = 3
The component that provides the statistic.
message
pdpb.proto:229Used in: , ,
ErrorType type = 1
string message = 2
Used in:
OK = 0
UNKNOWN = 1
NOT_BOOTSTRAPPED = 2
STORE_TOMBSTONE = 3
ALREADY_BOOTSTRAPPED = 4
INCOMPATIBLE_VERSION = 5
REGION_NOT_FOUND = 6
GLOBAL_CONFIG_NOT_FOUND = 7
DUPLICATED_ENTRY = 8
ENTRY_NOT_FOUND = 9
INVALID_VALUE = 10
DATA_COMPACTED = 11
required watch revision is smaller than current compact/min revision.
REGIONS_NOT_CONTAIN_ALL_KEY_RANGE = 12
Used in: ,
PUT = 0
DELETE = 1
message
pdpb.proto:882Used in:
repeated uint64 failed_stores = 1
The store ids of the failed stores, TiKV uses it to decide if a peer is alive.
repeated uint64 enter_force_leaders = 2
The region ids of the peer which is to be force leader.
message
pdpb.proto:1132Used in: , ,
string barrier_id = 1
uint64 barrier_ts = 2
int64 ttl_seconds = 3
message
pdpb.proto:1074Used in:
uint32 keyspace_id = 1
uint64 gc_safe_point = 2
message
pdpb.proto:1193Used in: ,
optional keyspace_scope = 1
bool is_keyspace_level_gc = 2
uint64 txn_safe_point = 3
uint64 gc_safe_point = 4
repeated gc_barriers = 5
message
pdpb.proto:324Used as request type in: PD.GetAllStores, routerpb.Router.GetAllStores
optional header = 1
bool exclude_tombstone_stores = 2
Do NOT return tombstone stores if set to true.
message
pdpb.proto:330Used as response type in: PD.GetAllStores, routerpb.Router.GetAllStores
optional header = 1
repeated stores = 2
message
pdpb.proto:359Used as request type in: PD.GetRegionByID, routerpb.Router.GetRegionByID
optional header = 1
uint64 region_id = 2
bool need_buckets = 3
message
pdpb.proto:336Used as request type in: PD.GetPrevRegion, PD.GetRegion, routerpb.Router.GetPrevRegion, routerpb.Router.GetRegion
optional header = 1
bytes region_key = 2
bool need_buckets = 3
message
pdpb.proto:343Used as response type in: PD.GetPrevRegion, PD.GetRegion, PD.GetRegionByID, routerpb.Router.GetPrevRegion, routerpb.Router.GetRegion, routerpb.Router.GetRegionByID
optional header = 1
optional region = 2
optional leader = 3
repeated down_peers = 5
Leader considers that these peers are down.
repeated pending_peers = 6
Pending peers are the peers that the leader can't consider as working followers.
optional buckets = 7
buckets isn't nil if GetRegion.* requests set need_buckets.
message
pdpb.proto:300Used as request type in: PD.GetStore, routerpb.Router.GetStore
optional header = 1
uint64 store_id = 2
message
pdpb.proto:306Used as response type in: PD.GetStore, routerpb.Router.GetStore
optional header = 1
optional store = 2
optional stats = 3
message
pdpb.proto:181Used in: , ,
string name = 1
string value = 2
this field 'value' is replaced by the field 'payload'.
optional error = 3
EventType kind = 4
bytes payload = 5
Since item value needs to support marshal of different struct types, it should be set to bytes instead of string.
message
pdpb.proto:1180Used in: , ,
string barrier_id = 1
uint64 barrier_ts = 2
int64 ttl_seconds = 3
message
pdpb.proto:433Used in:
bytes start_key = 1
bytes end_key = 2
end_key is +inf when it is empty.
message
pdpb.proto:1089A wrapper over keyspace_id. When a field is not specified in proto3, its value will be regarded as 0; however, keyspace_id = 0 is regarded as a valid keyspace (which is the "DEFAULT" keyspace). To distinguish unspecified keyspace (NullKeyspace, 0xffffffff) and the default keyspace in some APIs as well as preventing potential misuse, we wrap the keyspace_id into a message type which is nullable.
Used in: , , , , ,
uint32 keyspace_id = 1
message
pdpb.proto:478Used in: ,
string name = 1
name is the name of the PD member.
uint64 member_id = 2
member_id is the unique id of the PD member.
repeated string peer_urls = 3
repeated string client_urls = 4
int32 leader_priority = 5
string deploy_path = 6
string binary_version = 7
string git_hash = 8
string dc_location = 9
message
pdpb.proto:591Used in: ,
optional target = 1
Used in: ,
SUCCESS = 0
TIMEOUT = 1
CANCEL = 2
REPLACE = 3
RUNNING = 4
message
pdpb.proto:853Used in:
optional raft_state = 1
optional region_state = 2
bool is_force_leader = 3
bool has_commit_merge = 4
The peer has proposed but uncommitted commit merge.
uint64 applied_index = 5
raft applied index
message
pdpb.proto:734Used in:
uint64 region_id = 1
uint64 read_keys = 2
uint64 read_bytes = 3
optional query_stats = 4
uint64 written_keys = 5
uint64 written_bytes = 6
optional cpu_stats = 7
cpu_stats is the CPU usage of the region's unified read pool since the last heartbeat, which is calculated by cpu_time_delta/heartbeat_reported_interval.
message
pdpb.proto:524Used in: , , , , ,
optional peer = 1
uint64 down_seconds = 2
message
pdpb.proto:1243Used in:
repeated peers = 1
message
pdpb.proto:1239Used in:
repeated peers = 1
Others = 0
GC = 1
Get = 2
Scan = 3
Coprocessor = 4
Delete = 5
DeleteRange = 6
Put = 7
Prewrite = 8
AcquirePessimisticLock = 9
Commit = 10
Rollback = 11
message
pdpb.proto:366Used as request type in: PD.QueryRegion, routerpb.Router.QueryRegion
optional header = 1
bool need_buckets = 2
Whether to include the buckets info within the response.
repeated uint64 ids = 3
The region IDs to query.
repeated bytes keys = 4
The region keys to query.
repeated bytes prev_keys = 5
The previous region keys to query.
message
pdpb.proto:379Used as response type in: PD.QueryRegion, routerpb.Router.QueryRegion
optional header = 1
repeated uint64 key_id_map = 2
This array functions as a map corresponding to the region IDs, preserving the order of the input region keys, if they are present.
repeated uint64 prev_key_id_map = 3
This array functions as a map corresponding to the previous region IDs, preserving the order of the input previous region keys, if they are present.
map<uint64, > regions_by_id = 4
RegionID -> RegionResponse
message
pdpb.proto:1335Used in: , , ,
uint64 GC = 1
uint64 Get = 2
uint64 Scan = 3
uint64 Coprocessor = 4
uint64 Delete = 5
uint64 DeleteRange = 6
uint64 Put = 7
uint64 Prewrite = 8
uint64 AcquirePessimisticLock = 9
uint64 Commit = 10
uint64 Rollback = 11
message
pdpb.proto:729Used in:
string key = 1
uint64 value = 2
message
pdpb.proto:889Used in:
repeated creates = 1
Create empty regions to fill the key range hole.
repeated updates = 2
Update the meta of the regions, including peer lists, epoch and key range.
repeated uint64 tombstones = 3
Tombstone the peers on the store locally.
repeated demotes = 4
Issue conf change that demote voters on failed stores to learners on the regions.
optional force_leader = 5
Make the peers to be force leaders.
uint64 step = 6
Step is an increasing number to note the round of recovery, It should be filled in the corresponding store report.
message
pdpb.proto:410Used in: ,
optional region = 1
optional leader = 2
repeated down_peers = 3
Leader considers that these peers are down.
repeated pending_peers = 4
Pending peers are the peers that the leader can't consider as working followers.
optional buckets = 5
buckets isn't nil only when need_buckets is true.
message
pdpb.proto:392Used in:
optional region = 1
optional leader = 2
repeated down_peers = 3
repeated pending_peers = 4
optional buckets = 5
message
pdpb.proto:1222Used in:
uint64 bytes_written = 1
Bytes read/written during this period.
uint64 bytes_read = 2
uint64 keys_written = 3
Keys read/written during this period.
uint64 keys_read = 4
message
pdpb.proto:192Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
uint64 cluster_id = 1
cluster_id is the ID of the cluster which be sent to.
uint64 sender_id = 2
sender_id is the ID of the sender server, also member ID or etcd ID. sender_id is used in PD internal communication.
string caller_id = 3
caller_id is the ID of the client which sends the request, such as tikv, tidb, cdc, etc.
string caller_component = 4
caller_component is the component of the client which sends the request, such as ddl, optimizer, etc.
message
pdpb.proto:206Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
uint64 cluster_id = 1
cluster_id is the ID of the cluster which sent the response.
optional error = 2
message
pdpb.proto:1023SafePointEvent is for the rpc WatchGCSafePointV2.
Used in:
uint32 keyspace_id = 1
uint64 safe_point = 2
EventType type = 3
Used in:
UNKNOWN_SVC_MODE = 0
PD_SVC_MODE = 1
API_SVC_MODE = 2
message
pdpb.proto:832Used in:
double cause_value = 1
double cause_rate = 2
double result_value = 3
double result_rate = 4
message
pdpb.proto:839Used in:
uint64 region_id = 1
uint64 generate_duration_sec = 2
Generate snapshot duration
uint64 send_duration_sec = 3
Send snapshot duration
uint64 total_duration_sec = 4
|-- waiting --|-- generate --｜-- send --| |-----------total duration---------------| Total duration include waiting and executing duration
uint64 transport_size = 5
Size is the transport data size
message
pdpb.proto:701Used in: ,
uint64 new_region_id = 1
repeated uint64 new_peer_ids = 2
Used in: ,
ADMIN = 0
SIZE = 1
LOAD = 2
message
pdpb.proto:595Used in: ,
CheckPolicy policy = 1
repeated bytes keys = 2
message
pdpb.proto:863Used in:
repeated peer_reports = 1
uint64 step = 2
message
pdpb.proto:746Used in: , ,
uint64 store_id = 1
uint64 capacity = 2
Capacity for the store.
uint64 available = 3
Available size for the store.
uint32 region_count = 4
Total region count in this store.
uint32 sending_snap_count = 5
Current sending snapshot count.
uint32 receiving_snap_count = 6
Current receiving snapshot count.
uint32 start_time = 7
When the store is started (unix timestamp in seconds).
uint32 applying_snap_count = 8
How many region is applying snapshot.
bool is_busy = 9
If the store is busy
uint64 used_size = 10
Actually used space by db
uint64 bytes_written = 11
Bytes written for the store during this period.
uint64 keys_written = 12
Keys written for the store during this period.
uint64 bytes_read = 13
Bytes read for the store during this period.
uint64 keys_read = 14
Keys read for the store during this period.
optional interval = 15
Actually reported time interval
repeated cpu_usages = 16
Threads' CPU usages in the store
repeated read_io_rates = 17
Threads' read disk I/O rates in the store
repeated write_io_rates = 18
Threads' write disk I/O rates in the store
repeated op_latencies = 19
Operations' latencies in the store
repeated peer_stats = 20
Hot peer stat in the store
optional query_stats = 21
Store query stats
uint64 slow_score = 22
Score that represents the speed of the store, ranges in [1, 100], lower is better.
repeated uint64 damaged_regions_id = 23
Damaged regions on the store that need to be removed by PD.
bool is_apply_busy = 24
If the apply worker is busy, namely high apply wait duration
repeated snapshot_stats = 25
Snapshot stats in the store
optional slow_trend = 26
bool is_grpc_paused = 27
If the grpc server is paused.
uint64 total_memory = 28
Total memory of the store in bytes.
uint64 used_memory = 29
Used memory of the store in bytes.
map<uint64, uint64> network_slow_scores = 30
Network_slow_scores indicate the network status between TiKV nodes, ranging from 1 to 100 (lower is better). StoreID -> score
repeated dfs = 31
The statistics about DFS uploads.
bool is_stopping = 32
True if the store is undergoing graceful shutdown.
message
pdpb.proto:600Used in:
uint64 peer_id = 1
bool is_witness = 2
message
pdpb.proto:722Used in: , ,
uint64 start_timestamp = 1
The unix timestamp in seconds of the start of this period.
uint64 end_timestamp = 2
The unix timestamp in seconds of the end of this period.
message
pdpb.proto:241Used in: , , , , , ,
int64 physical = 1
int64 logical = 2
uint32 suffix_bits = 3
Number of suffix bits used for global distinction, PD client will use this to compute a TSO's logical part.
message
pdpb.proto:586Used in: ,
optional peer = 1
repeated peers = 2