@zilliz/milvus2-sdk-node 2.2.9 → 2.2.11

package/dist/milvus/grpc/Collection.js

@@ -0,0 +1,786 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Collection = void 0;
+const Database_1 = require("./Database");
+const __1 = require("../");
+/**
+ * @see [collection operation examples](https://github.com/milvus-io/milvus-sdk-node/blob/main/example/Collection.ts)
+ */
+class Collection extends Database_1.Database {
+    constructor() {
+        super(...arguments);
+        // alias
+        this.list_collections = this.showCollections;
+        // alias
+        this.drop_collection = this.dropCollection;
+        // alias
+        this.listCollections = this.showCollections;
+    }
+    /**
+     * Create a collection in Milvus.
+     *
+     * @param data
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | collection_name | String | Collection name |
+     *  | description | String | Collection description |
+     *  | num_partitions | number | number of partitions allowed |
+     *  | 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: "",
+     *      },
+     *  ],
+     *  });
+     * ```
+     */
+    createCollection(data) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            // Destructure the data object and set default values for consistency_level and description.
+            const { fields, collection_name, consistency_level = 'Bounded', num_partitions, } = data || {};
+            // 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, __1.checkCollectionFields)(fields);
+            // if num_partitions is set, validate it
+            if (typeof num_partitions !== 'undefined') {
+                (0, __1.validatePartitionNumbers)(num_partitions);
+            }
+            // Create the payload object with the collection_name, description, and fields.
+            // it should follow CollectionSchema in schema.proto
+            const payload = (0, __1.formatCollectionSchema)(data, this.fieldSchemaType);
+            // Create the collectionParams object from the payload.
+            const collectionParams = this.collectionSchemaType.create(payload);
+            // Encode the collectionParams object to bytes.
+            const schemaBytes = this.collectionSchemaType
+                .encode(collectionParams)
+                .finish();
+            // Get the consistency level value from the ConsistencyLevelEnum object.
+            const level = (_a = __1.ConsistencyLevelEnum[consistency_level]) !== null && _a !== void 0 ? _a : __1.ConsistencyLevelEnum.Bounded;
+            // Call the promisify function to create the collection.
+            const createPromise = yield (0, __1.promisify)(this.client, 'CreateCollection', Object.assign(Object.assign({}, data), { schema: schemaBytes, consistency_level: level }), data.timeout || this.timeout);
+            // load index
+            // Return the promise.
+            return createPromise;
+        });
+    }
+    /**
+   * 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',
+   *  });
+   * ```
+   */
+    hasCollection(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            (0, __1.checkCollectionName)(data);
+            const promise = yield (0, __1.promisify)(this.client, 'HasCollection', data, data.timeout || this.timeout);
+            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();
+   * ```
+   */
+    showCollections(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const promise = yield (0, __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);
+            const result = [];
+            promise.collection_names.forEach((name, index) => {
+                result.push({
+                    name,
+                    id: promise.collection_ids[index],
+                    timestamp: promise.created_utc_timestamps[index],
+                    loadedPercentage: promise.inMemory_percentages[index],
+                });
+            });
+            promise.data = result;
+            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',
+     *  });
+     * ```
+     */
+    describeCollection(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            (0, __1.checkCollectionName)(data);
+            const promise = yield (0, __1.promisify)(this.client, 'DescribeCollection', data, data.timeout || this.timeout);
+            return (0, __1.formatDescribedCol)(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',
+     *  });
+     * ```
+     */
+    getCollectionStatistics(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            (0, __1.checkCollectionName)(data);
+            const promise = yield (0, __1.promisify)(this.client, 'GetCollectionStatistics', data, data.timeout || this.timeout);
+            promise.data = (0, __1.formatKeyValueData)(promise.stats, ['row_count']);
+            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',
+     *  });
+     * ```
+     */
+    loadCollection(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            (0, __1.checkCollectionName)(data);
+            const promise = yield (0, __1.promisify)(this.client, 'LoadCollection', data, data.timeout || this.timeout);
+            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',
+     *  });
+     * ```
+     */
+    loadCollectionSync(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            (0, __1.checkCollectionName)(data);
+            const promise = yield (0, __1.promisify)(this.client, 'LoadCollection', data, data.timeout || this.timeout);
+            if (promise.error_code !== __1.ErrorCode.SUCCESS) {
+                throw new Error(`ErrorCode: ${promise.error_code}. Reason: ${promise.reason}`);
+            }
+            let loadedPercentage = 0;
+            while (Number(loadedPercentage) < 100) {
+                let res = yield this.getLoadingProgress({
+                    collection_name: data.collection_name,
+                });
+                if (res.status.error_code !== __1.ErrorCode.SUCCESS) {
+                    throw new Error(`ErrorCode: ${res.status.error_code}. Reason: ${res.status.reason}`);
+                }
+                loadedPercentage = Number(res.progress);
+                // sleep 400ms
+                yield (0, __1.sleep)(400);
+            }
+            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',
+     *  });
+     * ```
+     */
+    releaseCollection(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            (0, __1.checkCollectionName)(data);
+            const promise = yield (0, __1.promisify)(this.client, 'ReleaseCollection', data, data.timeout || this.timeout);
+            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'
+     *  });
+     * ```
+     */
+    renameCollection(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const promise = yield (0, __1.promisify)(this.client, 'RenameCollection', {
+                oldName: data.collection_name,
+                newName: data.new_collection_name,
+            }, data.timeout || this.timeout);
+            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',
+     *  });
+     * ```
+     */
+    dropCollection(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            (0, __1.checkCollectionName)(data);
+            const promise = yield (0, __1.promisify)(this.client, 'DropCollection', data, data.timeout || this.timeout);
+            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',
+     *  });
+     * ```
+     */
+    createAlias(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            (0, __1.checkCollectionName)(data);
+            if (!data.alias) {
+                throw new Error(__1.ERROR_REASONS.ALIAS_NAME_IS_REQUIRED);
+            }
+            const promise = yield (0, __1.promisify)(this.client, 'CreateAlias', data, data.timeout || this.timeout);
+            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',
+     *  });
+     * ```
+     */
+    dropAlias(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!data.alias) {
+                throw new Error(__1.ERROR_REASONS.ALIAS_NAME_IS_REQUIRED);
+            }
+            const promise = yield (0, __1.promisify)(this.client, 'DropAlias', data, data.timeout || this.timeout);
+            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',
+     *  });
+     * ```
+     */
+    alterAlias(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            (0, __1.checkCollectionName)(data);
+            if (!data.alias) {
+                throw new Error(__1.ERROR_REASONS.ALIAS_NAME_IS_REQUIRED);
+            }
+            const promise = yield (0, __1.promisify)(this.client, 'AlterAlias', data, data.timeout || this.timeout);
+            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',
+     *  });
+     * ```
+     */
+    compact(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            (0, __1.checkCollectionName)(data);
+            const collectionInfo = yield this.describeCollection(data);
+            const res = yield (0, __1.promisify)(this.client, 'ManualCompaction', {
+                collectionID: collectionInfo.collectionID,
+            }, data.timeout || this.timeout);
+            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,
+     *  });
+     * ```
+     */
+    getCompactionState(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!data || !data.compactionID) {
+                throw new Error(__1.ERROR_REASONS.COMPACTION_ID_IS_REQUIRED);
+            }
+            const res = yield (0, __1.promisify)(this.client, 'GetCompactionState', data, data.timeout || this.timeout);
+            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,
+     *  });
+     * ```
+     */
+    getCompactionStateWithPlans(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!data || !data.compactionID) {
+                throw new Error(__1.ERROR_REASONS.COMPACTION_ID_IS_REQUIRED);
+            }
+            const res = yield (0, __1.promisify)(this.client, 'GetCompactionStateWithPlans', data, data.timeout || this.timeout);
+            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: '' }
+     * }
+     * ```
+     */
+    getReplicas(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!data || !data.collectionID) {
+                throw new Error(__1.ERROR_REASONS.COLLECTION_ID_IS_REQUIRED);
+            }
+            const res = yield (0, __1.promisify)(this.client, 'GetReplicas', data, data.timeout || this.timeout);
+            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',
+     *  });
+     * ```
+     */
+    getLoadingProgress(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!data || !data.collection_name) {
+                throw new Error(__1.ERROR_REASONS.COLLECTION_NAME_IS_REQUIRED);
+            }
+            const res = yield (0, __1.promisify)(this.client, 'GetLoadingProgress', data, data.timeout || this.timeout);
+            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',
+     *  });
+     * ```
+     */
+    getLoadState(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!data || !data.collection_name) {
+                throw new Error(__1.ERROR_REASONS.COLLECTION_NAME_IS_REQUIRED);
+            }
+            const res = yield (0, __1.promisify)(this.client, 'GetLoadState', data, data.timeout || this.timeout);
+            return res;
+        });
+    }
+    /**
+     * Get the primary key field name
+     *
+     * @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 |
+     *  | :-- | :-- |
+     *  | pkfield | the primary key field name |
+     *
+     * @throws {Error} if `collection_name` property is not present in `data`
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).getPkFieldName({
+     *    collection_name: 'my_collection',
+     *  });
+     * ```
+     */
+    getPkFieldName(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // get collection info
+            const collectionInfo = yield this.describeCollection(data);
+            // pk field
+            let pkField = '';
+            // extract key information
+            for (let i = 0; i < collectionInfo.schema.fields.length; i++) {
+                const f = collectionInfo.schema.fields[i];
+                // get pk field info
+                if (f.is_primary_key) {
+                    pkField = f.name;
+                    break;
+                }
+            }
+            return pkField;
+        });
+    }
+}
+exports.Collection = Collection;
+//# sourceMappingURL=Collection.js.map