package pdpb
Get desktop application:
View/edit binary Protocol Buffers messages
service PD
pdpb.proto:21rpc AdvanceGCSafePoint (, )
pdpb.proto:99message
pdpb.proto:1135optional header = 1
optional keyspace_scope = 2
uint64 target = 3
message
pdpb.proto:1142optional header = 1
uint64 old_gc_safe_point = 2
uint64 new_gc_safe_point = 3
rpc AdvanceTxnSafePoint (, )
pdpb.proto:101message
pdpb.proto:1149optional header = 1
optional keyspace_scope = 2
uint64 target = 3
message
pdpb.proto:1156optional header = 1
uint64 old_txn_safe_point = 2
uint64 new_txn_safe_point = 3
string blocker_description = 4
rpc AllocID (, )
pdpb.proto:36message
pdpb.proto:282optional header = 1
uint32 count = 2
message
pdpb.proto:288optional header = 1
uint64 id = 2
uint32 count = 3
rpc AskBatchSplit (, )
pdpb.proto:73message
pdpb.proto:704optional header = 1
optional region = 2
uint32 split_count = 3
SplitReason reason = 4
message
pdpb.proto:717optional header = 1
repeated ids = 2
rpc AskSplit (, )
pdpb.proto:63message
pdpb.proto:670optional header = 1
optional region = 2
message
pdpb.proto:676optional 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:61rpc Bootstrap (, )
pdpb.proto:32message
pdpb.proto:260optional header = 1
optional store = 2
optional region = 3
message
pdpb.proto:267optional header = 1
optional replication_status = 2
rpc DeleteGCBarrier (, )
pdpb.proto:105message
pdpb.proto:1186optional header = 1
optional keyspace_scope = 2
string barrier_id = 3
message
pdpb.proto:1194optional header = 1
optional deleted_barrier_info = 2
rpc DeleteGlobalGCBarrier (, )
pdpb.proto:109message
pdpb.proto:1212optional header = 1
string barrier_id = 2
message
pdpb.proto:1217optional header = 1
optional deleted_barrier_info = 2
rpc GetAllGCSafePointV2 (, )
pdpb.proto:97message
pdpb.proto:1104optional header = 1
message
pdpb.proto:1118optional header = 1
repeated gc_safe_points = 2
int64 revision = 3
message
pdpb.proto:1281optional header = 1
bool exclude_gc_barriers = 2
bool exclude_global_gc_barriers = 3
message
pdpb.proto:1288optional header = 1
repeated gc_states = 2
repeated global_gc_barriers = 3
rpc GetAllStores (, )
pdpb.proto:44rpc GetClusterConfig (, )
pdpb.proto:77message
pdpb.proto:465optional header = 1
message
pdpb.proto:469optional header = 1
optional cluster = 2
rpc GetClusterInfo (, )
pdpb.proto:24GetClusterInfo get the information of this cluster. It does not require the cluster_id in request matchs the id of this cluster.
message
pdpb.proto:512optional header = 1
message
pdpb.proto:522optional 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:127message
pdpb.proto:1416optional header = 1
string dc_location = 2
message
pdpb.proto:1421optional 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:141message
pdpb.proto:1500optional header = 1
message
pdpb.proto:1504optional header = 1
uint64 timestamp = 2
rpc GetGCSafePoint (, )
pdpb.proto:83message
pdpb.proto:981optional header = 1
message
pdpb.proto:985optional header = 1
uint64 safe_point = 2
rpc GetGCSafePointV2 (, )
pdpb.proto:89message
pdpb.proto:1019optional header = 1
oneof keyspace
uint32 keyspace_id = 2
V1/V2 compatibility keyspace id. V3 should use keyspace_identity.
keyspace_identity = 3
V3 keyspace identity.
message
pdpb.proto:1030optional header = 1
uint64 safe_point = 2
rpc GetGCState (, )
pdpb.proto:111message
pdpb.proto:1228optional header = 1
optional keyspace_scope = 2
bool exclude_gc_barriers = 3
bool include_global_gc_barriers = 4
Include all stored global GC barriers in the response. This uses an include flag, unlike exclude_gc_barriers, because proto3 bool fields default to false. GetGCState historically omitted global GC barriers, so false preserves both the existing response and the no-extra-read path.
message
pdpb.proto:1271optional header = 1
optional gc_state = 2
optional global_gc_barriers = 3
Absent when globals were not requested or the server does not support this extension. Present-empty when the request was fulfilled but no global GC barriers are stored.
rpc GetMembers (, )
pdpb.proto:28GetMembers 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:499optional header = 1
message
pdpb.proto:503optional header = 1
repeated members = 2
optional leader = 3
optional etcd_leader = 4
map<string, > tso_allocator_leaders = 5
rpc GetMinTS (, )
pdpb.proto:146Get 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:1510optional header = 1
message
pdpb.proto:1514optional header = 1
optional timestamp = 2
rpc GetOperator (, )
pdpb.proto:119message
pdpb.proto:1354optional header = 1
uint64 region_id = 2
message
pdpb.proto:1367optional header = 1
uint64 region_id = 2
bytes desc = 3
OperatorStatus status = 4
bytes kind = 5
rpc GetPrevRegion (, )
pdpb.proto:52rpc GetRegion (, )
pdpb.proto:50rpc GetRegionByID (, )
pdpb.proto:54rpc GetStore (, )
pdpb.proto:40rpc IsBootstrapped (, )
pdpb.proto:34message
pdpb.proto:272optional header = 1
message
pdpb.proto:276optional header = 1
bool bootstrapped = 2
rpc IsSnapshotRecovering (, )
pdpb.proto:38message
pdpb.proto:295optional header = 1
message
pdpb.proto:299optional header = 1
bool marked = 2
rpc LoadGlobalConfig (, )
pdpb.proto:131message
pdpb.proto:169repeated string names = 1
string config_path = 2
message
pdpb.proto:174repeated items = 1
int64 revision = 2
rpc PutClusterConfig (, )
pdpb.proto:79message
pdpb.proto:475optional header = 1
optional cluster = 2
message
pdpb.proto:481optional header = 1
rpc PutStore (, )
pdpb.proto:42message
pdpb.proto:317optional header = 1
optional store = 2
message
pdpb.proto:323optional header = 1
optional replication_status = 2
rpc QueryRegion (stream , stream )
pdpb.proto:56rpc RegionHeartbeat (stream , stream )
pdpb.proto:48message
pdpb.proto:536optional 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.
uint64 approximate_ia_kv_size = 22
Approximate size of row-based key-value pairs stored in the IA tier for billing. It is a subset of approximate_kv_size and follows the same size accounting rules.
optional bucket_meta = 20
BucketMeta is the bucket version and keys of this region if TiKV enabled the bucket feature
message
pdpb.proto:631optional 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:75message
pdpb.proto:723optional header = 1
repeated regions = 2
message
pdpb.proto:729optional header = 1
rpc ReportBuckets (stream , )
pdpb.proto:135message
pdpb.proto:1467optional header = 1
optional region_epoch = 2
optional buckets = 3
message
pdpb.proto:1474optional header = 1
rpc ReportMinResolvedTS (, )
pdpb.proto:137message
pdpb.proto:1478optional header = 1
uint64 store_id = 2
uint64 min_resolved_ts = 3
message
pdpb.proto:1486optional header = 1
rpc ReportSplit (, )
pdpb.proto:68message
pdpb.proto:687optional header = 1
optional left = 2
optional right = 3
message
pdpb.proto:694optional header = 1
rpc ScanRegions (, )
pdpb.proto:59Deprecated: use BatchScanRegions instead.
message
pdpb.proto:407Use GetRegionResponse as the response of GetRegionByIDRequest. Deprecated: use BatchScanRegionsRequest instead.
optional header = 1
bytes start_key = 2
Physical start key bytes.
int32 limit = 3
no limit when limit <= 0.
bytes end_key = 4
Physical end key bytes. end_key is +inf when it is empty.
message
pdpb.proto:428optional 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:81message
pdpb.proto:955optional 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:975optional header = 1
uint64 finished_percentage = 2
repeated uint64 failed_regions_id = 3
rpc SetExternalTimestamp (, )
pdpb.proto:139message
pdpb.proto:1490optional header = 1
uint64 timestamp = 2
message
pdpb.proto:1496optional header = 1
rpc SetGCBarrier (, )
pdpb.proto:103message
pdpb.proto:1164optional header = 1
optional keyspace_scope = 2
string barrier_id = 3
uint64 barrier_ts = 4
int64 ttl_seconds = 5
message
pdpb.proto:1180optional header = 1
optional new_barrier_info = 2
rpc SetGlobalGCBarrier (, )
pdpb.proto:107message
pdpb.proto:1200optional header = 1
string barrier_id = 2
uint64 barrier_ts = 3
int64 ttl_seconds = 4
message
pdpb.proto:1207optional header = 1
optional new_barrier_info = 2
rpc SplitAndScatterRegions (, )
pdpb.proto:125message
pdpb.proto:1401optional header = 1
repeated bytes split_keys = 2
Physical split key bytes.
string group = 3
uint64 retry_limit = 4
message
pdpb.proto:1409optional header = 1
uint64 split_finished_percentage = 2
uint64 scatter_finished_percentage = 3
repeated uint64 regions_id = 4
rpc SplitRegions (, )
pdpb.proto:123message
pdpb.proto:1388optional header = 1
repeated bytes split_keys = 2
Physical split key bytes.
uint64 retry_limit = 3
message
pdpb.proto:1395optional header = 1
uint64 finished_percentage = 2
repeated uint64 regions_id = 3
rpc StoreGlobalConfig (, )
pdpb.proto:129message
pdpb.proto:160repeated changes = 1
string config_path = 2
message
pdpb.proto:165optional error = 1
rpc StoreHeartbeat (, )
pdpb.proto:46message
pdpb.proto:882optional 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:935optional 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:121message
pdpb.proto:1375optional 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:1382optional header = 1
optional max_local_ts = 2
repeated string synced_dcs = 3
rpc SyncRegions (stream , stream )
pdpb.proto:117message
pdpb.proto:1324optional 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:1340optional 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:30message
pdpb.proto:238This message intentionally omits namespace/keyspace-related fields because API v2 never supported keyspaces when routing TSO requests through the PD API server.
optional header = 1
uint32 count = 2
string dc_location = 3
message
pdpb.proto:253optional header = 1
uint32 count = 2
optional timestamp = 3
rpc UpdateGCSafePoint (, )
pdpb.proto:85message
pdpb.proto:991optional header = 1
uint64 safe_point = 2
message
pdpb.proto:997optional header = 1
uint64 new_safe_point = 2
rpc UpdateGCSafePointV2 (, )
pdpb.proto:93message
pdpb.proto:1059optional header = 1
oneof keyspace
uint32 keyspace_id = 2
V1/V2 compatibility keyspace id. V3 should use keyspace_identity.
keyspace_identity = 4
V3 keyspace identity.
uint64 safe_point = 3
message
pdpb.proto:1071optional header = 1
uint64 new_safe_point = 2
message
pdpb.proto:1003optional header = 1
bytes service_id = 2
int64 TTL = 3
uint64 safe_point = 4
message
pdpb.proto:1011optional header = 1
bytes service_id = 2
int64 TTL = 3
uint64 min_safe_point = 4
message
pdpb.proto:1077optional header = 1
oneof keyspace
uint32 keyspace_id = 2
V1/V2 compatibility keyspace id. V3 should use keyspace_identity.
keyspace_identity = 6
V3 keyspace identity.
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:1096optional header = 1
bytes service_id = 2
int64 ttl = 3
uint64 min_safe_point = 4
rpc WatchGCSafePointV2 (, stream )
pdpb.proto:91message
pdpb.proto:1036optional header = 1
int64 revision = 2
message
pdpb.proto:1053optional header = 1
repeated events = 2
int64 revision = 3
rpc WatchGCStates (, stream )
pdpb.proto:115message
pdpb.proto:1295optional header = 1
bool skip_loading_initial = 2
If false, when the stream is established, the server first sends the current GC states of all keyspaces.
message
pdpb.proto:1303optional header = 1
repeated changes = 2
Clients apply changes in order within this response and across successive responses on the stream. A client must not observe an older state for a keyspace after a newer update. After disconnection, the client reconnects and reloads the initial state. The stream omits GC barrier details and does not emit changes for barrier-only updates. If a barrier update changes an effective GC state, the resulting state change is emitted.
rpc WatchGlobalConfig (, stream )
pdpb.proto:133message
pdpb.proto:149string config_path = 1
int64 revision = 2
message
pdpb.proto:154repeated changes = 1
int64 revision = 2
optional header = 3
message
pdpb.proto:919Used in:
repeated uint64 abnormal_stores = 1
Awake all regions if abnormal_stores is empty.
message
pdpb.proto:445Used as request type in: PD.BatchScanRegions, routerpb.Router.BatchScanRegions
optional header = 1
bool need_buckets = 2
repeated ranges = 3
Physical key ranges. 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:458Used 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:616Used in: ,
repeated switch_witnesses = 1
message
pdpb.proto:1445CPU 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:586Used in: , ,
optional peer = 1
eraftpb.ConfChangeType change_type = 2
message
pdpb.proto:591Used in: ,
repeated changes = 1
If changes is empty, it means that to exit joint state.
message
pdpb.proto:626Used 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:931Used in:
ControlGrpcEvent ctrl_event = 1
Used in:
PAUSE = 0
Pause TiKV grpc server.
RESUME = 1
Resume TiKV grpc server.
message
pdpb.proto:891Used in:
uint64 region_id = 1
repeated failed_voters = 2
message
pdpb.proto:838Used 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:826Used 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. NOTE: This field is only meaningful for V1/V2 compatibility. V3 should use keyspace_identities.
string component = 3
The component that provides the statistic.
repeated keyspace_identities = 4
V3 multi-keyspace statistic scope. Ignore when is_global is true.
message
pdpb.proto:232Used 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:896Used 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:1174Used in: , ,
string barrier_id = 1
uint64 barrier_ts = 2
int64 ttl_seconds = 3
message
pdpb.proto:1108Used in:
oneof keyspace
uint32 keyspace_id = 1
V1/V2 compatibility keyspace id. V3 should use keyspace_identity.
keyspace_identity = 3
V3 keyspace identity.
uint64 gc_safe_point = 2
message
pdpb.proto:1242Used 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:1255GCStateChange describes a change to a keyspace's effective GC state. GCState values sent by WatchGCStates omit gc_barriers because barriers are internal inputs used by PD to calculate effective safe points; the stream reports only changes to the resulting effective state.
Used in:
oneof change
upsert = 1
Insert or replace the complete GC state of this keyspace.
removed = 2
Remove this keyspace from the client's materialized GC-state view. This does not necessarily mean the keyspace metadata was physically deleted.
message
pdpb.proto:328Used 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:334Used as response type in: PD.GetAllStores, routerpb.Router.GetAllStores
optional header = 1
repeated stores = 2
message
pdpb.proto:364Used as request type in: PD.GetRegionByID, routerpb.Router.GetRegionByID
optional header = 1
uint64 region_id = 2
bool need_buckets = 3
message
pdpb.proto:340Used as request type in: PD.GetPrevRegion, PD.GetRegion, routerpb.Router.GetPrevRegion, routerpb.Router.GetRegion
optional header = 1
bytes region_key = 2
Physical key bytes used for Region lookup.
bool need_buckets = 3
message
pdpb.proto:348Used 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:304Used as request type in: PD.GetStore, routerpb.Router.GetStore
optional header = 1
uint64 store_id = 2
message
pdpb.proto:310Used as response type in: PD.GetStore, routerpb.Router.GetStore
optional header = 1
optional store = 2
optional stats = 3
message
pdpb.proto:184Used 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:1222Used in: , , ,
string barrier_id = 1
uint64 barrier_ts = 2
int64 ttl_seconds = 3
message
pdpb.proto:1267GlobalGCBarriersInfo carries presence independently from the barrier list.
Used in:
repeated barriers = 1
message
pdpb.proto:439Used in:
bytes start_key = 1
Physical start key bytes.
bytes end_key = 2
Physical end key bytes. end_key is +inf when it is empty.
message
pdpb.proto:1127A wrapper over keyspace scope. keyspace_id is kept for V1/V2 compatibility. V3 should use keyspace_identity and reject missing/invalid namespace or keyspace IDs in tenant-scoped requests.
Used in: , , , , , ,
oneof keyspace
uint32 keyspace_id = 1
keyspace_identity = 2
V3 keyspace identity.
message
pdpb.proto:485Used 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:601Used in: ,
optional target = 1
Used in: ,
SUCCESS = 0
TIMEOUT = 1
CANCEL = 2
REPLACE = 3
RUNNING = 4
message
pdpb.proto:867Used 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:745Used 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:531Used in: , , , , ,
optional peer = 1
uint64 down_seconds = 2
message
pdpb.proto:1336Used in:
repeated peers = 1
message
pdpb.proto:1332Used 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:371Used 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
Physical key bytes to query.
repeated bytes prev_keys = 5
Previous physical key bytes to query.
message
pdpb.proto:384Used 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:1430Used 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:740Used in:
string key = 1
uint64 value = 2
message
pdpb.proto:903Used 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:416Used 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:397Used in:
optional region = 1
optional leader = 2
repeated down_peers = 3
repeated pending_peers = 4
optional buckets = 5
message
pdpb.proto:1315Used 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:195Used 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:209Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
uint64 cluster_id = 1
cluster_id is the ID of the cluster which sent the response.
optional error = 2
message
pdpb.proto:1042SafePointEvent is for the rpc WatchGCSafePointV2.
Used in:
oneof keyspace
uint32 keyspace_id = 1
V1/V2 compatibility keyspace id. V3 should use keyspace_identity.
keyspace_identity = 4
V3 keyspace identity served by this event.
uint64 safe_point = 2
EventType type = 3
Used in:
UNKNOWN_SVC_MODE = 0
PD_SVC_MODE = 1
API_SVC_MODE = 2
message
pdpb.proto:846Used in:
double cause_value = 1
double cause_rate = 2
double result_value = 3
double result_rate = 4
message
pdpb.proto:853Used 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:712Used in: ,
uint64 new_region_id = 1
repeated uint64 new_peer_ids = 2
Used in: ,
ADMIN = 0
SIZE = 1
LOAD = 2
message
pdpb.proto:605Used in: ,
CheckPolicy policy = 1
repeated bytes keys = 2
Physical split key bytes.
message
pdpb.proto:877Used in:
repeated peer_reports = 1
uint64 step = 2
message
pdpb.proto:757Used 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:611Used in:
uint64 peer_id = 1
bool is_witness = 2
message
pdpb.proto:733Used 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:245Used 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:596Used in: ,
optional peer = 1
repeated peers = 2