package raft_cmdpb

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: AdminRequest, AdminResponse

• InvalidAdmin = 0

• ChangePeer = 1

• Split = 2

  Use `BatchSplit` instead.

• CompactLog = 3

• TransferLeader = 4

• ComputeHash = 5

• VerifyHash = 6

• PrepareMerge = 7

• CommitMerge = 8

• RollbackMerge = 9

• BatchSplit = 10

• ChangePeerV2 = 11

• PrepareFlashback = 12

• FinishFlashback = 13

• BatchSwitchWitness = 14

• UpdateGcPeer = 15

  Command that updates RegionLocalState.gc_peers

Used in: cdcpb.Event.Admin, enginepb.CommandRequest, RaftCmdRequest

• AdminCmdType cmd_type = 1

• optional ChangePeerRequest change_peer = 2

• optional SplitRequest split = 3

• optional CompactLogRequest compact_log = 4

• optional TransferLeaderRequest transfer_leader = 5

• optional VerifyHashRequest verify_hash = 6

• optional PrepareMergeRequest prepare_merge = 7

• optional CommitMergeRequest commit_merge = 8

• optional RollbackMergeRequest rollback_merge = 9

• optional BatchSplitRequest splits = 10

• optional ChangePeerV2Request change_peer_v2 = 11

• optional ComputeHashRequest compute_hash = 12

• optional PrepareFlashbackRequest prepare_flashback = 13

• optional FinishFlashbackRequest finish_flashback = 14

• optional BatchSwitchWitnessRequest switch_witnesses = 15

• optional UpdateGcPeerRequest update_gc_peers = 16

Used in: cdcpb.Event.Admin, enginepb.CommandRequest, RaftCmdResponse

• AdminCmdType cmd_type = 1

• optional ChangePeerResponse change_peer = 2

• optional SplitResponse split = 3

• optional CompactLogResponse compact_log = 4

• optional TransferLeaderResponse transfer_leader = 5

• optional VerifyHashResponse verify_hash = 6

• optional PrepareMergeResponse prepare_merge = 7

• optional CommitMergeResponse commit_merge = 8

• optional RollbackMergeResponse rollback_merge = 9

• optional BatchSplitResponse splits = 10

• optional ChangePeerV2Response change_peer_v2 = 11

• optional PrepareFlashbackResponse prepare_flashback = 12

• optional FinishFlashbackResponse finish_flashback = 13

• optional BatchSwitchWitnessResponse switch_witnesses = 14

  UpdateGcPeer doesn't need to be responded. Avoid consuming a tag number.

Used in: AdminRequest

• repeated SplitRequest requests = 1

• bool right_derive = 2

  If true, the last region derive the origin region_id, other regions use new ids.

• bool share_source_region_size = 3

  It should be false iff the region split by user key such as split table or create partion table etc, the new region's will not share the source region size, so it's region size is zero. It should be true iff the region's load reaches the threshold such as size, keys, load check etc, the new region's size will share the origin region, so it's region size is half of the source region.

Used in: AdminResponse

• repeated metapb.Region regions = 1

Used in: AdminRequest

• repeated SwitchWitnessRequest switch_witnesses = 1

Used in: AdminResponse

(message has no fields)

Used in: AdminRequest, ChangePeerV2Request

• eraftpb.ConfChangeType change_type = 1

  This can be only called in internal RaftStore now.

• optional metapb.Peer peer = 2

Used in: AdminResponse

• optional metapb.Region region = 1

Used in: AdminRequest

• repeated ChangePeerRequest changes = 1

Used in: AdminResponse

• optional metapb.Region region = 1

Used in: Request, Response

• Invalid = 0

• Get = 1

• Put = 3

• Delete = 4

• Snap = 5

• Prewrite = 6

• DeleteRange = 7

• IngestSST = 8

• ReadIndex = 9

Used in: AdminRequest

• optional metapb.Region source = 1

• uint64 commit = 2

• repeated eraftpb.Entry entries = 3

• optional raft_serverpb.RegionLocalState source_state = 4

  Used in v2. When it's present, `source` and `commit` will not be set.

Used in: AdminResponse

(message has no fields)

Used in: AdminRequest

• uint64 compact_index = 1

• uint64 compact_term = 2

• uint64 voter_replicated_index = 3

Used in: AdminResponse

(message has no fields)

Used in: AdminRequest

• bytes context = 1

Used in: Request

• string cf = 1

• bytes start_key = 2

• bytes end_key = 3

• bool notify_only = 4

Used in: Response

(message has no fields)

Used in: Request

• string cf = 1

• bytes key = 2

Used in: Response

(message has no fields)

Used in: AdminRequest

(message has no fields)

Used in: AdminResponse

(message has no fields)

Used in: Request

• string cf = 1

• bytes key = 2

Used in: Response

• bytes value = 1

Used in: Request

• optional import_sstpb.SSTMeta sst = 1

Used in: Response

(message has no fields)

Used in: AdminRequest

• uint64 start_ts = 1

  The start_ts that the current flashback progress is using.

Used in: AdminResponse

(message has no fields)

Used in: AdminRequest

• uint64 min_index = 1

• optional metapb.Region target = 2

Used in: AdminResponse

(message has no fields)

Used in: Request

• bytes key = 1

• bytes value = 2

• bytes lock = 3

Used in: Response

(message has no fields)

Used in: Request

• string cf = 1

• bytes key = 2

• bytes value = 3

Used in: Response

(message has no fields)

• optional RaftRequestHeader header = 1

• repeated Request requests = 2

  We can't enclose normal requests and administrator request at same time.

• optional AdminRequest admin_request = 3

• optional StatusRequest status_request = 4

• optional RaftResponseHeader header = 1

• repeated Response responses = 2

• optional AdminResponse admin_response = 3

• optional StatusResponse status_response = 4

Used in: RaftCmdRequest

• uint64 region_id = 1

• optional metapb.Peer peer = 2

• bool read_quorum = 3

  true for read linearization

• bytes uuid = 4

  16 bytes, to distinguish request.

• optional metapb.RegionEpoch region_epoch = 5

• uint64 term = 6

• bool sync_log = 7

• bool replica_read = 8

• uint64 applied_index = 9

  Read requests can be responsed directly after the Raft applys to `applied_index`.

• uint64 flags = 10

  Custom flags for this raft request.

• bytes flag_data = 11

• kvrpcpb.CommandPri priority = 12

• string resource_group_name = 13

Used in: RaftCmdResponse

• optional errorpb.Error error = 1

• bytes uuid = 2

• uint64 current_term = 3

Used in: Request

• uint64 start_ts = 1

  In replica read, leader uses start_ts and key_ranges to check memory locks.

• repeated kvrpcpb.KeyRange key_ranges = 2

Used in: Response

• uint64 read_index = 1

• optional kvrpcpb.LockInfo locked = 2

  The memory lock blocking this read at the leader

For getting more information of the region. We add some admin operations (ChangePeer, Split...) into the pb job list, then pd server will peek the first one, handle it and then pop it from the job lib. But sometimes, the pd server may crash before popping. When another pd server starts and finds the job is running but not finished, it will first check whether the raft server already has handled this job. E,g, for ChangePeer, if we add Peer10 into region1 and find region1 has already had Peer10, we can think this ChangePeer is finished, and can pop this job from job list directly.

Used in: StatusRequest

(message has no fields)

Used in: StatusResponse

• optional metapb.Region region = 1

• optional metapb.Peer leader = 2

For get the leader of the region.

Used in: StatusRequest

(message has no fields)

Used in: StatusResponse

• optional metapb.Peer leader = 1

Used in: enginepb.CommandRequest, RaftCmdRequest

• CmdType cmd_type = 1

• optional GetRequest get = 2

• optional PutRequest put = 4

• optional DeleteRequest delete = 5

• optional SnapRequest snap = 6

• optional PrewriteRequest prewrite = 7

• optional DeleteRangeRequest delete_range = 8

• optional IngestSSTRequest ingest_sst = 9

• optional ReadIndexRequest read_index = 10

Used in: RaftCmdResponse

• CmdType cmd_type = 1

• optional GetResponse get = 2

• optional PutResponse put = 4

• optional DeleteResponse delete = 5

• optional SnapResponse snap = 6

• optional PrewriteResponse prewrite = 7

• optional DeleteRangeResponse delte_range = 8

• optional IngestSSTResponse ingest_sst = 9

• optional ReadIndexResponse read_index = 10

Used in: AdminRequest

• uint64 commit = 1

Used in: AdminResponse

(message has no fields)

Used in: Request

(message has no fields)

Used in: Response

• optional metapb.Region region = 1

Used in: AdminRequest, BatchSplitRequest

• bytes split_key = 1

  This can be only called in internal RaftStore now. The split_key must be in the been splitting region.

• 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.

• bool right_derive = 4

  If true, right region derive the origin region_id, left region use new_region_id. Will be ignored in batch split, use `BatchSplitRequest::right_derive` instead.

• bool share_source_region_size = 5

  It should be false iff the region split by user key such as split table or create partion table etc, the new region's will not share the source region size, so it's region size is zero. It should be true iff the region's load reaches the threshold such as size, keys, load check etc, the new region's size will share the origin region, so it's region size is half of the source region.

Used in: AdminResponse

• optional metapb.Region left = 1

• optional metapb.Region right = 2

Used in: StatusRequest, StatusResponse

• InvalidStatus = 0

• RegionLeader = 1

• RegionDetail = 2

Used in: RaftCmdRequest

• StatusCmdType cmd_type = 1

• optional RegionLeaderRequest region_leader = 2

• optional RegionDetailRequest region_detail = 3

Used in: RaftCmdResponse

• StatusCmdType cmd_type = 1

• optional RegionLeaderResponse region_leader = 2

• optional RegionDetailResponse region_detail = 3

Used in: BatchSwitchWitnessRequest

• uint64 peer_id = 1

• bool is_witness = 2

Used in: AdminRequest

• optional metapb.Peer peer = 1

• repeated metapb.Peer peers = 2

Used in: AdminResponse

(message has no fields)

Used in: AdminRequest

• repeated uint64 peer_id = 1

Used in: AdminRequest

• uint64 index = 1

• bytes hash = 2

• bytes context = 3

Used in: AdminResponse

(message has no fields)