enhance: add resource group declarative api

examples/main/java/io/milvus/ResourceGroupExample.java

@@ -0,0 +1,81 @@
+package io.milvus;
+
+import com.google.gson.Gson;
+
+import io.milvus.client.MilvusServiceClient;
+import io.milvus.resourcegroup.ResourceGroupManagement;
+import io.milvus.param.ConnectParam;
+
+public class ResourceGroupExample {
+    private static final ResourceGroupManagement manager;
+    private static final String rgName1 = "rg1";
+    private static final String rgName2 = "rg2";
+    private static Gson gson = new Gson();
+
+    static {
+        ConnectParam connectParam = ConnectParam.newBuilder()
+                .withHost("localhost")
+                .withPort(19530)
+                .withAuthorization("root", "Milvus")
+                .build();
+        manager = new ResourceGroupManagement(new MilvusServiceClient(connectParam));
+    }
+
+    private static void printResourceGroupInfo() throws Exception {
+        manager.listResourceGroups().forEach((name, rg) -> {
+            System.out.println(name);
+            System.out.println(gson.toJson(rg));
+        });
+    }
+
+    public static void main(String[] args) throws Exception {
+        // It's a demo to show how to use resource group management.
+        // It create a database-level-resource-group-control (single replica)
+        // management.
+        // Declarative resource group API can also achieve
+        // replica-level-resource-group-control (multi-replica) management.
+
+        printResourceGroupInfo();
+        // Initialize the cluster with 1 resource group
+        // default_rg: 1
+        manager.initializeCluster(1);
+        printResourceGroupInfo();
+
+        // Add one more node to default rg.
+        manager.scaleResourceGroupTo(ResourceGroupManagement.DEFAULT_RG, 2);
+        // add new query node.
+        // default_rg: 2
+        printResourceGroupInfo();
+
+        // Add a new resource group.
+        manager.createResourceGroup(rgName1, 1);
+        // default_rg: 2, rg1: 0
+        // add new query node.
+        // default_rg: 2, rg1: 1
+        printResourceGroupInfo();
+
+        // Add a new resource group.
+        manager.createResourceGroup(rgName2, 2);
+        // default_rg: 2, rg1: 1, rg2: 0
+        // add new query node.
+        // default_rg: 2, rg1: 1, rg2: 1
+        // add new query node.
+        // default_rg: 2, rg1: 1, rg2: 2
+        printResourceGroupInfo();
+
+        // downscale default_rg to 1
+        manager.scaleResourceGroupTo(ResourceGroupManagement.DEFAULT_RG, 1);
+        // default_rg: 1, rg1: 1, rg2: 2, recycle_rg: 1
+        printResourceGroupInfo();
+
+        manager.scaleResourceGroupTo(ResourceGroupManagement.DEFAULT_RG, 5);
+        manager.scaleResourceGroupTo(rgName1, 1);
+        manager.scaleResourceGroupTo(rgName2, 3);
+        // keep 8 query node in cluster.
+        printResourceGroupInfo();
+
+        // if there are replicas in other rg, transfer them to default together.
+        manager.transferDataBaseToResourceGroup("default", ResourceGroupManagement.DEFAULT_RG);
+        printResourceGroupInfo();
+    }
+}

examples/main/java/io/milvus/resourcegroup/NodeInfo.java

@@ -0,0 +1,46 @@
+package io.milvus.resourcegroup;
+
+import lombok.Getter;
+import lombok.NonNull;
+
+@Getter
+public class NodeInfo {
+    private long nodeId;
+    private String address;
+    private String hostname;
+
+    private NodeInfo(Builder builder) {
+        this.nodeId = builder.nodeId;
+        this.address = builder.address;
+        this.hostname = builder.hostname;
+    }
+
+    public static Builder newBuilder() {
+        return new Builder();
+    }
+
+    public static class Builder {
+        private long nodeId;
+        private String address;
+        private String hostname;
+
+        public Builder withNodeId(long nodeId) {
+            this.nodeId = nodeId;
+            return this;
+        }
+
+        public Builder withAddress(@NonNull String address) {
+            this.address = address;
+            return this;
+        }
+
+        public Builder withHostname(@NonNull String hostname) {
+            this.hostname = hostname;
+            return this;
+        }
+
+        public NodeInfo build() {
+            return new NodeInfo(this);
+        }
+    }
+}

examples/main/java/io/milvus/resourcegroup/ResourceGroupInfo.java

@@ -0,0 +1,103 @@
+package io.milvus.resourcegroup;
+
+import java.util.HashSet;
+import java.util.Set;
+
+import io.milvus.common.resourcegroup.ResourceGroupConfig;
+import lombok.Getter;
+import lombok.NonNull;
+
+@Getter
+public class ResourceGroupInfo {
+    private String resourceGroupName;
+    private ResourceGroupConfig resourceGroupConfig;
+    private Set<String> fullDatabases; // databases belong to this resource group completely.
+    private Set<String> partialDatabases; // databases belong to this resource group partially, some collection is in
+                                          // other resource group.
+    private Set<NodeInfo> nodes; // actual query node in this resource group.
+
+    private ResourceGroupInfo(@NonNull Builder builder) {
+        this.resourceGroupName = builder.resourceGroupName;
+        this.resourceGroupConfig = builder.resourceGroupConfig;
+        this.fullDatabases = builder.fullDatabases;
+        if (this.fullDatabases == null) {
+            this.fullDatabases = new HashSet<String>();
+        }
+        this.partialDatabases = builder.partialDatabases;
+        if (this.partialDatabases == null) {
+            this.partialDatabases = new HashSet<String>();
+        }
+        this.nodes = builder.nodes;
+        if (this.nodes == null) {
+            this.nodes = new HashSet<NodeInfo>();
+        }
+    }
+
+    public static Builder newBuilder() {
+        return new Builder();
+    }
+
+    public static final class Builder {
+        private String resourceGroupName;
+        private ResourceGroupConfig resourceGroupConfig;
+        private Set<String> fullDatabases;
+        private Set<String> partialDatabases;
+        private Set<NodeInfo> nodes; // actual query node in this resource group.
+
+        public Builder withResourceGroupName(@NonNull String resourceGroupName) {
+            this.resourceGroupName = resourceGroupName;
+            return this;
+        }
+
+        public Builder addFullDatabases(@NonNull String databaseName) {
+            if (this.fullDatabases == null) {
+                this.fullDatabases = new HashSet<String>();
+            }
+            this.fullDatabases.add(databaseName);
+            return this;
+        }
+
+        public Builder addPartialDatabases(@NonNull String databaseName) {
+            if (this.partialDatabases == null) {
+                this.partialDatabases = new HashSet<String>();
+            }
+            this.partialDatabases.add(databaseName);
+            return this;
+        }
+
+        public Builder addAvailableNode(@NonNull NodeInfo node) {
+            if (this.nodes == null) {
+                this.nodes = new HashSet<NodeInfo>();
+            }
+            this.nodes.add(node);
+            return this;
+        }
+
+        public Builder withConfig(@NonNull ResourceGroupConfig resourceGroupConfig) {
+            this.resourceGroupConfig = resourceGroupConfig;
+            return this;
+        }
+
+        public ResourceGroupInfo build() {
+            return new ResourceGroupInfo(this);
+        }
+    }
+
+    /**
+     * Check if this resource group is the default resource group.
+     * 
+     * @return true if this resource group is the default resource group.
+     */
+    public boolean isDefaultResourceGroup() {
+        return this.resourceGroupName == ResourceGroupManagement.DEFAULT_RG;
+    }
+
+    /**
+     * Check if this resource group is the recycle resource group.
+     * 
+     * @return true if this resource group is the recycle resource group.
+     */
+    public boolean isRecycleResourceGroup() {
+        return this.resourceGroupName == ResourceGroupManagement.RECYCLE_RG;
+    }
+}