@zilliz/milvus2-sdk-node 2.2.2 → 2.2.4

package/dist/milvus/Collection.js

@@ -40,7 +40,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]) {
@@ -67,17 +67,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Collection = void 0;
 var protobufjs_1 = __importDefault(require("protobufjs"));
+var path_1 = __importDefault(require("path"));
 var utils_1 = require("../utils");
 var ErrorReason_1 = require("./const/ErrorReason");
-var Collection_1 = require("./types/Collection");
-var Response_1 = require("./types/Response");
 var Validate_1 = require("./utils/Validate");
-var path_1 = __importDefault(require("path"));
 var Format_1 = require("./utils/Format");
 var Client_1 = require("./Client");
+var Milvus_1 = require("./const/Milvus");
+var types_1 = require("./types");
 var schemaPath = path_1.default.resolve(__dirname, '../proto/proto/schema.proto');
 /**
- * See all [collection operation examples](https://github.com/milvus-io/milvus-sdk-node/blob/main/example/Collection.ts).
+ * @see [collection operation examples](https://github.com/milvus-io/milvus-sdk-node/blob/main/example/Collection.ts)
  */
 var Collection = /** @class */ (function (_super) {
     __extends(Collection, _super);
@@ -90,17 +90,17 @@ var Collection = /** @class */ (function (_super) {
      * Create a collection in Milvus.
      *
      * @param data
-     *  | Property                | Type   |           Description              |
-     *  | :---------------------- | :----  | :-------------------------------  |
-     *  | collection_name        | String |        Collection name       |
-     *  | description             | String |        Collection description       |
-     *  | consistency_level       | String |        "Strong"(Milvus default) | "Session" | "Bounded"| "Eventually" | "Customized";      |
-     *  | fields        | <a href="https://github.com/milvus-io/milvus-sdk-node/blob/main/milvus/types/Collection.ts#L8" target="_blank">FieldType</a> |     Field data      |
-     *  | 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 | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | collection_name | String | Collection name |
+     *  | description | String | Collection description |
+     *  | consistency_level | String | "Strong"(Milvus default) | "Session" | "Bounded"| "Eventually" | "Customized"; |
+     *  | fields | <a href="https://github.com/milvus-io/milvus-sdk-node/blob/main/milvus/types/Collection.ts#L8" target="_blank">FieldType</a> | Field data |
+     *  | 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      | Description |
-     *  | :-------------| :--------  |
+     *  | :-- | :-- |
      *  | error_code    | Error code number      |
      *  | reason        | Error cause          |
      *
@@ -131,7 +131,7 @@ var Collection = /** @class */ (function (_super) {
      */
     Collection.prototype.createCollection = function (data) {
         return __awaiter(this, void 0, void 0, function () {
-            var _a, fields, collection_name, description, _b, consistency_level, root, CollectionSchema, FieldSchema, payload, collectionParams, schemaBtyes, level, promise;
+            var _a, fields, collection_name, description, _b, consistency_level, CollectionSchema, FieldSchema, payload, collectionParams, schemaBtyes, level, promise;
             return __generator(this, function (_c) {
                 switch (_c.label) {
                     case 0:
@@ -140,9 +140,6 @@ var Collection = /** @class */ (function (_super) {
                             throw new Error(ErrorReason_1.ERROR_REASONS.CREATE_COLLECTION_CHECK_PARAMS);
                         }
                         (0, Validate_1.checkCollectionFields)(fields);
-                        return [4 /*yield*/, protobufjs_1.default.load(schemaPath)];
-                    case 1:
-                        root = _c.sent();
                         CollectionSchema = this._protoRoot.lookupType('milvus.proto.schema.CollectionSchema');
                         FieldSchema = this._protoRoot.lookupType('milvus.proto.schema.FieldSchema');
                         payload = {
@@ -157,11 +154,11 @@ var Collection = /** @class */ (function (_super) {
                         });
                         collectionParams = CollectionSchema.create(payload);
                         schemaBtyes = CollectionSchema.encode(collectionParams).finish();
-                        level = Object.keys(Collection_1.ConsistencyLevelEnum).includes(consistency_level)
-                            ? Collection_1.ConsistencyLevelEnum[consistency_level]
-                            : Collection_1.ConsistencyLevelEnum['Bounded'];
+                        level = Object.keys(Milvus_1.ConsistencyLevelEnum).includes(consistency_level)
+                            ? Milvus_1.ConsistencyLevelEnum[consistency_level]
+                            : Milvus_1.ConsistencyLevelEnum['Bounded'];
                         return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'CreateCollection', __assign(__assign({}, data), { schema: schemaBtyes, consistency_level: level }), data.timeout)];
-                    case 2:
+                    case 1:
                         promise = _c.sent();
                         return [2 /*return*/, promise];
                 }
@@ -172,16 +169,16 @@ var Collection = /** @class */ (function (_super) {
      * Check if a collection exists.
      *
      * @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       |
-     *
-     * @return
-     *  | Property    |           Description              |
-     *  | :-------------| :-------------------------------  |
-     *  | status        |  { error_code: number, reason: string }|
-     *  | value         |        `true` or `false`                 |
+     *  | 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 |
+     *
+     * @returns
+     *  | Property | Description |
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
+     *  | value | `true` or `false` |
     
      *
      * #### Example
@@ -198,7 +195,7 @@ var Collection = /** @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, 'HasCollection', data, data.timeout)];
                     case 1:
                         promise = _a.sent();
@@ -211,17 +208,18 @@ var Collection = /** @class */ (function (_super) {
      * List all collections or get collection loading status.
      *
      * @param data
-     *  | Property           | Type   |           Description              |
-     *  | :----------------- | :----  | :-------------------------------  |
-     *  | type(optional)        | enum |       All -> 0, Loaded -> 1       |
-     *  | collection_names(optional)        | String[] |       If `type = Loaded`, Milvus will return `collection_names inMemory_percentages`     |
-     *  | 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 |
+     *  | :-- | :-- | :-- |
+     *  | type(optional) | enum | All -> 0, Loaded -> 1 |
+     *  | collection_names(optional) | String[] | If `type = Loaded`, Milvus will return `collection_names inMemory_percentages` |
+     *  | 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 } |
-     *  | data         |  Contains collection name, ID , timestamp (UTC created time), and loadedPercentage (100 means loaded)      |
+     * @returns
+     * | Property | Description |
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
+     *  | data |  Contains collection name, ID , timestamp (UTC created time), and loadedPercentage (100 means loaded) |
      *
      *
      * #### Example
@@ -236,7 +234,7 @@ var Collection = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'ShowCollections', {
-                            type: data ? data.type : Collection_1.ShowCollectionsType.All,
+                            type: data ? data.type : types_1.ShowCollectionsType.All,
                             collection_names: (data === null || data === void 0 ? void 0 : data.collection_names) || [],
                         }, data === null || data === void 0 ? void 0 : data.timeout)];
                     case 1:
@@ -260,17 +258,17 @@ var Collection = /** @class */ (function (_super) {
      * Show the details of a collection, e.g. name, schema.
      *
      * @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 }|
-     *  | schema        |        Information of all fields in this collection                |
-     *  | collectionID  |        Collection ID                |
+     * @returns
+     * | Property | Description |
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
+     *  | schema | Information of all fields in this collection |
+     *  | collectionID  | Collection ID |
      *
      *
      * #### Example
@@ -287,7 +285,7 @@ var Collection = /** @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, 'DescribeCollection', data, data.timeout)];
                     case 1:
                         promise = _a.sent();
@@ -300,17 +298,17 @@ var Collection = /** @class */ (function (_super) {
      * Show the statistics information of 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 }|
-     *  | stats        |        [{key: string, value: string}]                |
-     *  | data  |        Transform **stats** to { row_count: 0 }               |
+     * @returns
+     * | Property | Description |
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
+     *  | stats | [{key: string, value: string}] |
+     *  | data | Transform **stats** to { row_count: 0 } |
      *
      *
      * #### Example
@@ -327,7 +325,7 @@ var Collection = /** @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, 'GetCollectionStatistics', data, data.timeout)];
                     case 1:
                         promise = _a.sent();
@@ -342,17 +340,18 @@ var Collection = /** @class */ (function (_super) {
      * It's async function, but we can use showCollections to check loading status.
      *
      * @param data
-     *  | Property           | Type   |           Description              |
-     *  | :----------------- | :----  | :-------------------------------  |
-     *  | collection_name    | String |       Collection name       |
-     *  | replica_number?    | number |       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 |
-     *  | :-------------| :--------  |
-     *  | error_code    | Error code number      |
-     *  | reason        | Error cause|   *
+     *  | Property | Type | Description |
+     *  | :--- | :-- | :-- |
+     *  | collection_name    | String | Collection name |
+     *  | 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 |
+     *
+     * @returns
+     *  | Property | Description |
+     *  | :-- | :-- |
+     *  | error_code | Error code number |
+     *  | reason | Error cause |
      *
      * #### Example
      *
@@ -368,7 +367,7 @@ var Collection = /** @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, 'LoadCollection', data, data.timeout)];
                     case 1:
                         promise = _a.sent();
@@ -382,16 +381,18 @@ var Collection = /** @class */ (function (_super) {
      * Help to ensure this collection is loaded.
      *
      * @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       |
-     *
-     * @return
-     *  | Property      | Description |
-     *  | :-------------| :--------  |
-     *  | error_code    | Error code number      |
-     *  | reason        | Error cause|   *
+     *  | Property | Type  | Description |
+     *  | :--- | :-- | :-- |
+     *  | collection_name | String | Collection name |
+     *  | replica_number？ | number | replica number |
+     *  | resource_groups？ | String[] | resource group |
+     *  | 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 | Description |
+     *  | :-- | :-- |
+     *  | error_code | Error code number |
+     *  | reason | Error cause |
      *
      * #### Example
      *
@@ -407,11 +408,11 @@ var Collection = /** @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, 'LoadCollection', data, data.timeout)];
                     case 1:
                         promise = _a.sent();
-                        if (promise.error_code !== Response_1.ErrorCode.SUCCESS) {
+                        if (promise.error_code !== types_1.ErrorCode.SUCCESS) {
                             throw new Error("ErrorCode: ".concat(promise.error_code, ". Reason: ").concat(promise.reason));
                         }
                         loadedPercentage = 0;
@@ -420,11 +421,11 @@ var Collection = /** @class */ (function (_super) {
                         if (!(Number(loadedPercentage) < 100)) return [3 /*break*/, 4];
                         return [4 /*yield*/, this.showCollections({
                                 collection_names: [data.collection_name],
-                                type: Collection_1.ShowCollectionsType.Loaded,
+                                type: types_1.ShowCollectionsType.Loaded,
                             })];
                     case 3:
                         res = _a.sent();
-                        if (res.status.error_code !== Response_1.ErrorCode.SUCCESS) {
+                        if (res.status.error_code !== types_1.ErrorCode.SUCCESS) {
                             throw new Error("ErrorCode: ".concat(res.status.error_code, ". Reason: ").concat(res.status.reason));
                         }
                         // Because we pass collection_names in showCollections, so it will only this collection in result.
@@ -440,16 +441,16 @@ var Collection = /** @class */ (function (_super) {
      * Note that you cannot search while the corresponding collection is unloaded.
      *
      * @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 |
-     *  | :-------------| :--------  |
-     *  | error_code    | Error code number      |
-     *  | reason        | Error cause |   *
+     * @returns
+     *  | Property | Description |
+     *  | :-- | :-- |
+     *  | error_code | Error code number |
+     *  | reason | Error cause |
      *
      * #### Example
      *
@@ -465,7 +466,7 @@ var Collection = /** @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, 'ReleaseCollection', data, data.timeout)];
                     case 1:
                         promise = _a.sent();
@@ -474,20 +475,61 @@ var Collection = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Rename a collection
+     *
+     * @param data
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | collection_name | String | old collection name |
+     *  | new_collection_name | String | new 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       |
+     *
+     * @returns
+     *  | Property | Description |
+     *  | :-- | :-- |
+     *  | error_code | Error code number |
+     *  | reason | Error cause |
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).collectionManager.renameCollection({
+     *    collection_name: 'my_collection',
+     *    new_collection_name: 'my_new_collection'
+     *  });
+     * ```
+     */
+    Collection.prototype.renameCollection = function (data) {
+        return __awaiter(this, void 0, void 0, function () {
+            var promise;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'RenameCollection', {
+                            oldName: data.collection_name,
+                            newName: data.new_collection_name,
+                        }, data.timeout)];
+                    case 1:
+                        promise = _a.sent();
+                        return [2 /*return*/, promise];
+                }
+            });
+        });
+    };
     /**
      * Drop a collection. Note that this drops all data in the 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 |
-     *  | :-------------| :--------  |
-     *  | error_code    | Error code number      |
-     *  | reason        | Error cause|   *
+     * @returns
+     *  | Property | Description |
+     *  | :-- | :-- |
+     *  | error_code | Error code number |
+     *  | reason | Error cause |
      *
      * #### Example
      *
@@ -503,7 +545,7 @@ var Collection = /** @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, 'DropCollection', data, data.timeout)];
                     case 1:
                         promise = _a.sent();
@@ -513,9 +555,30 @@ var Collection = /** @class */ (function (_super) {
         });
     };
     /**
-     * @ignore
      * Create collection alias, then you can use alias instead of collection_name when you do vector search
+     *
      * @param data
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | alias | String | alias name |
+     *  | 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. |
+     *
+     * @returns
+     *  | Property | Description |
+     *  | :-- | :-- |
+     *  | error_code | Error code number |
+     *  | reason | Error cause |
+     *
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).collectionManager.createAlias({
+     *    alias: 'my_collection_alis',
+     *    collection_name: 'my_collection',
+     *  });
+     * ```
      */
     Collection.prototype.createAlias = function (data) {
         return __awaiter(this, void 0, void 0, function () {
@@ -523,7 +586,7 @@ var Collection = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        this.checkCollectionName(data);
+                        (0, Validate_1.checkCollectionName)(data);
                         if (!data.alias) {
                             throw new Error(ErrorReason_1.ERROR_REASONS.ALIAS_NAME_IS_REQUIRED);
                         }
@@ -536,8 +599,30 @@ var Collection = /** @class */ (function (_super) {
         });
     };
     /**
-     * @ignore
+     * Drop a collection alias
+     *
      * @param data
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | alias | String | alias name |
+     *  | 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. |
+     *
+     * @returns
+     *  | Property | Description |
+     *  | :-- | :-- |
+     *  | error_code | Error code number |
+     *  | reason | Error cause |
+     *
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).collectionManager.dropAlias({
+     *    alias: 'my_collection_alis',
+     *    collection_name: 'my_collection',
+     *  });
+     * ```
      */
     Collection.prototype.dropAlias = function (data) {
         return __awaiter(this, void 0, void 0, function () {
@@ -557,8 +642,30 @@ var Collection = /** @class */ (function (_super) {
         });
     };
     /**
-     * @ignore
+     * alter a collection alias
+     *
      * @param data
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | alias | String | alias name |
+     *  | 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. |
+     *
+     * @returns
+     *  | Property | Description |
+     *  | :-- | :-- |
+     *  | error_code | Error code number |
+     *  | reason | Error cause |
+     *
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).collectionManager.alterAlais({
+     *    alias: 'my_collection_alis',
+     *    collection_name: 'my_collection',
+     *  });
+     * ```
      */
     Collection.prototype.alterAlias = function (data) {
         return __awaiter(this, void 0, void 0, function () {
@@ -566,7 +673,7 @@ var Collection = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        this.checkCollectionName(data);
+                        (0, Validate_1.checkCollectionName)(data);
                         if (!data.alias) {
                             throw new Error(ErrorReason_1.ERROR_REASONS.ALIAS_NAME_IS_REQUIRED);
                         }
@@ -582,16 +689,16 @@ var Collection = /** @class */ (function (_super) {
      * Do compaction for the collection.
      *
      * @param data
-     *  | Property           | Type   |           Description              |
-     *  | :----------------- | :----  | :-------------------------------  |
-     *  | collection_name    | String |       The collection name to compact       |
-     *  | 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 | The collection name to compact |
+     *  | 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 }|
-     *  | compactionID  | compaction ID |
+     * @returns
+     *  | Property | Description |
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
+     *  | compactionID | compaction ID |
      *
      * #### Example
      *
@@ -607,7 +714,7 @@ var Collection = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        this.checkCollectionName(data);
+                        (0, Validate_1.checkCollectionName)(data);
                         return [4 /*yield*/, this.describeCollection(data)];
                     case 1:
                         collectionInfo = _a.sent();
@@ -625,16 +732,16 @@ var Collection = /** @class */ (function (_super) {
      * Get compaction states of a targeted compaction id
      *
      * @param data
-     *  | Property           | Type   |           Description              |
-     *  | :----------------- | :----  | :-------------------------------  |
-     *  | compactionID       | number or string |       the id returned by compact       |
-     *  | 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 |
+     *  | :-- | :-- | :-- |
+     *  | compactionID | number or string | the id returned by compact |
+     *  | 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 }|
-     *  | state         | the state of the compaction |
+     * @returns
+     *  | Property | Description |
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
+     *  | state | the state of the compaction |
      *
      * #### Example
      *
@@ -665,16 +772,16 @@ var Collection = /** @class */ (function (_super) {
      * Get compaction states of a targeted compaction id
      *
      * @param data
-     *  | Property           | Type   |           Description              |
-     *  | :----------------- | :----  | :-------------------------------  |
-     *  | compactionID       | number or string |       the id returned by compact       |
-     *  | 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 |
+     *  | :-- | :-- | :-- |
+     *  | compactionID | number or string | the id returned by compact |
+     *  | 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 }|
-     *  | state         | the state of the compaction |
+     * @returns
+     *  | Property | Description |
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
+     *  | state | the state of the compaction |
      *
      * #### Example
      *
@@ -705,15 +812,15 @@ var Collection = /** @class */ (function (_super) {
      * Get replicas
      *
      * @param data
-     *  | Property           | Type   |           Description              |
-     *  | :----------------- | :----  | :-------------------------------  |
-     *  | collectionID       | number or string |       the id returned by compact       |
-     *  | 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 }|
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | collectionID | number or string | the id returned by compact |
+     *  | 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 | Description |
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
      *  | ReplicaInfo[] | replica info array |
      *
      * #### Example