@zilliz/milvus2-sdk-node 2.2.9 → 2.2.11

package/dist/milvus/Collection.js

@@ -1,960 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        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]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Collection = void 0;
-var utils_1 = require("../utils");
-var BaseClient_1 = require("./BaseClient");
-var _1 = require(".");
-var utils_2 = require("../utils");
-/**
- * @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);
-    function Collection() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    /**
-     * 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 |
-     *
-     * @returns
-     *  | Property      | Description |
-     *  | :-- | :-- |
-     *  | error_code    | Error code number      |
-     *  | reason        | Error cause          |
-     *
-     * #### Example
-     *
-     * ```
-     *  new milvusClient(MILUVS_ADDRESS).createCollection({
-     *    collection_name: 'my_collection',
-     *    fields: [
-     *      {
-     *        name: "vector_01",
-     *        description: "vector field",
-     *        data_type: DataType.FloatVect,
-     *        type_params: {
-     *          dim: "8"
-     *        }
-     *      },
-     *      {
-     *        name: "age",
-     *        data_type: DataType.Int64,
-     *        autoID: true,
-     *        is_primary_key: true,
-     *        description: "",
-     *      },
-     *  ],
-     *  });
-     * ```
-     */
-    Collection.prototype.createCollection = function (data) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function () {
-            var _b, fields, collection_name, description, _c, consistency_level, CollectionSchema, FieldSchema, payload, collectionParams, schemaBytes, level, promise;
-            return __generator(this, function (_d) {
-                switch (_d.label) {
-                    case 0:
-                        _b = data || {}, fields = _b.fields, collection_name = _b.collection_name, description = _b.description, _c = _b.consistency_level, consistency_level = _c === void 0 ? 'Bounded' : _c;
-                        // Check if fields and collection_name are present, otherwise throw an error.
-                        if (!(fields === null || fields === void 0 ? void 0 : fields.length) || !collection_name) {
-                            throw new Error(_1.ERROR_REASONS.CREATE_COLLECTION_CHECK_PARAMS);
-                        }
-                        // Check if the fields are valid.
-                        (0, utils_1.checkCollectionFields)(fields);
-                        CollectionSchema = this.schemaProto.lookupType('milvus.proto.schema.CollectionSchema');
-                        FieldSchema = this.schemaProto.lookupType('milvus.proto.schema.FieldSchema');
-                        payload = {
-                            name: collection_name,
-                            description: description || '',
-                            fields: fields.map(function (field) {
-                                // Assign the typeParams property to the result of parseToKeyValue(type_params).
-                                var _a = (0, utils_2.assignTypeParams)(field), type_params = _a.type_params, rest = __rest(_a, ["type_params"]);
-                                return FieldSchema.create(__assign(__assign({}, rest), { typeParams: (0, utils_1.parseToKeyValue)(type_params), dataType: field.data_type, isPrimaryKey: field.is_primary_key }));
-                            }),
-                        };
-                        collectionParams = CollectionSchema.create(payload);
-                        schemaBytes = CollectionSchema.encode(collectionParams).finish();
-                        level = (_a = _1.ConsistencyLevelEnum[consistency_level]) !== null && _a !== void 0 ? _a : _1.ConsistencyLevelEnum.Bounded;
-                        return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'CreateCollection', __assign(__assign({}, data), { schema: schemaBytes, consistency_level: level }), data.timeout || this.timeout)];
-                    case 1:
-                        promise = _d.sent();
-                        // Return the promise.
-                        return [2 /*return*/, promise];
-                }
-            });
-        });
-    };
-    /**
-   * 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 |
-   *
-   * @returns
-   *  | Property | Description |
-   *  | :-- | :-- |
-   *  | status | { error_code: number, reason: string } |
-   *  | value | `true` or `false` |
-  
-   *
-   * #### Example
-   *
-   * ```
-   *  new milvusClient(MILUVS_ADDRESS).hasCollection({
-   *     collection_name: 'my_collection',
-   *  });
-   * ```
-   */
-    Collection.prototype.hasCollection = function (data) {
-        return __awaiter(this, void 0, void 0, function () {
-            var promise;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        (0, utils_1.checkCollectionName)(data);
-                        return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'HasCollection', data, data.timeout || this.timeout)];
-                    case 1:
-                        promise = _a.sent();
-                        return [2 /*return*/, promise];
-                }
-            });
-        });
-    };
-    /**
-   * 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 |
-  
-   *
-   * @returns
-   * | Property | Description |
-   *  | :-- | :-- |
-   *  | status | { error_code: number, reason: string } |
-   *  | data |  Contains collection name, ID , timestamp (UTC created time), and loadedPercentage (100 means loaded) |
-   *
-   *
-   * #### Example
-   *
-   * ```
-   *  new milvusClient(MILUVS_ADDRESS).showCollections();
-   * ```
-   */
-    Collection.prototype.showCollections = function (data) {
-        return __awaiter(this, void 0, void 0, function () {
-            var promise, result;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'ShowCollections', {
-                            type: data ? data.type : _1.ShowCollectionsType.All,
-                            collection_names: (data === null || data === void 0 ? void 0 : data.collection_names) || [],
-                        }, (data === null || data === void 0 ? void 0 : data.timeout) || this.timeout)];
-                    case 1:
-                        promise = _a.sent();
-                        result = [];
-                        promise.collection_names.forEach(function (name, index) {
-                            result.push({
-                                name: name,
-                                id: promise.collection_ids[index],
-                                timestamp: promise.created_utc_timestamps[index],
-                                loadedPercentage: promise.inMemory_percentages[index],
-                            });
-                        });
-                        promise.data = result;
-                        return [2 /*return*/, promise];
-                }
-            });
-        });
-    };
-    /**
-     * 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       |
-     *
-     * @returns
-     * | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | schema | Information of all fields in this collection |
-     *  | collectionID  | Collection ID |
-     *
-     *
-     * #### Example
-     *
-     * ```
-     *  new milvusClient(MILUVS_ADDRESS).describeCollection({
-     *    collection_name: 'my_collection',
-     *  });
-     * ```
-     */
-    Collection.prototype.describeCollection = function (data) {
-        return __awaiter(this, void 0, void 0, function () {
-            var promise;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        (0, utils_1.checkCollectionName)(data);
-                        return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'DescribeCollection', data, data.timeout || this.timeout)];
-                    case 1:
-                        promise = _a.sent();
-                        return [2 /*return*/, promise];
-                }
-            });
-        });
-    };
-    /**
-     * 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       |
-     *
-     * @returns
-     * | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | stats | [{key: string, value: string}] |
-     *  | data | Transform **stats** to { row_count: 0 } |
-     *
-     *
-     * #### Example
-     *
-     * ```
-     *  new milvusClient(MILUVS_ADDRESS).getCollectionStatistics({
-     *    collection_name: 'my_collection',
-     *  });
-     * ```
-     */
-    Collection.prototype.getCollectionStatistics = function (data) {
-        return __awaiter(this, void 0, void 0, function () {
-            var promise;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        (0, utils_1.checkCollectionName)(data);
-                        return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'GetCollectionStatistics', data, data.timeout || this.timeout)];
-                    case 1:
-                        promise = _a.sent();
-                        promise.data = (0, utils_1.formatKeyValueData)(promise.stats, ['row_count']);
-                        return [2 /*return*/, promise];
-                }
-            });
-        });
-    };
-    /**
-     * Load collection data into query nodes, then you can do vector search on this collection.
-     * 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 | 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
-     *
-     * ```
-     *  new milvusClient(MILUVS_ADDRESS).loadCollection({
-     *    collection_name: 'my_collection',
-     *  });
-     * ```
-     */
-    Collection.prototype.loadCollection = function (data) {
-        return __awaiter(this, void 0, void 0, function () {
-            var promise;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        (0, utils_1.checkCollectionName)(data);
-                        return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'LoadCollection', data, data.timeout || this.timeout)];
-                    case 1:
-                        promise = _a.sent();
-                        return [2 /*return*/, promise];
-                }
-            });
-        });
-    };
-    /**
-     * Same function with loadCollection, but it's sync function.
-     * Help to ensure this collection is loaded.
-     *
-     * @param data
-     *  | 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
-     *
-     * ```
-     *  new milvusClient(MILUVS_ADDRESS).loadCollectionSync({
-     *    collection_name: 'my_collection',
-     *  });
-     * ```
-     */
-    Collection.prototype.loadCollectionSync = function (data) {
-        return __awaiter(this, void 0, void 0, function () {
-            var promise, loadedPercentage, res;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        (0, utils_1.checkCollectionName)(data);
-                        return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'LoadCollection', data, data.timeout || this.timeout)];
-                    case 1:
-                        promise = _a.sent();
-                        if (promise.error_code !== _1.ErrorCode.SUCCESS) {
-                            throw new Error("ErrorCode: ".concat(promise.error_code, ". Reason: ").concat(promise.reason));
-                        }
-                        loadedPercentage = 0;
-                        _a.label = 2;
-                    case 2:
-                        if (!(Number(loadedPercentage) < 100)) return [3 /*break*/, 5];
-                        return [4 /*yield*/, this.getLoadingProgress({
-                                collection_name: data.collection_name,
-                            })];
-                    case 3:
-                        res = _a.sent();
-                        if (res.status.error_code !== _1.ErrorCode.SUCCESS) {
-                            throw new Error("ErrorCode: ".concat(res.status.error_code, ". Reason: ").concat(res.status.reason));
-                        }
-                        loadedPercentage = Number(res.progress);
-                        // sleep 400ms
-                        return [4 /*yield*/, (0, utils_1.sleep)(400)];
-                    case 4:
-                        // sleep 400ms
-                        _a.sent();
-                        return [3 /*break*/, 2];
-                    case 5: return [2 /*return*/, promise];
-                }
-            });
-        });
-    };
-    /**
-     * Release a collection from cache to reduce cache usage.
-     * 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       |
-     *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | error_code | Error code number |
-     *  | reason | Error cause |
-     *
-     * #### Example
-     *
-     * ```
-     *  new milvusClient(MILUVS_ADDRESS).releaseCollection({
-     *    collection_name: 'my_collection',
-     *  });
-     * ```
-     */
-    Collection.prototype.releaseCollection = function (data) {
-        return __awaiter(this, void 0, void 0, function () {
-            var promise;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        (0, utils_1.checkCollectionName)(data);
-                        return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'ReleaseCollection', data, data.timeout || this.timeout)];
-                    case 1:
-                        promise = _a.sent();
-                        return [2 /*return*/, promise];
-                }
-            });
-        });
-    };
-    /**
-     * 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).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 || this.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. |
-     *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | error_code | Error code number |
-     *  | reason | Error cause |
-     *
-     * #### Example
-     *
-     * ```
-     *  new milvusClient(MILUVS_ADDRESS).dropCollection({
-     *    collection_name: 'my_collection',
-     *  });
-     * ```
-     */
-    Collection.prototype.dropCollection = function (data) {
-        return __awaiter(this, void 0, void 0, function () {
-            var promise;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        (0, utils_1.checkCollectionName)(data);
-                        return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'DropCollection', data, data.timeout || this.timeout)];
-                    case 1:
-                        promise = _a.sent();
-                        return [2 /*return*/, promise];
-                }
-            });
-        });
-    };
-    /**
-     * 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).createAlias({
-     *    alias: 'my_collection_alis',
-     *    collection_name: 'my_collection',
-     *  });
-     * ```
-     */
-    Collection.prototype.createAlias = function (data) {
-        return __awaiter(this, void 0, void 0, function () {
-            var promise;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        (0, utils_1.checkCollectionName)(data);
-                        if (!data.alias) {
-                            throw new Error(_1.ERROR_REASONS.ALIAS_NAME_IS_REQUIRED);
-                        }
-                        return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'CreateAlias', data, data.timeout || this.timeout)];
-                    case 1:
-                        promise = _a.sent();
-                        return [2 /*return*/, promise];
-                }
-            });
-        });
-    };
-    /**
-     * 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).dropAlias({
-     *    alias: 'my_collection_alis',
-     *    collection_name: 'my_collection',
-     *  });
-     * ```
-     */
-    Collection.prototype.dropAlias = function (data) {
-        return __awaiter(this, void 0, void 0, function () {
-            var promise;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (!data.alias) {
-                            throw new Error(_1.ERROR_REASONS.ALIAS_NAME_IS_REQUIRED);
-                        }
-                        return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'DropAlias', data, data.timeout || this.timeout)];
-                    case 1:
-                        promise = _a.sent();
-                        return [2 /*return*/, promise];
-                }
-            });
-        });
-    };
-    /**
-     * 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).alterAlais({
-     *    alias: 'my_collection_alis',
-     *    collection_name: 'my_collection',
-     *  });
-     * ```
-     */
-    Collection.prototype.alterAlias = function (data) {
-        return __awaiter(this, void 0, void 0, function () {
-            var promise;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        (0, utils_1.checkCollectionName)(data);
-                        if (!data.alias) {
-                            throw new Error(_1.ERROR_REASONS.ALIAS_NAME_IS_REQUIRED);
-                        }
-                        return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'AlterAlias', data, data.timeout || this.timeout)];
-                    case 1:
-                        promise = _a.sent();
-                        return [2 /*return*/, promise];
-                }
-            });
-        });
-    };
-    /**
-     * 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 |
-     *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | compactionID | compaction ID |
-     *
-     * #### Example
-     *
-     * ```
-     *  new milvusClient(MILUVS_ADDRESS).compact({
-     *    collection_name: 'my_collection',
-     *  });
-     * ```
-     */
-    Collection.prototype.compact = function (data) {
-        return __awaiter(this, void 0, void 0, function () {
-            var collectionInfo, res;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        (0, utils_1.checkCollectionName)(data);
-                        return [4 /*yield*/, this.describeCollection(data)];
-                    case 1:
-                        collectionInfo = _a.sent();
-                        return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'ManualCompaction', {
-                                collectionID: collectionInfo.collectionID,
-                            }, data.timeout || this.timeout)];
-                    case 2:
-                        res = _a.sent();
-                        return [2 /*return*/, res];
-                }
-            });
-        });
-    };
-    /**
-     * 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       |
-     *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | state | the state of the compaction |
-     *
-     * #### Example
-     *
-     * ```
-     *  new milvusClient(MILUVS_ADDRESS).getCompactionState({
-     *    compactionID: compactionID,
-     *  });
-     * ```
-     */
-    Collection.prototype.getCompactionState = function (data) {
-        return __awaiter(this, void 0, void 0, function () {
-            var res;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (!data || !data.compactionID) {
-                            throw new Error(_1.ERROR_REASONS.COMPACTIONID_IS_REQUIRED);
-                        }
-                        return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'GetCompactionState', data, data.timeout || this.timeout)];
-                    case 1:
-                        res = _a.sent();
-                        return [2 /*return*/, res];
-                }
-            });
-        });
-    };
-    /**
-     * 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 |
-     *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | state | the state of the compaction |
-     *
-     * #### Example
-     *
-     * ```
-     *  new milvusClient(MILUVS_ADDRESS).getCompactionStateWithPlans({
-     *    compactionID: compactionID,
-     *  });
-     * ```
-     */
-    Collection.prototype.getCompactionStateWithPlans = function (data) {
-        return __awaiter(this, void 0, void 0, function () {
-            var res;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (!data || !data.compactionID) {
-                            throw new Error(_1.ERROR_REASONS.COMPACTIONID_IS_REQUIRED);
-                        }
-                        return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'GetCompactionStateWithPlans', data, data.timeout || this.timeout)];
-                    case 1:
-                        res = _a.sent();
-                        return [2 /*return*/, res];
-                }
-            });
-        });
-    };
-    /**
-     * 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 |
-     *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | ReplicaInfo[] | replica info array |
-     *
-     * #### Example
-     *
-     * ```
-     *  new milvusClient(MILUVS_ADDRESS).getReplicas({
-     *    collectionID: collectionID,
-     *  });
-     *
-     * ```
-     *
-     * Return
-     * ```
-     * {
-     *  replicas: [
-     *     {
-     *      partition_ids: [Array],
-     *      shard_replicas: [Array],
-     *      node_ids: [Array],
-     *      replicaID: '436724291187770258',
-     *      collectionID: '436777253933154305'
-     *    }
-     *  ],
-     *  status: { error_code: 'Success', reason: '' }
-     * }
-     * ```
-     */
-    Collection.prototype.getReplicas = function (data) {
-        return __awaiter(this, void 0, void 0, function () {
-            var res;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (!data || !data.collectionID) {
-                            throw new Error(_1.ERROR_REASONS.COLLECTION_ID_IS_REQUIRED);
-                        }
-                        return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'GetReplicas', data, data.timeout || this.timeout)];
-                    case 1:
-                        res = _a.sent();
-                        return [2 /*return*/, res];
-                }
-            });
-        });
-    };
-    /**
-     * Get loading progress of a collection
-     *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | collection_name | string | the name of the collection |
-     *  | 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 } |
-     *  | total_row_num | the total number of rows in the collection |
-     *  | total_loaded_row_num | the total number of loaded rows in the collection |
-     *
-     * @throws {Error} if `collection_name` property is not present in `data`
-     *
-     * #### Example
-     *
-     * ```
-     *  new milvusClient(MILUVS_ADDRESS).getLoadingProgress({
-     *    collection_name: 'my_collection',
-     *  });
-     * ```
-     */
-    Collection.prototype.getLoadingProgress = function (data) {
-        return __awaiter(this, void 0, void 0, function () {
-            var res;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (!data || !data.collection_name) {
-                            throw new Error(_1.ERROR_REASONS.COLLECTION_NAME_IS_REQUIRED);
-                        }
-                        return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'GetLoadingProgress', data, data.timeout || this.timeout)];
-                    case 1:
-                        res = _a.sent();
-                        return [2 /*return*/, res];
-                }
-            });
-        });
-    };
-    /**
-     * Get the loading state of a collection
-     *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | collection_name | string | the name of the collection |
-     *  | timeout? | number | An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or an error occurs. Default is undefined |
-     *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | state | the loading state of the collection |
-     *
-     * @throws {Error} if `collection_name` property is not present in `data`
-     *
-     * #### Example
-     *
-     * ```
-     *  new milvusClient(MILUVS_ADDRESS).getLoadState({
-     *    collection_name: 'my_collection',
-     *  });
-     * ```
-     */
-    Collection.prototype.getLoadState = function (data) {
-        return __awaiter(this, void 0, void 0, function () {
-            var res;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (!data || !data.collection_name) {
-                            throw new Error(_1.ERROR_REASONS.COLLECTION_NAME_IS_REQUIRED);
-                        }
-                        return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'GetLoadState', data, data.timeout || this.timeout)];
-                    case 1:
-                        res = _a.sent();
-                        return [2 /*return*/, res];
-                }
-            });
-        });
-    };
-    return Collection;
-}(BaseClient_1.BaseClient));
-exports.Collection = Collection;
-//# sourceMappingURL=Collection.js.map