simple-milvus-mcp
Version:
MCP server for Milvus vector database with semantic and full-text search capabilities
357 lines • 16.8 kB
JavaScript
"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.Index = void 0;
const Data_1 = require("./Data");
const __1 = require("../");
class Index extends Data_1.Data {
constructor() {
super(...arguments);
/**
* @deprecated
*/
this.alterIndex = this.alterIndexProperties;
}
/**
* 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
* ```
* const milvusClient = new MilvusClient(MILUVS_ADDRESS);
* const createIndexReq = {
* collection_name: 'my_collection',
* field_name: 'vector_01',
* index_name: 'my_index',
* index_type: 'IVF_FLAT',
* metric_type: 'IP',
* params: { nlist: 10 },
* };
* 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
const extra_params = data.extra_params || {};
// if params set, build params
if (data.params) {
extra_params.params = JSON.stringify(data.params);
}
// if index_type is set, add it to extra_params
if (data.index_type) {
extra_params.index_type = data.index_type;
}
// if metric_type is set, add it to extra_params
if (data.metric_type) {
extra_params.metric_type = data.metric_type;
}
// build create index param
const createIndexParams = Object.assign(Object.assign({}, data), extra_params);
// if extra param not empty, overwrite existing
if (Object.keys(extra_params).length > 0) {
createIndexParams.extra_params = (0, __1.parseToKeyValue)(extra_params);
}
// Call the 'CreateIndex' gRPC method and return the result
const promise = yield (0, __1.promisify)(this.channelPool, 'CreateIndex', createIndexParams, data.timeout || this.timeout);
return promise;
});
}
/**
* Displays index information. The current release of Milvus only supports displaying 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<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
* ```
* const milvusClient = new MilvusClient(MILUVS_ADDRESS);
* const describeIndexReq = {
* collection_name: 'my_collection',
* };
* const res = await milvusClient.describeIndex(describeIndexReq);
* console.log(res);
* ```
*/
describeIndex(data) {
return __awaiter(this, void 0, void 0, function* () {
(0, __1.checkCollectionName)(data);
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.
* @deprecated
*
* @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 {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);
* ```
*/
/* istanbul ignore next */
getIndexState(data) {
return __awaiter(this, void 0, void 0, function* () {
(0, __1.checkCollectionName)(data);
const promise = yield (0, __1.promisify)(this.channelPool, 'GetIndexState', data, data.timeout || this.timeout);
return promise;
});
}
/**
* 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',
* index_name: 'my_index',
* };
* const res = await milvusClient.getIndexBuildProgress(getIndexBuildProgressReq);
* console.log(res);
* ```
*/
getIndexBuildProgress(data) {
return __awaiter(this, void 0, void 0, function* () {
(0, __1.checkCollectionName)(data);
const promise = yield (0, __1.promisify)(this.channelPool, 'GetIndexBuildProgress', data, data.timeout || this.timeout);
return promise;
});
}
/**
* Drop an index.
*
* @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 {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',
* index_name: 'my_index',
* };
* const res = await milvusClient.dropIndex(dropIndexReq);
* console.log(res);
* ```
*/
dropIndex(data) {
return __awaiter(this, void 0, void 0, function* () {
(0, __1.checkCollectionName)(data);
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);
* ```
*/
alterIndexProperties(data) {
return __awaiter(this, void 0, void 0, function* () {
(0, __1.checkCollectionName)(data);
const req = {
collection_name: data.collection_name,
index_name: data.index_name,
extra_params: (0, __1.parseToKeyValue)(data.params),
};
if (data.db_name) {
req.db_name = data.db_name;
}
const promise = yield (0, __1.promisify)(this.channelPool, 'AlterIndex', req, data.timeout || this.timeout);
return promise;
});
}
/**
* Drop index properties.
* @param {DropIndexPropertiesReq} data - The data for dropping the index properties.
* @param {string} data.collection_name - The name of the collection.
* @param {string} data.index_name - The name of the index.
* @param {string[]} data.properties - The properties to be dropped.
* @param {string} [data.db_name] - The name of the database.
* @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
* ```
* const milvusClient = new MilvusClient(MILUVS_ADDRESS);
* const dropIndexPropertiesReq = {
* collection_name: 'my_collection',
* index_name: 'my_index',
* properties: ['mmap.enabled'],
* };
* const res = await milvusClient.dropIndexProperties(dropIndexPropertiesReq);
* console.log(res);
* ```
*/
dropIndexProperties(data) {
return __awaiter(this, void 0, void 0, function* () {
const req = {
collection_name: data.collection_name,
index_name: data.index_name,
delete_keys: data.properties,
};
if (data.db_name) {
req.db_name = data.db_name;
}
const promise = yield (0, __1.promisify)(this.channelPool, 'AlterIndex', req, data.timeout || this.timeout);
return promise;
});
}
}
exports.Index = Index;
//# sourceMappingURL=MilvusIndex.js.map