@zilliz/milvus2-sdk-node 2.3.5 → 2.4.0

package/dist/milvus/grpc/MilvusIndex.d.ts

@@ -1,23 +1,18 @@
 import { Data } from './Data';
-import { CreateIndexReq, DescribeIndexReq, DropIndexReq, GetIndexBuildProgressReq, GetIndexStateReq, ResStatus, DescribeIndexResponse, GetIndexStateResponse, GetIndexBuildProgressResponse, CreateIndexSimpleReq } from '../';
+import { DescribeIndexReq, DropIndexReq, CreateIndexesReq, CreateIndexRequest, GetIndexBuildProgressReq, GetIndexStateReq, AlterIndexReq, ResStatus, DescribeIndexResponse, GetIndexStateResponse, ListIndexResponse, GetIndexBuildProgressResponse } from '../';
 export declare class Index extends Data {
     /**
-     * Create an index on a vector field. Note that index building is an async progress.
-     *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | collection_name | String | Collection name |
-     *  | field_name | String | Field name |
-     *  | index_name | String | Index name is unique in one collection |
-     *  | extra_params | Object | Parameters: { index_type: string; metric_type: string; params: string; }; |
-     *  | 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 |
+     * Asynchronously creates an index on a field. Note that index building is an asynchronous process.
+     *
+     * @param {CreateIndexesReq | CreateIndexesReq[]} data - The data for creating the index. Can be an object or an array of objects.
+     * @param {string} data.collection_name - The name of the collection.
+     * @param {string} data.field_name - The name of the field.
+     * @param {string} data.index_name - The name of the index. It must be unique within a collection.
+     * @param {string} data.index_type - The type of the index.
+     * @param {string} data.metric_type - The type of the metric.
+     * @param {Object} data.params - The parameters for the index. For example, `{ nlist: number }`.
+     * @param {number} [data.timeout] - 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 {Promise<ResStatus>} - A promise that resolves to a response status object.
      *
      * @example
      * ```
@@ -32,23 +27,48 @@ export declare class Index extends Data {
      * };
      * const res = await milvusClient.createIndex(createIndexReq);
      * console.log(res);
+     *
+     * // or
+     * const createIndexesReq = [
+     * {
+     *   collection_name: 'my_collection',
+     *   field_name: 'vector_01',
+     *   index_name: 'my_index',
+     *   index_type: 'IVF_FLAT',
+     *   metric_type: 'IP',
+     *   params: { nlist: 10 },
+     * },
+     * {
+     *   collection_name: 'my_collection',
+     *   field_name: 'int16',
+     *   index_name: 'number_index',
+     *   index_type: 'STL_SORT',
+     * },
+     * {
+     *   collection_name: 'my_collection',
+     *   field_name: 'varChar',
+     *   index_name: 'varchar_index',
+     *   index_type: 'TRIE',
+     * },
+     * ];
+     * const res = await milvusClient.createIndex(createIndexReq);
+     * console.log(res);
      * ```
      */
-    createIndex(data: CreateIndexReq | CreateIndexSimpleReq): Promise<ResStatus>;
+    createIndex(data: CreateIndexesReq): Promise<ResStatus>;
+    _createIndex(data: CreateIndexRequest): Promise<ResStatus>;
     /**
-     * Show index information. Current release of Milvus only supports showing latest built index.
+     * Displays index information. The current release of Milvus only supports displaying the most recently built index.
      *
-     * @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 |
+     * @param {Object} data - An object with the following properties:
+     * @param {string} data.collection_name - The name of the collection.
+     * @param {string} [data.field_name] - The name of the field (optional).
+     * @param {string} [data.index_name] - The name of the index (optional).
+     * @param {number} [data.timeout] - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client will continue to wait until the server responds or an error occurs. The default is undefined.
      *
-     * @returns
-     *  | Property      | Description |
-     *  | :-- | :-- |
-     *  | status        |  { error_code: number, reason: string } |
-     *  | index_descriptions        | Index information |
+     * @returns {Promise<DescribeIndexResponse>} A Promise that resolves to an object with the following properties:
+     * @returns {Object} return.status - An object with properties 'error_code' (number) and 'reason' (string).
+     * @returns {Array<Object>} return.index_descriptions - Information about the index.
      *
      * @example
      * ```
@@ -61,26 +81,48 @@ export declare class Index extends Data {
      * ```
      */
     describeIndex(data: DescribeIndexReq): Promise<DescribeIndexResponse>;
+    /**
+     * Retrieves a list of index names for a given collection. The current release of Milvus only supports listing indexes for the most recently built index.
+     *
+     * @param {Object} data - An object with the following properties:
+     * @param {string} data.collection_name - The name of the collection.
+     * @param {string} [data.field_name] - The name of the field (optional).
+     * @param {string} [data.index_name] - The name of the index (optional).
+     * @param {number} [data.timeout] - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client will continue to wait until the server responds or an error occurs. The default is undefined.
+     *
+     * @returns {Promise<ListIndexResponse>} A Promise that resolves to an array of strings representing the names of indexes associated with the specified collection.
+     * @returns {Object} return.status - An object with properties 'error_code' (number) and 'reason' (string).
+     * @returns {Array<string>} return.string - index names
+     *
+     * @example
+     * ```
+     * const milvusClient = new MilvusClient(MILUVS_ADDRESS);
+     * const listIndexReq = {
+     *   collection_name: 'my_collection',
+     * };
+     * const indexNames = await milvusClient.listIndex(listIndexReq);
+     * console.log(indexNames);
+     * ```
+     */
+    listIndexes(data: DescribeIndexReq): Promise<ListIndexResponse>;
     /**
      * Get the index building state.
      *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | collection_name | string | Collection name |
-     *  | 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 |
+     * @param {Object} data - An object with the following properties:
+     * @param {string} data.collection_name - The name of the collection for which the index state is to be retrieved.
+     * @param {string} [data.field_name] - The name of the field for which the index state is to be retrieved.
+     * @param {string} [data.index_name] - The name of the index for which the state is to be retrieved.
      *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | state | Index building state |
+     * @returns {Promise<GetIndexStateResponse>} A Promise that resolves to an object with the following properties:
+     * @returns {Object} return.status - An object with properties 'error_code' (number) and 'reason' (string) indicating the status of the request.
+     * @returns {string} return.state - The state of the index building process.
      *
      * @example
      * ```
      * const milvusClient = new MilvusClient(MILUVS_ADDRESS);
      * const getIndexStateReq = {
      *   collection_name: 'my_collection',
+     *   index_name: 'my_index',
      * };
      * const res = await milvusClient.getIndexState(getIndexStateReq);
      * console.log(res);
@@ -88,28 +130,25 @@ export declare class Index extends Data {
      */
     getIndexState(data: GetIndexStateReq): Promise<GetIndexStateResponse>;
     /**
-     * Show index building progress.
-     *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | collection_name | String | Collection name |
-     *  | field_name | String | Field 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 } |
-     *  | indexed_rows | Row count that successfully built with index |
-     *  | total_rows | Total row count |
+     * Get index building progress.
+     *
+     * @param {Object} data - The data for retrieving the index building progress.
+     * @param {string} data.collection_name - The name of the collection.
+     * @param {string} [data.field_name] - The name of the field for which the index building progress is to be retrieved.
+     * @param {string} [data.index_name] - The name of the index for which the building progress is to be retrieved.
+     * @param {number} [data.timeout] - 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 error occurs. Default is undefined.
+     *
+     * @returns {Promise<Object>} A promise that resolves to an object with properties 'status', 'indexed_rows', and 'total_rows'.
+     * @returns {Object} return.status - An object with properties 'error_code' (number) and 'reason' (string) indicating the status of the request.
+     * @returns {number} return.indexed_rows - The number of rows that have been successfully indexed.
+     * @returns {number} return.total_rows - The total number of rows.
      *
      * @example
      * ```
      * const milvusClient = new MilvusClient(MILUVS_ADDRESS);
      * const getIndexBuildProgressReq = {
      *   collection_name: 'my_collection',
-     *   field_name: 'my_field',
+     *   index_name: 'my_index',
      * };
      * const res = await milvusClient.getIndexBuildProgress(getIndexBuildProgressReq);
      * console.log(res);
@@ -119,29 +158,50 @@ export declare class Index extends Data {
     /**
      * Drop an index.
      *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | collection_name | String | Collection name |
-     *  | field_name | String | Field 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 |
+     * @param {Object} data - The data for dropping the index.
+     * @param {string} data.collection_name - The name of the collection.
+     * @param {string} [data.field_name] - The name of the field for which the index is to be dropped.
+     * @param {string} [data.index_name] - The name of the index to be dropped.
+     * @param {number} [data.timeout] - 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 error occurs. Default is undefined.
      *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | error_code | Error code number |
-     *  | reason | Error cause |
+     * @returns {Promise<Object>} A promise that resolves to an object with properties 'error_code' and 'reason'.
+     * @returns {number} return.error_code - The error code number.
+     * @returns {string} return.reason - The cause of the error.
      *
      * @example
      * ```
      * const milvusClient = new MilvusClient(MILUVS_ADDRESS);
      * const dropIndexReq = {
      *   collection_name: 'my_collection',
-     *   field_name: 'my_field',
+     *   index_name: 'my_index',
      * };
      * const res = await milvusClient.dropIndex(dropIndexReq);
      * console.log(res);
      * ```
      */
     dropIndex(data: DropIndexReq): Promise<ResStatus>;
+    /**
+     * Alters an existing index.
+     *
+     * @param {Object} data - The data for altering the index.
+     * @param {string} data.collection_name - The name of the collection.
+     * @param {Object} data.params - The new parameters for the index. For example, `{ nlist: number }`.
+     * @param {number} [data.timeout] - 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 {Promise<ResStatus>} - A promise that resolves to a response status object.
+     * @returns {number} return.error_code - The error code number.
+     * @returns {string} return.reason - The cause of the error.
+     *
+     * @example
+     * ```
+     * const milvusClient = new MilvusClient(MILUVS_ADDRESS);
+     * const alterIndexReq = {
+     *   collection_name: 'my_collection',
+     *   params: { nlist: 20 },
+     * };
+     * const res = await milvusClient.alterIndex(alterIndexReq);
+     * console.log(res);
+     * ```
+     */
+    alterIndex(data: AlterIndexReq): Promise<ResStatus>;
 }

package/dist/milvus/grpc/MilvusIndex.js

@@ -14,22 +14,17 @@ const Data_1 = require("./Data");
 const __1 = require("../");
 class Index extends Data_1.Data {
     /**
-     * Create an index on a vector field. Note that index building is an async progress.
-     *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | collection_name | String | Collection name |
-     *  | field_name | String | Field name |
-     *  | index_name | String | Index name is unique in one collection |
-     *  | extra_params | Object | Parameters: { index_type: string; metric_type: string; params: string; }; |
-     *  | 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 |
+     * Asynchronously creates an index on a field. Note that index building is an asynchronous process.
+     *
+     * @param {CreateIndexesReq | CreateIndexesReq[]} data - The data for creating the index. Can be an object or an array of objects.
+     * @param {string} data.collection_name - The name of the collection.
+     * @param {string} data.field_name - The name of the field.
+     * @param {string} data.index_name - The name of the index. It must be unique within a collection.
+     * @param {string} data.index_type - The type of the index.
+     * @param {string} data.metric_type - The type of the metric.
+     * @param {Object} data.params - The parameters for the index. For example, `{ nlist: number }`.
+     * @param {number} [data.timeout] - 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 {Promise<ResStatus>} - A promise that resolves to a response status object.
      *
      * @example
      * ```
@@ -44,9 +39,51 @@ class Index extends Data_1.Data {
      * };
      * const res = await milvusClient.createIndex(createIndexReq);
      * console.log(res);
+     *
+     * // or
+     * const createIndexesReq = [
+     * {
+     *   collection_name: 'my_collection',
+     *   field_name: 'vector_01',
+     *   index_name: 'my_index',
+     *   index_type: 'IVF_FLAT',
+     *   metric_type: 'IP',
+     *   params: { nlist: 10 },
+     * },
+     * {
+     *   collection_name: 'my_collection',
+     *   field_name: 'int16',
+     *   index_name: 'number_index',
+     *   index_type: 'STL_SORT',
+     * },
+     * {
+     *   collection_name: 'my_collection',
+     *   field_name: 'varChar',
+     *   index_name: 'varchar_index',
+     *   index_type: 'TRIE',
+     * },
+     * ];
+     * const res = await milvusClient.createIndex(createIndexReq);
+     * console.log(res);
      * ```
      */
     createIndex(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (Array.isArray(data)) {
+                return yield Promise.all(data.map(item => this._createIndex(item))).then((responses) => {
+                    if (responses.every(r => r.error_code === __1.ErrorCode.SUCCESS)) {
+                        return responses[0];
+                    }
+                    else {
+                        return responses.find(r => r.error_code !== __1.ErrorCode.SUCCESS);
+                    }
+                });
+            }
+            return yield this._createIndex(data);
+        });
+    }
+    // private create index
+    _createIndex(data) {
         return __awaiter(this, void 0, void 0, function* () {
             (0, __1.checkCollectionName)(data);
             // build extra_params object
@@ -70,24 +107,22 @@ class Index extends Data_1.Data {
                 createIndexParams.extra_params = (0, __1.parseToKeyValue)(extra_params);
             }
             // Call the 'CreateIndex' gRPC method and return the result
-            const promise = yield (0, __1.promisify)(this.client, 'CreateIndex', createIndexParams, data.timeout || this.timeout);
+            const promise = yield (0, __1.promisify)(this.channelPool, 'CreateIndex', createIndexParams, data.timeout || this.timeout);
             return promise;
         });
     }
     /**
-     * Show index information. Current release of Milvus only supports showing latest built index.
+     * Displays index information. The current release of Milvus only supports displaying the most recently built index.
      *
-     * @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 |
+     * @param {Object} data - An object with the following properties:
+     * @param {string} data.collection_name - The name of the collection.
+     * @param {string} [data.field_name] - The name of the field (optional).
+     * @param {string} [data.index_name] - The name of the index (optional).
+     * @param {number} [data.timeout] - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client will continue to wait until the server responds or an error occurs. The default is undefined.
      *
-     * @returns
-     *  | Property      | Description |
-     *  | :-- | :-- |
-     *  | status        |  { error_code: number, reason: string } |
-     *  | index_descriptions        | Index information |
+     * @returns {Promise<DescribeIndexResponse>} A Promise that resolves to an object with the following properties:
+     * @returns {Object} return.status - An object with properties 'error_code' (number) and 'reason' (string).
+     * @returns {Array<Object>} return.index_descriptions - Information about the index.
      *
      * @example
      * ```
@@ -102,30 +137,63 @@ class Index extends Data_1.Data {
     describeIndex(data) {
         return __awaiter(this, void 0, void 0, function* () {
             (0, __1.checkCollectionName)(data);
-            const promise = yield (0, __1.promisify)(this.client, 'DescribeIndex', data, data.timeout || this.timeout);
+            const promise = yield (0, __1.promisify)(this.channelPool, 'DescribeIndex', data, data.timeout || this.timeout);
             return promise;
         });
     }
+    /**
+     * Retrieves a list of index names for a given collection. The current release of Milvus only supports listing indexes for the most recently built index.
+     *
+     * @param {Object} data - An object with the following properties:
+     * @param {string} data.collection_name - The name of the collection.
+     * @param {string} [data.field_name] - The name of the field (optional).
+     * @param {string} [data.index_name] - The name of the index (optional).
+     * @param {number} [data.timeout] - An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client will continue to wait until the server responds or an error occurs. The default is undefined.
+     *
+     * @returns {Promise<ListIndexResponse>} A Promise that resolves to an array of strings representing the names of indexes associated with the specified collection.
+     * @returns {Object} return.status - An object with properties 'error_code' (number) and 'reason' (string).
+     * @returns {Array<string>} return.string - index names
+     *
+     * @example
+     * ```
+     * const milvusClient = new MilvusClient(MILUVS_ADDRESS);
+     * const listIndexReq = {
+     *   collection_name: 'my_collection',
+     * };
+     * const indexNames = await milvusClient.listIndex(listIndexReq);
+     * console.log(indexNames);
+     * ```
+     */
+    listIndexes(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const describeIndexRes = this.describeIndex(data);
+            const indexes = (yield describeIndexRes).index_descriptions.map(index => {
+                return index.index_name;
+            });
+            return {
+                status: (yield describeIndexRes).status,
+                indexes: indexes,
+            };
+        });
+    }
     /**
      * Get the index building state.
      *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | collection_name | string | Collection name |
-     *  | 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 |
+     * @param {Object} data - An object with the following properties:
+     * @param {string} data.collection_name - The name of the collection for which the index state is to be retrieved.
+     * @param {string} [data.field_name] - The name of the field for which the index state is to be retrieved.
+     * @param {string} [data.index_name] - The name of the index for which the state is to be retrieved.
      *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | state | Index building state |
+     * @returns {Promise<GetIndexStateResponse>} A Promise that resolves to an object with the following properties:
+     * @returns {Object} return.status - An object with properties 'error_code' (number) and 'reason' (string) indicating the status of the request.
+     * @returns {string} return.state - The state of the index building process.
      *
      * @example
      * ```
      * const milvusClient = new MilvusClient(MILUVS_ADDRESS);
      * const getIndexStateReq = {
      *   collection_name: 'my_collection',
+     *   index_name: 'my_index',
      * };
      * const res = await milvusClient.getIndexState(getIndexStateReq);
      * console.log(res);
@@ -134,33 +202,30 @@ class Index extends Data_1.Data {
     getIndexState(data) {
         return __awaiter(this, void 0, void 0, function* () {
             (0, __1.checkCollectionName)(data);
-            const promise = yield (0, __1.promisify)(this.client, 'GetIndexState', data, data.timeout || this.timeout);
+            const promise = yield (0, __1.promisify)(this.channelPool, 'GetIndexState', data, data.timeout || this.timeout);
             return promise;
         });
     }
     /**
-     * Show index building progress.
-     *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | collection_name | String | Collection name |
-     *  | field_name | String | Field 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 } |
-     *  | indexed_rows | Row count that successfully built with index |
-     *  | total_rows | Total row count |
+     * Get index building progress.
+     *
+     * @param {Object} data - The data for retrieving the index building progress.
+     * @param {string} data.collection_name - The name of the collection.
+     * @param {string} [data.field_name] - The name of the field for which the index building progress is to be retrieved.
+     * @param {string} [data.index_name] - The name of the index for which the building progress is to be retrieved.
+     * @param {number} [data.timeout] - 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 error occurs. Default is undefined.
+     *
+     * @returns {Promise<Object>} A promise that resolves to an object with properties 'status', 'indexed_rows', and 'total_rows'.
+     * @returns {Object} return.status - An object with properties 'error_code' (number) and 'reason' (string) indicating the status of the request.
+     * @returns {number} return.indexed_rows - The number of rows that have been successfully indexed.
+     * @returns {number} return.total_rows - The total number of rows.
      *
      * @example
      * ```
      * const milvusClient = new MilvusClient(MILUVS_ADDRESS);
      * const getIndexBuildProgressReq = {
      *   collection_name: 'my_collection',
-     *   field_name: 'my_field',
+     *   index_name: 'my_index',
      * };
      * const res = await milvusClient.getIndexBuildProgress(getIndexBuildProgressReq);
      * console.log(res);
@@ -169,32 +234,29 @@ class Index extends Data_1.Data {
     getIndexBuildProgress(data) {
         return __awaiter(this, void 0, void 0, function* () {
             (0, __1.checkCollectionName)(data);
-            const promise = yield (0, __1.promisify)(this.client, 'GetIndexBuildProgress', data, data.timeout || this.timeout);
+            const promise = yield (0, __1.promisify)(this.channelPool, 'GetIndexBuildProgress', data, data.timeout || this.timeout);
             return promise;
         });
     }
     /**
      * Drop an index.
      *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | collection_name | String | Collection name |
-     *  | field_name | String | Field 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 |
+     * @param {Object} data - The data for dropping the index.
+     * @param {string} data.collection_name - The name of the collection.
+     * @param {string} [data.field_name] - The name of the field for which the index is to be dropped.
+     * @param {string} [data.index_name] - The name of the index to be dropped.
+     * @param {number} [data.timeout] - 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 error occurs. Default is undefined.
      *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | error_code | Error code number |
-     *  | reason | Error cause |
+     * @returns {Promise<Object>} A promise that resolves to an object with properties 'error_code' and 'reason'.
+     * @returns {number} return.error_code - The error code number.
+     * @returns {string} return.reason - The cause of the error.
      *
      * @example
      * ```
      * const milvusClient = new MilvusClient(MILUVS_ADDRESS);
      * const dropIndexReq = {
      *   collection_name: 'my_collection',
-     *   field_name: 'my_field',
+     *   index_name: 'my_index',
      * };
      * const res = await milvusClient.dropIndex(dropIndexReq);
      * console.log(res);
@@ -203,7 +265,41 @@ class Index extends Data_1.Data {
     dropIndex(data) {
         return __awaiter(this, void 0, void 0, function* () {
             (0, __1.checkCollectionName)(data);
-            const promise = yield (0, __1.promisify)(this.client, 'DropIndex', data, data.timeout || this.timeout);
+            const promise = yield (0, __1.promisify)(this.channelPool, 'DropIndex', data, data.timeout || this.timeout);
+            return promise;
+        });
+    }
+    /**
+     * Alters an existing index.
+     *
+     * @param {Object} data - The data for altering the index.
+     * @param {string} data.collection_name - The name of the collection.
+     * @param {Object} data.params - The new parameters for the index. For example, `{ nlist: number }`.
+     * @param {number} [data.timeout] - 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 {Promise<ResStatus>} - A promise that resolves to a response status object.
+     * @returns {number} return.error_code - The error code number.
+     * @returns {string} return.reason - The cause of the error.
+     *
+     * @example
+     * ```
+     * const milvusClient = new MilvusClient(MILUVS_ADDRESS);
+     * const alterIndexReq = {
+     *   collection_name: 'my_collection',
+     *   params: { nlist: 20 },
+     * };
+     * const res = await milvusClient.alterIndex(alterIndexReq);
+     * console.log(res);
+     * ```
+     */
+    alterIndex(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            (0, __1.checkCollectionName)(data);
+            const promise = yield (0, __1.promisify)(this.channelPool, 'AlterIndex', {
+                collection_name: data.collection_name,
+                index_name: data.index_name,
+                extra_params: (0, __1.parseToKeyValue)(data.params),
+            }, data.timeout || this.timeout);
             return promise;
         });
     }

package/dist/milvus/grpc/MilvusIndex.js.map

@@ -1 +1 @@
-{"version":3,"file":"MilvusIndex.js","sourceRoot":"","sources":["../../../milvus/grpc/MilvusIndex.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iCAA8B;AAC9B,2BAca;AAEb,MAAa,KAAM,SAAQ,WAAI;IAC7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,WAAW,CACf,IAA2C;;YAE3C,IAAA,uBAAmB,EAAC,IAAI,CAAC,CAAC;YAE1B,4BAA4B;YAC5B,MAAM,YAAY,GACf,IAAuB,CAAC,YAAY,IAAK,EAA2B,CAAC;YAExE,8BAA8B;YAC9B,IAAK,IAA6B,CAAC,MAAM,EAAE;gBACzC,YAAY,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,CACjC,IAA6B,CAAC,MAAM,CACtC,CAAC;aACH;YAED,+CAA+C;YAC/C,IAAK,IAA6B,CAAC,UAAU,EAAE;gBAC7C,YAAY,CAAC,UAAU,GAAI,IAA6B,CAAC,UAAU,CAAC;aACrE;YAED,gDAAgD;YAChD,IAAK,IAA6B,CAAC,WAAW,EAAE;gBAC9C,YAAY,CAAC,WAAW,GAAI,IAA6B,CAAC,WAAW,CAAC;aACvE;YAED,2BAA2B;YAC3B,MAAM,iBAAiB,mCAClB,IAAI,GACJ,YAAY,CAChB,CAAC;YAEF,+CAA+C;YAC/C,IAAI,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;gBACxC,iBAAiB,CAAC,YAAY,GAAG,IAAA,mBAAe,EAAC,YAAY,CAAC,CAAC;aAChE;YAED,2DAA2D;YAC3D,MAAM,OAAO,GAAG,MAAM,IAAA,aAAS,EAC7B,IAAI,CAAC,MAAM,EACX,aAAa,EACb,iBAAiB,EACjB,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,CAAC;YACF,OAAO,OAAO,CAAC;QACjB,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,aAAa,CAAC,IAAsB;;YACxC,IAAA,uBAAmB,EAAC,IAAI,CAAC,CAAC;YAC1B,MAAM,OAAO,GAAG,MAAM,IAAA,aAAS,EAC7B,IAAI,CAAC,MAAM,EACX,eAAe,EACf,IAAI,EACJ,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,CAAC;YACF,OAAO,OAAO,CAAC;QACjB,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,aAAa,CAAC,IAAsB;;YACxC,IAAA,uBAAmB,EAAC,IAAI,CAAC,CAAC;YAC1B,MAAM,OAAO,GAAG,MAAM,IAAA,aAAS,EAC7B,IAAI,CAAC,MAAM,EACX,eAAe,EACf,IAAI,EACJ,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,CAAC;YACF,OAAO,OAAO,CAAC;QACjB,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,qBAAqB,CACzB,IAA8B;;YAE9B,IAAA,uBAAmB,EAAC,IAAI,CAAC,CAAC;YAC1B,MAAM,OAAO,GAAG,MAAM,IAAA,aAAS,EAC7B,IAAI,CAAC,MAAM,EACX,uBAAuB,EACvB,IAAI,EACJ,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,CAAC;YACF,OAAO,OAAO,CAAC;QACjB,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,SAAS,CAAC,IAAkB;;YAChC,IAAA,uBAAmB,EAAC,IAAI,CAAC,CAAC;YAC1B,MAAM,OAAO,GAAG,MAAM,IAAA,aAAS,EAC7B,IAAI,CAAC,MAAM,EACX,WAAW,EACX,IAAI,EACJ,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,CAAC;YACF,OAAO,OAAO,CAAC;QACjB,CAAC;KAAA;CACF;AAvOD,sBAuOC"}
+{"version":3,"file":"MilvusIndex.js","sourceRoot":"","sources":["../../../milvus/grpc/MilvusIndex.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iCAA8B;AAC9B,2BAmBa;AAEb,MAAa,KAAM,SAAQ,WAAI;IAC7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;IACG,WAAW,CAAC,IAAsB;;YACtC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;gBACvB,OAAO,MAAM,OAAO,CAAC,GAAG,CACtB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,IAA0B,CAAC,CAAC,CAChE,CAAC,IAAI,CAAC,CAAC,SAAsB,EAAE,EAAE;oBAChC,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,aAAS,CAAC,OAAO,CAAC,EAAE;wBAC5D,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC;qBACrB;yBAAM;wBACL,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,aAAS,CAAC,OAAO,CAAE,CAAC;qBACjE;gBACH,CAAC,CAAC,CAAC;aACJ;YAED,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,IAA0B,CAAC,CAAC;QAC7D,CAAC;KAAA;IAED,uBAAuB;IACjB,YAAY,CAAC,IAAwB;;YACzC,IAAA,uBAAmB,EAAC,IAAI,CAAC,CAAC;YAE1B,4BAA4B;YAC5B,MAAM,YAAY,GACf,IAAuB,CAAC,YAAY,IAAK,EAA2B,CAAC;YAExE,8BAA8B;YAC9B,IAAK,IAA6B,CAAC,MAAM,EAAE;gBACzC,YAAY,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,CACjC,IAA6B,CAAC,MAAM,CACtC,CAAC;aACH;YAED,+CAA+C;YAC/C,IAAK,IAA6B,CAAC,UAAU,EAAE;gBAC7C,YAAY,CAAC,UAAU,GAAI,IAA6B,CAAC,UAAU,CAAC;aACrE;YAED,gDAAgD;YAChD,IAAK,IAA6B,CAAC,WAAW,EAAE;gBAC9C,YAAY,CAAC,WAAW,GAAI,IAA6B,CAAC,WAAW,CAAC;aACvE;YAED,2BAA2B;YAC3B,MAAM,iBAAiB,mCAClB,IAAI,GACJ,YAAY,CAChB,CAAC;YAEF,+CAA+C;YAC/C,IAAI,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;gBACxC,iBAAiB,CAAC,YAAY,GAAG,IAAA,mBAAe,EAAC,YAAY,CAAC,CAAC;aAChE;YAED,2DAA2D;YAC3D,MAAM,OAAO,GAAG,MAAM,IAAA,aAAS,EAC7B,IAAI,CAAC,WAAW,EAChB,aAAa,EACb,iBAAiB,EACjB,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,CAAC;YACF,OAAO,OAAO,CAAC;QACjB,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,aAAa,CAAC,IAAsB;;YACxC,IAAA,uBAAmB,EAAC,IAAI,CAAC,CAAC;YAC1B,MAAM,OAAO,GAAG,MAAM,IAAA,aAAS,EAC7B,IAAI,CAAC,WAAW,EAChB,eAAe,EACf,IAAI,EACJ,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,CAAC;YACF,OAAO,OAAO,CAAC;QACjB,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,WAAW,CAAC,IAAsB;;YACtC,MAAM,gBAAgB,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAClD,MAAM,OAAO,GAAG,CAAC,MAAM,gBAAgB,CAAC,CAAC,kBAAkB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;gBACtE,OAAO,KAAK,CAAC,UAAU,CAAC;YAC1B,CAAC,CAAC,CAAC;YAEH,OAAO;gBACL,MAAM,EAAE,CAAC,MAAM,gBAAgB,CAAC,CAAC,MAAM;gBACvC,OAAO,EAAE,OAAO;aACjB,CAAC;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,aAAa,CAAC,IAAsB;;YACxC,IAAA,uBAAmB,EAAC,IAAI,CAAC,CAAC;YAC1B,MAAM,OAAO,GAAG,MAAM,IAAA,aAAS,EAC7B,IAAI,CAAC,WAAW,EAChB,eAAe,EACf,IAAI,EACJ,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,CAAC;YACF,OAAO,OAAO,CAAC;QACjB,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,qBAAqB,CACzB,IAA8B;;YAE9B,IAAA,uBAAmB,EAAC,IAAI,CAAC,CAAC;YAC1B,MAAM,OAAO,GAAG,MAAM,IAAA,aAAS,EAC7B,IAAI,CAAC,WAAW,EAChB,uBAAuB,EACvB,IAAI,EACJ,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,CAAC;YACF,OAAO,OAAO,CAAC;QACjB,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,SAAS,CAAC,IAAkB;;YAChC,IAAA,uBAAmB,EAAC,IAAI,CAAC,CAAC;YAC1B,MAAM,OAAO,GAAG,MAAM,IAAA,aAAS,EAC7B,IAAI,CAAC,WAAW,EAChB,WAAW,EACX,IAAI,EACJ,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,CAAC;YACF,OAAO,OAAO,CAAC;QACjB,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,UAAU,CAAC,IAAmB;;YAClC,IAAA,uBAAmB,EAAC,IAAI,CAAC,CAAC;YAC1B,MAAM,OAAO,GAAG,MAAM,IAAA,aAAS,EAC7B,IAAI,CAAC,WAAW,EAChB,YAAY,EACZ;gBACE,eAAe,EAAE,IAAI,CAAC,eAAe;gBACrC,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,YAAY,EAAE,IAAA,mBAAe,EAAC,IAAI,CAAC,MAAM,CAAC;aAC3C,EACD,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAC7B,CAAC;YACF,OAAO,OAAO,CAAC;QACjB,CAAC;KAAA;CACF;AA1UD,sBA0UC"}