package metapb

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: pdpb.RegionHeartbeatRequest, schedulingpb.RegionHeartbeatRequest

• uint64 version = 1

  A hint indicate if keys have changed.

• repeated bytes keys = 2

  keys of buckets, include start/end key of region

Used in: Buckets

• repeated uint64 read_bytes = 1

  total read in bytes of each bucket

• repeated uint64 write_bytes = 2

  total write in bytes of each bucket

• repeated uint64 read_qps = 3

  total read qps of each bucket

• repeated uint64 write_qps = 4

  total write qps of each bucket

• repeated uint64 read_keys = 5

  total read keys of each bucket

• repeated uint64 write_keys = 6

  total write keys of each bucket

Used in: pdpb.GetRegionResponse, pdpb.Region, pdpb.RegionResponse, pdpb.ReportBucketsRequest, pdpb.SyncRegionResponse, schedulingpb.RegionBucketsRequest

• uint64 region_id = 1

• uint64 version = 2

  A hint indicate if keys have changed.

• repeated bytes keys = 3

  keys of buckets, include start/end key of region

• optional BucketStats stats = 4

  bucket stats

• uint64 period_in_ms = 5

  The period in milliseconds that stats are collected with in

Used in: pdpb.GetClusterConfigResponse, pdpb.PutClusterConfigRequest

• uint64 id = 1

• uint32 max_peer_count = 2

  max peer count for a region. pd will do the auto-balance if region peer count mismatches.

  more attributes......

NodeState is going to replace StoreState to make the state concept more clear. "Up" is devided into "Preparing" and "Serving" stages so that we can better describe the online process. "Removing" is just like previous `Offline` which is more accurate. "Removed" has the same meaning with `Tombstone`.

Used in: Store, pdpb.StoreHeartbeatResponse

• Preparing = 0

• Serving = 1

• Removing = 2

• Removed = 3

Used in: coprocessor.StoreBatchTask, enginepb.SnapshotState, errorpb.NotLeader, kvrpcpb.Context, Region, pdpb.ChangePeer, pdpb.DemoteFailedVoters, pdpb.GetRegionResponse, pdpb.PeerStats, pdpb.Peers, pdpb.Region, pdpb.RegionHeartbeatRequest, pdpb.RegionHeartbeatResponse, pdpb.RegionResponse, pdpb.ScanRegionsResponse, pdpb.ScatterRegionRequest, pdpb.SyncRegionResponse, pdpb.TransferLeader, raft_cmdpb.ChangePeerRequest, raft_cmdpb.RaftRequestHeader, raft_cmdpb.RegionDetailResponse, raft_cmdpb.RegionLeaderResponse, raft_cmdpb.TransferLeaderRequest, raft_serverpb.CheckGcPeer, raft_serverpb.ExtraMessage, raft_serverpb.MergedRecord, raft_serverpb.RaftMessage, raft_serverpb.RaftSnapshotData, raft_serverpb.RegionLocalState, schedulingpb.RegionHeartbeatRequest, schedulingpb.RegionHeartbeatResponse

• uint64 id = 1

• uint64 store_id = 2

• PeerRole role = 3

• bool is_witness = 4

Used in: Peer

• Voter = 0

  Voter -> Voter

• Learner = 1

  Learner/None -> Learner

• IncomingVoter = 2

  Learner/None -> Voter

• DemotingVoter = 3

  Voter -> Learner

  We forbid Voter -> None, it can introduce unavailability as discussed in etcd-io/etcd#7625 Learner -> None can be apply directly, doesn't need to be stored as joint state.

Used in: backup.CheckAdminResponse, backup.PrepareSnapshotBackupRequest, backup.PrepareSnapshotBackupResponse, coprocessor.BatchResponse, enginepb.SnapshotState, errorpb.EpochNotMatch, kvrpcpb.SplitRegionResponse, mpp.DispatchTaskResponse, pdpb.AskBatchSplitRequest, pdpb.AskSplitRequest, pdpb.BootstrapRequest, pdpb.GetRegionResponse, pdpb.Merge, pdpb.RecoveryPlan, pdpb.Region, pdpb.RegionHeartbeatRequest, pdpb.RegionResponse, pdpb.ReportBatchSplitRequest, pdpb.ReportSplitRequest, pdpb.ScanRegionsResponse, pdpb.ScatterRegionRequest, pdpb.SyncRegionResponse, raft_cmdpb.BatchSplitResponse, raft_cmdpb.ChangePeerResponse, raft_cmdpb.ChangePeerV2Response, raft_cmdpb.CommitMergeRequest, raft_cmdpb.PrepareMergeRequest, raft_cmdpb.RegionDetailResponse, raft_cmdpb.SnapResponse, raft_cmdpb.SplitResponse, raft_serverpb.MergeState, raft_serverpb.RaftMessage, raft_serverpb.RaftSnapshotData, raft_serverpb.RegionLocalState, schedulingpb.AskBatchSplitRequest, schedulingpb.RegionHeartbeatRequest

• uint64 id = 1

• bytes start_key = 2

  Region key range [start_key, end_key).

• bytes end_key = 3

• optional RegionEpoch region_epoch = 4

• repeated Peer peers = 5

• optional encryptionpb.EncryptionMeta encryption_meta = 6

  Encryption metadata for start_key and end_key. encryption_meta.iv is IV for start_key. IV for end_key is calculated from (encryption_meta.iv + len(start_key)). The field is only used by PD and should be ignored otherwise. If encryption_meta is empty (i.e. nil), it means start_key and end_key are unencrypted.

• bool is_in_flashback = 7

  The flashback state indicates whether this region is in the flashback state. TODO: only check by `flashback_start_ts` in the future. Keep for compatibility now.

• uint64 flashback_start_ts = 8

  The start_ts that the current flashback progress is using.

Used in: backup.DataFileInfo, backup.RegionMetaHint, cdcpb.ChangeDataRequest, coprocessor.RegionInfo, coprocessor.StoreBatchTask, import_sstpb.SSTMeta, kvrpcpb.Context, kvrpcpb.LeaderInfo, Region, pdpb.RegionHeartbeatResponse, pdpb.ReportBucketsRequest, raft_cmdpb.RaftRequestHeader, raft_serverpb.AvailabilityContext, raft_serverpb.CheckGcPeer, raft_serverpb.MergedRecord, raft_serverpb.RaftMessage, schedulingpb.RegionBucketsRequest, schedulingpb.RegionHeartbeatResponse

• uint64 conf_ver = 1

  Conf change version, auto increment when add or remove peer

• uint64 version = 2

  Region version, auto increment when split or merge

Used in: pdpb.BootstrapRequest, pdpb.GetAllStoresResponse, pdpb.GetStoreResponse, pdpb.PutStoreRequest

• uint64 id = 1

• string address = 2

  Address to handle client requests (kv, cop, etc.)

• StoreState state = 3

• repeated StoreLabel labels = 4

• string version = 5

• string peer_address = 6

  Address to handle peer requests (raft messages from other store). Empty means same as address.

• string status_address = 7

  Status address provides the HTTP service for external components

• string git_hash = 8

• int64 start_timestamp = 9

  The start timestamp of the current store

• string deploy_path = 10

• int64 last_heartbeat = 11

  The last heartbeat timestamp of the store.

• bool physically_destroyed = 12

  If the store is physically destroyed, which means it can never up again.

• NodeState node_state = 13

  NodeState is used to replace StoreState which will be deprecated in the future.

Case insensitive key/value for replica constraints.

Used in: Store

• string key = 1

• string value = 2

Used in: Store

• Up = 0

• Offline = 1

• Tombstone = 2