Introduce QueryRegion stream

Signed-off-by: JmPotato <[email protected]>
pingcap · Oct 15, 2024 · dc598fd · dc598fd
1 parent 4a3e17f
commit dc598fd
Show file tree

Hide file tree

Showing 3 changed files with 139 additions and 2 deletions.
diff --git a/pkg/configpb/configpb.pb.gw.go b/pkg/configpb/configpb.pb.gw.go
diff --git a/proto/pdpb.proto b/proto/pdpb.proto
@@ -51,6 +51,8 @@ service PD {
 
     rpc GetRegionByID(GetRegionByIDRequest) returns (GetRegionResponse) {}
 
+    rpc QueryRegion(stream QueryRegionRequest) returns (stream QueryRegionResponse) {}
+
     // Deprecated: use BatchScanRegions instead.
     rpc ScanRegions(ScanRegionsRequest) returns (ScanRegionsResponse) {}
 
@@ -334,6 +336,29 @@ message GetRegionByIDRequest {
     bool need_buckets = 3;
 }
 
+message QueryRegionRequest {
+    RequestHeader header = 1;
+
+    bool need_buckets = 2;
+    repeated bytes region_keys = 3;
+    repeated uint64 region_ids = 4;
+}
+
+message QueryRegionResponse {
+    ResponseHeader header = 1;
+
+    map<bytes, RegionResponse> regions_by_key = 2;
+    map<uint64, RegionResponse> regions_by_id = 3;
+}
+
+message RegionResponse {
+    metapb.Region region = 1;
+    metapb.Peer leader = 2;
+    repeated PeerStats down_peers = 3;
+    repeated metapb.Peer pending_peers = 4;
+    metapb.Buckets buckets = 5;
+}
+
 // Use GetRegionResponse as the response of GetRegionByIDRequest.
 // Deprecated: use BatchScanRegionsRequest instead.
 message ScanRegionsRequest {

diff --git a/scripts/proto.lock b/scripts/proto.lock
@@ -14265,6 +14265,93 @@
               }
             ]
           },
+          {
+            "name": "QueryRegionRequest",
+            "fields": [
+              {
+                "id": 1,
+                "name": "header",
+                "type": "RequestHeader"
+              },
+              {
+                "id": 2,
+                "name": "need_buckets",
+                "type": "bool"
+              },
+              {
+                "id": 3,
+                "name": "region_keys",
+                "type": "bytes",
+                "is_repeated": true
+              },
+              {
+                "id": 4,
+                "name": "region_ids",
+                "type": "uint64",
+                "is_repeated": true
+              }
+            ]
+          },
+          {
+            "name": "QueryRegionResponse",
+            "fields": [
+              {
+                "id": 1,
+                "name": "header",
+                "type": "ResponseHeader"
+              }
+            ],
+            "maps": [
+              {
+                "key_type": "bytes",
+                "field": {
+                  "id": 2,
+                  "name": "regions_by_key",
+                  "type": "RegionResponse"
+                }
+              },
+              {
+                "key_type": "uint64",
+                "field": {
+                  "id": 3,
+                  "name": "regions_by_id",
+                  "type": "RegionResponse"
+                }
+              }
+            ]
+          },
+          {
+            "name": "RegionResponse",
+            "fields": [
+              {
+                "id": 1,
+                "name": "region",
+                "type": "metapb.Region"
+              },
+              {
+                "id": 2,
+                "name": "leader",
+                "type": "metapb.Peer"
+              },
+              {
+                "id": 3,
+                "name": "down_peers",
+                "type": "PeerStats",
+                "is_repeated": true
+              },
+              {
+                "id": 4,
+                "name": "pending_peers",
+                "type": "metapb.Peer",
+                "is_repeated": true
+              },
+              {
+                "id": 5,
+                "name": "buckets",
+                "type": "metapb.Buckets"
+              }
+            ]
+          },
           {
             "name": "ScanRegionsRequest",
             "fields": [
@@ -16494,6 +16581,13 @@
                 "in_type": "GetRegionByIDRequest",
                 "out_type": "GetRegionResponse"
               },
+              {
+                "name": "QueryRegion",
+                "in_type": "QueryRegionRequest",
+                "out_type": "QueryRegionResponse",
+                "in_streamed": true,
+                "out_streamed": true
+              },
               {
                 "name": "ScanRegions",
                 "in_type": "ScanRegionsRequest",