Bump up API to support sharding_key (#82)

* Bump up API to support sharding_key

Author: ButterBright

CHANGES.md

@@ -2,6 +2,13 @@ Changes by Version
 ==================
 Release Notes.
 
+0.9.0
+------------------
+
+### Features
+
+* Bump up the API to support sharding_key.
+
 0.8.0
 ------------------
 

README.md

@@ -226,6 +226,7 @@ Measure m = Measure.newBuilder()
                                         .setName("service_cpm_minute"))
                    .setInterval(Duration.ofMinutes(1).format())
                    .setEntity(Entity.newBuilder().addTagNames("entity_id"))
+                   .setShardingKey(ShardingKey.newBuilder().addTagNames("service_id"))
                    .addTagFamilies(
                        TagFamilySpec.newBuilder()
                                     .setName("default")

src/main/proto/banyandb/v1/banyandb-database.proto

@@ -96,6 +96,10 @@ message FieldSpec {
   CompressionMethod compression_method = 4 [(validate.rules).enum.defined_only = true];
 }
 
+message ShardingKey {
+  repeated string tag_names = 1 [(validate.rules).repeated.min_items = 1];
+}
+
 // Measure intends to store data point
 message Measure {
   // metadata is the identity of a measure
@@ -114,6 +118,8 @@ message Measure {
   // index_mode specifies whether the data should be stored exclusively in the index,
   // meaning it will not be stored in the data storage system.
   bool index_mode = 7;
+  // sharding_key determines the distribution of TopN-related data.
+  ShardingKey sharding_key = 8;
 }
 
 // TopNAggregation generates offline TopN statistics for a measure's TopN approximation

src/test/java/org/apache/skywalking/banyandb/v1/client/ITMeasureMetadataRegistryTest.java

@@ -28,6 +28,7 @@
 import org.apache.skywalking.banyandb.database.v1.BanyandbDatabase.FieldSpec;
 import org.apache.skywalking.banyandb.database.v1.BanyandbDatabase.FieldType;
 import org.apache.skywalking.banyandb.database.v1.BanyandbDatabase.Measure;
+import org.apache.skywalking.banyandb.database.v1.BanyandbDatabase.ShardingKey;
 import org.apache.skywalking.banyandb.database.v1.BanyandbDatabase.TagFamilySpec;
 import org.apache.skywalking.banyandb.database.v1.BanyandbDatabase.TagSpec;
 import org.apache.skywalking.banyandb.database.v1.BanyandbDatabase.TagType;
@@ -102,6 +103,7 @@ private Measure buildMeasure() {
                                                               .setName("service_cpm_minute"))
                                          .setInterval(Duration.ofMinutes(1).format())
                                          .setEntity(Entity.newBuilder().addTagNames("entity_id"))
+                                         .setShardingKey(ShardingKey.newBuilder().addTagNames("service_id"))
                                          .addTagFamilies(
                                              TagFamilySpec.newBuilder()
                                                           .setName("default")