@zilliz/milvus2-sdk-node 2.2.2 → 2.2.4

package/dist/milvus/Partition.js

@@ -29,7 +29,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
             if (y = 0, t) op = [op[0] & 2, t.value];
             switch (op[0]) {
@@ -55,6 +55,7 @@ exports.Partition = void 0;
 var utils_1 = require("../utils");
 var Client_1 = require("./Client");
 var ErrorReason_1 = require("./const/ErrorReason");
+var Validate_1 = require("./utils/Validate");
 var Format_1 = require("./utils/Format");
 var Partition = /** @class */ (function (_super) {
     __extends(Partition, _super);
@@ -65,17 +66,18 @@ var Partition = /** @class */ (function (_super) {
      * Create a partition in a collection.
      *
      * @param data
-     *  | Property           | Type   |           Description              |
-     *  | :----------------- | :----  | :-------------------------------  |
-     *  | collection_name    | String |       Collection name   |
-     *  | partition_name     | String |       Partition name      |
-     *  | timeout        | number |        An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | collection_name | String | Collection name |
+     *  | partition_name | String | Partition name |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+  
      *
-     * @return
-     *  | Property      | Description |
-     *  | :-------------| :--------  |
-     *  | error_code    | Error code number      |
-     *  | reason        | Error cause |   *
+     * @returns
+     *  | Property | Description |
+     *  | :-- | :-- |
+     *  | error_code | Error code number |
+     *  | reason | Error cause |
      *
      * #### Example
      *
@@ -92,7 +94,7 @@ var Partition = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        this.checkCollectionAndPartitionName(data);
+                        (0, Validate_1.checkCollectionAndPartitionName)(data);
                         return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'CreatePartition', data, data.timeout)];
                     case 1:
                         promise = _a.sent();
@@ -105,17 +107,18 @@ var Partition = /** @class */ (function (_super) {
      * Check if a partition exists in a collection.
      *
      * @param data
-     *  | Property           | Type   |           Description              |
-     *  | :----------------- | :----  | :-------------------------------  |
-     *  | collection_name    | string |       Collection name   |
-     *  | partition_name     | string |       Parititon name      |
-     *  | timeout        | number |        An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | collection_name | string | Collection name |
+     *  | partition_name | string | Parititon name |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+  
      *
-     * @return
-     *  | Property    |           Description              |
-     *  | :-------------| :-------------------------------  |
-     *  | status        |  { error_code: number,reason:string }|
-     *  | value         |        `true` or `false`                 |
+     * @returns
+     * | Property | Description |
+     *  | :-- | :-- |
+     *  | status | { error_code: number,reason:string } |
+     *  | value | `true` or `false` |
      *
      * #### Example
      *
@@ -132,7 +135,7 @@ var Partition = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        this.checkCollectionAndPartitionName(data);
+                        (0, Validate_1.checkCollectionAndPartitionName)(data);
                         return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'HasPartition', data, data.timeout)];
                     case 1:
                         promise = _a.sent();
@@ -145,17 +148,18 @@ var Partition = /** @class */ (function (_super) {
      * Show all partitions in a collection.
      *
      * @param data
-     *  | Property           | Type   |           Description              |
-     *  | :----------------- | :----  | :-------------------------------  |
-     *  | collection_name    | String |       Collection name   |
-     *  | timeout        | number |        An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | collection_name | String | Collection name |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+  
      *
-     * @return
-     *  | Property    |           Description              |
-     *  | :-------------| :-------------------------------  |
-     *  | status        |  { error_code: number, reason: string }|
-     *  | partition_names         |        Array of partition names                 |
-     *  | partitionIDs            |        Array of partition IDs                 |
+     * @returns
+     * | Property | Description |
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
+     *  | partition_names | Array of partition names |
+     *  | partitionIDs | Array of partition IDs |
      *
      *
      * #### Example
@@ -172,7 +176,7 @@ var Partition = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        this.checkCollectionName(data);
+                        (0, Validate_1.checkCollectionName)(data);
                         return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'ShowPartitions', data, data.timeout)];
                     case 1:
                         promise = _a.sent();
@@ -185,18 +189,19 @@ var Partition = /** @class */ (function (_super) {
      * Show the statistics information of a partition.
      *
      * @param data
-     *  | Property           | Type   |           Description              |
-     *  | :----------------- | :----  | :-------------------------------  |
-     *  | collection_name    | String |       Collection name   |
-     *  | partition_name     | String |       Partition name      |
-     *  | timeout        | number |        An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | collection_name | String | Collection name |
+     *  | partition_name | String | Partition name |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+  
      *
-     * @return
-     *  | Property    |           Description              |
-     *  | :-------------| :-------------------------------  |
-     *  | status        |  { error_code: number, reason: string }|
-     *  | stats        |        [{key: string, value: string}]                |
-     *  | data  |          { row_count: 0 } transformed from **stats**               |
+     * @returns
+     * | Property | Description |
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
+     *  | stats | [{key: string, value: string}] |
+     *  | data  | { row_count: 0 } transformed from **stats** |
      *
      *
      * #### Example
@@ -214,7 +219,7 @@ var Partition = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        this.checkCollectionAndPartitionName(data);
+                        (0, Validate_1.checkCollectionAndPartitionName)(data);
                         return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'GetPartitionStatistics', data, data.timeout)];
                     case 1:
                         promise = _a.sent();
@@ -225,20 +230,22 @@ var Partition = /** @class */ (function (_super) {
         });
     };
     /**
-     * Load a partition into cache.
+     * Load multiple partitions into query nodes.
      *
      * @param data
-     *  | Property           | Type   |           Description              |
-     *  | :----------------- | :----  | :-------------------------------  |
-     *  | collection_name    | String |       Collection name   |
-     *  | partition_names    | String[] |       Array of partition names      |
-     *  | timeout        | number |        An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
+     *  | Property | Type  | Description |
+     *  | :--- | :-- | :-- |
+     *  | collection_name | String | Collection name |
+     *  | partition_names | String[] | Array of partition names |
+     *  | replica_number? | number | replica number |
+     *  | resource_groups | String[] | resource group names |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
      *
-     * @return
-     *  | Property      | Description |
-     *  | :-------------| :--------  |
-     *  | error_code    | Error code number      |
-     *  | reason        | Error cause |   *
+     * @returns
+     *  | Property | Description |
+     *  | :-- | :-- |
+     *  | error_code | Error code number |
+     *  | reason | Error cause |
      *
      * #### Example
      *
@@ -255,7 +262,7 @@ var Partition = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        this.checkCollectionName(data);
+                        (0, Validate_1.checkCollectionName)(data);
                         if (!Array.isArray(data.partition_names) || !data.partition_names.length) {
                             throw new Error(ErrorReason_1.ERROR_REASONS.PARTITION_NAMES_IS_REQUIRED);
                         }
@@ -271,17 +278,18 @@ var Partition = /** @class */ (function (_super) {
      * Release a partition from cache.
      *
      * @param data
-     *  | Property           | Type   |           Description              |
-     *  | :----------------- | :----  | :-------------------------------  |
-     *  | collection_name    | String |       Collection name   |
-     *  | partition_names    | String[] |       Array of partition names    |
-     *  | timeout        | number |        An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | collection_name | String | Collection name |
+     *  | partition_names | String[] | Array of partition names |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+  
      *
-     * @return
-     *  | Property      | Description |
-     *  | :-------------| :--------  |
-     *  | error_code    | Error code number      |
-     *  | reason        | Error cause |   *
+     * @returns
+     *  | Property | Description |
+     *  | :-- | :-- |
+     *  | error_code | Error code number |
+     *  | reason | Error cause |
      *
      * #### Example
      *
@@ -298,7 +306,7 @@ var Partition = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        this.checkCollectionName(data);
+                        (0, Validate_1.checkCollectionName)(data);
                         if (!Array.isArray(data.partition_names) || !data.partition_names.length) {
                             throw new Error(ErrorReason_1.ERROR_REASONS.PARTITION_NAMES_IS_REQUIRED);
                         }
@@ -320,17 +328,18 @@ var Partition = /** @class */ (function (_super) {
      * To drop a partition will drop all data in this partition and the `_default` partition cannot be dropped.
      *
      * @param data
-     *  | Property           | Type   |           Description              |
-     *  | :----------------- | :----  | :-------------------------------  |
-     *  | collection_name    | String |       Collection name   |
-     *  | partition_name    | String |       Partition name     |
-     *  | timeout        | number |        An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined       |
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | collection_name | String | Collection name |
+     *  | partition_name | String | Partition name |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+  
      *
-     * @return
-     *  | Property      | Description |
-     *  | :-------------| :--------  |
-     *  | error_code    | Error code number      |
-     *  | reason        | Error cause |   *
+     * @returns
+     *  | Property | Description |
+     *  | :-- | :-- |
+     *  | error_code | Error code number |
+     *  | reason | Error cause |
      *
      * #### Example
      *
@@ -347,7 +356,7 @@ var Partition = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        this.checkCollectionAndPartitionName(data);
+                        (0, Validate_1.checkCollectionAndPartitionName)(data);
                         return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'DropPartition', data, data.timeout)];
                     case 1:
                         promise = _a.sent();

package/dist/milvus/Partition.js.map

@@ -1 +1 @@
-{"version":3,"file":"Partition.js","sourceRoot":"","sources":["../../milvus/Partition.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kCAAqC;AACrC,mCAAkC;AAClC,mDAAoD;AAgBpD,yCAAoD;AACpD;IAA+B,6BAAM;IAArC;;IA+QA,CAAC;IA9QC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,mCAAe,GAArB,UAAsB,IAAwB;;;;;;wBAC5C,IAAI,CAAC,+BAA+B,CAAC,IAAI,CAAC,CAAC;wBAC3B,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,MAAM,EACX,iBAAiB,EACjB,IAAI,EACJ,IAAI,CAAC,OAAO,CACb,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,gCAAY,GAAlB,UAAmB,IAAqB;;;;;;wBACtC,IAAI,CAAC,+BAA+B,CAAC,IAAI,CAAC,CAAC;wBAC3B,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,MAAM,EACX,cAAc,EACd,IAAI,EACJ,IAAI,CAAC,OAAO,CACb,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,kCAAc,GAApB,UACE,IAAuB;;;;;;wBAEvB,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;wBACf,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,MAAM,EACX,gBAAgB,EAChB,IAAI,EACJ,IAAI,CAAC,OAAO,CACb,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,0CAAsB,GAA5B,UACE,IAA+B;;;;;;wBAE/B,IAAI,CAAC,+BAA+B,CAAC,IAAI,CAAC,CAAC;wBAC3B,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,MAAM,EACX,wBAAwB,EACxB,IAAI,EACJ,IAAI,CAAC,OAAO,CACb,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,OAAO,CAAC,IAAI,GAAG,IAAA,2BAAkB,EAAC,OAAO,CAAC,KAAK,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;wBAChE,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,kCAAc,GAApB,UAAqB,IAAuB;;;;;;wBAC1C,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;wBAC/B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE;4BACxE,MAAM,IAAI,KAAK,CAAC,2BAAa,CAAC,2BAA2B,CAAC,CAAC;yBAC5D;wBACe,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,MAAM,EACX,gBAAgB,EAChB,IAAI,EACJ,IAAI,CAAC,OAAO,CACb,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,qCAAiB,GAAvB,UAAwB,IAA0B;;;;;;wBAChD,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;wBAC/B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE;4BACxE,MAAM,IAAI,KAAK,CAAC,2BAAa,CAAC,2BAA2B,CAAC,CAAC;yBAC5D;wBACe,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,MAAM,EACX,mBAAmB,EACnB,IAAI,EACJ,IAAI,CAAC,OAAO,CACb,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;OAKG;IACH;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,iCAAa,GAAnB,UAAoB,IAAsB;;;;;;wBACxC,IAAI,CAAC,+BAA+B,CAAC,IAAI,CAAC,CAAC;wBAC3B,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,MAAM,EACX,eAAe,EACf,IAAI,EACJ,IAAI,CAAC,OAAO,CACb,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IACH,gBAAC;AAAD,CAAC,AA/QD,CAA+B,eAAM,GA+QpC;AA/QY,8BAAS"}
+{"version":3,"file":"Partition.js","sourceRoot":"","sources":["../../milvus/Partition.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kCAAqC;AACrC,mCAAkC;AAClC,mDAAoD;AACpD,6CAG0B;AAC1B,yCAAoD;AAepD;IAA+B,6BAAM;IAArC;;IAuRA,CAAC;IAtRC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,mCAAe,GAArB,UAAsB,IAAwB;;;;;;wBAC5C,IAAA,0CAA+B,EAAC,IAAI,CAAC,CAAC;wBACtB,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,MAAM,EACX,iBAAiB,EACjB,IAAI,EACJ,IAAI,CAAC,OAAO,CACb,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,gCAAY,GAAlB,UAAmB,IAAqB;;;;;;wBACtC,IAAA,0CAA+B,EAAC,IAAI,CAAC,CAAC;wBACtB,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,MAAM,EACX,cAAc,EACd,IAAI,EACJ,IAAI,CAAC,OAAO,CACb,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,kCAAc,GAApB,UACE,IAAuB;;;;;;wBAEvB,IAAA,8BAAmB,EAAC,IAAI,CAAC,CAAC;wBACV,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,MAAM,EACX,gBAAgB,EAChB,IAAI,EACJ,IAAI,CAAC,OAAO,CACb,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,0CAAsB,GAA5B,UACE,IAA+B;;;;;;wBAE/B,IAAA,0CAA+B,EAAC,IAAI,CAAC,CAAC;wBACtB,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,MAAM,EACX,wBAAwB,EACxB,IAAI,EACJ,IAAI,CAAC,OAAO,CACb,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,OAAO,CAAC,IAAI,GAAG,IAAA,2BAAkB,EAAC,OAAO,CAAC,KAAK,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;wBAChE,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,kCAAc,GAApB,UAAqB,IAAuB;;;;;;wBAC1C,IAAA,8BAAmB,EAAC,IAAI,CAAC,CAAC;wBAC1B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE;4BACxE,MAAM,IAAI,KAAK,CAAC,2BAAa,CAAC,2BAA2B,CAAC,CAAC;yBAC5D;wBACe,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,MAAM,EACX,gBAAgB,EAChB,IAAI,EACJ,IAAI,CAAC,OAAO,CACb,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,qCAAiB,GAAvB,UAAwB,IAA0B;;;;;;wBAChD,IAAA,8BAAmB,EAAC,IAAI,CAAC,CAAC;wBAC1B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE;4BACxE,MAAM,IAAI,KAAK,CAAC,2BAAa,CAAC,2BAA2B,CAAC,CAAC;yBAC5D;wBACe,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,MAAM,EACX,mBAAmB,EACnB,IAAI,EACJ,IAAI,CAAC,OAAO,CACb,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;OAKG;IACH;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,iCAAa,GAAnB,UAAoB,IAAsB;;;;;;wBACxC,IAAA,0CAA+B,EAAC,IAAI,CAAC,CAAC;wBACtB,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,MAAM,EACX,eAAe,EACf,IAAI,EACJ,IAAI,CAAC,OAAO,CACb,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IACH,gBAAC;AAAD,CAAC,AAvRD,CAA+B,eAAM,GAuRpC;AAvRY,8BAAS"}

package/dist/milvus/Resource.d.ts

@@ -0,0 +1,173 @@
+import { Client } from './Client';
+import { ResStatus } from './types';
+import { GrpcTimeOut, CreateResourceGroupReq, DropResourceGroupsReq, ListResourceGroupsResponse, DesribeResourceGroupsReq, DescribeResourceGroupResponse, TransferNodeReq, TransferReplicaReq } from './types';
+export declare class Resource extends Client {
+    /**
+     * Create a resource group.
+     *
+     * @param data
+     *  | Property | Type | Description |
+     *  | :--- | :-- | :-- |
+     *  | resource_group | String | Resource group name |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+     *
+     * @returns
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | status.error_code | string | error code |
+     *  | status.reason | string | error reason |
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).resourceManager.createResourceGroup({
+     *     resource_group: "vector_01",
+     *  });
+     * ```
+     */
+    createResourceGroup(data: CreateResourceGroupReq): Promise<ResStatus>;
+    /**
+     * list resource groups.
+     *
+     * @returns
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | status.error_code | string | error code |
+     *  | status.reason | string | error reason |
+     *  | resource_groups | string[] | Resource group string array |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).resourceManager.listResourceGroups();
+     * ```
+     */
+    listResourceGroups(data?: GrpcTimeOut): Promise<ListResourceGroupsResponse>;
+    /**
+     * Describe a resource group.
+     *
+     * @param data
+     *  | Property | Type | Description |
+     *  | :--- | :-- | :-- |
+     *  | resource_group | String | Resource group name |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+     *
+     * @returns
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | status.error_code | string | error code |
+     *  | status.reason | string | error reason |
+     *  | resource_group.capacity | number | num_node which has been transfer to this rg |
+     *  | resource_group.num_available_node | number | available node_num, some node may shutdown |
+     *  | resource_group.num_loaded_replica | { [key: string]: number } | from collection_name to loaded replica of each collecion in this rg |
+     *  | resource_group.num_outgoing_node | { [key: string]: number } | from collection_name to outgoging accessed node num by replica loaded in this rg |
+     *  | resource_group.num_incoming_node | { [key: string]: number } | from collection_name to incoming accessed node num by replica loaded in other rg |
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).resourceManager.describeResrouceGroup({
+     *    resource_group: 'my-resource-group'
+     * });
+     * ```
+     */
+    describeResourceGroup(data: DesribeResourceGroupsReq): Promise<DescribeResourceGroupResponse>;
+    /**
+     * drop a resource group.
+     * @param data
+     *  | Property | Type | Description |
+     *  | :--- | :-- | :-- |
+     *  | resource_group | String | Resource group name |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+     *
+     * @returns
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | status.error_code | string | error code |
+     *  | status.reason | string | error reason |
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).resourceManager.dropResourceGroup({
+     *    resource_group: 'my-resource-group'
+     * });
+     * ```
+     */
+    dropResourceGroup(data: DropResourceGroupsReq): Promise<ResStatus>;
+    /**
+     * transfer nodes from one resource group to another
+     * @param data
+     *  | Property | Type | Description |
+     *  | :--- | :-- | :-- |
+     *  | source_resource_group | String | source resource group name |
+     *  | target_resource_group | String | target resource group name |
+     *  | collection_name | String | collection name |
+     *  | num_replica | Number | number of replicas to transfer |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+     *
+     * @returns
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | status.error_code | string | error code |
+     *  | status.reason | string | error reason |
+     *
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).resourceManager.transferNode({
+     *    source_resource_group: 'source-resource-group',
+     *    target_resource_group: 'target-resource-group',
+     *    collection_name: 'my-collection',
+     *    num_replica: 2
+     * });
+     * ```
+     */
+    transferReplica(data: TransferReplicaReq): Promise<ResStatus>;
+    /**
+     * transfer nodes from one resource group to another
+     * @param data
+     *  | Property | Type | Description |
+     *  | :--- | :-- | :-- |
+     *  | source_resource_group | String | source resource group name |
+     *  | target_resource_group | String | target resource group name |
+     *  | num_node | Number | number of nodes to transfer |
+     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+     *
+     * @returns
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | status.error_code | string | error code |
+     *  | status.reason | string | error reason |
+     *
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).resourceManager.transferNode({
+     *    source_resource_group: 'source-resource-group',
+     *    target_resource_group: 'target-resource-group',
+     *    num_node: 4
+     * });
+     * ```
+     */
+    transferNode(data: TransferNodeReq): Promise<ResStatus>;
+    /**
+     * drop all resource groups, transfer all nodes to the default group
+     *
+     * @returns
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | status.error_code | string | error code |
+     *  | status.reason | string[] | error reason |
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).resourceManager.dropResourceGroups();
+     * ```
+     */
+    dropAllResourceGroups(): Promise<ResStatus[]>;
+}