@zilliz/milvus2-sdk-node 2.2.10 → 2.2.12

package/dist/{utils → milvus/utils}/Grpc.d.ts

@@ -10,24 +10,25 @@ interface IServiceDetails {
  */
 export declare const getGRPCService: (proto: IServiceDetails) => ServiceClientConstructor;
 /**
- * Returns an interceptor function that adds an authorization header to the metadata of a gRPC call.
- * @param username - The username to use for authentication.
- * @param password - The password to use for authentication.
- * @returns An interceptor function.
+ * Returns a gRPC interceptor function that adds metadata to outgoing requests.
+ *
+ * @param {Function} onInvoked - A function to be called with the modified metadata.
+ * @param {Object[]} initValues - An array of objects containing key-value pairs to add to the metadata.
+ * @returns {Function} The gRPC interceptor function.
  */
-export declare const getAuthInterceptor: (username: string, password: string) => (options: any, nextCall: any) => InterceptingCall;
+export declare const getMetaInterceptor: (onInvoked: Function, initValues?: {
+    [key: string]: any;
+}[]) => (options: any, nextCall: any) => InterceptingCall;
 /**
  * Returns a gRPC interceptor function that retries failed requests up to a maximum number of times.
  *
  * @param {Object} options - The options object.
  * @param {number} options.maxRetries - The maximum number of times to retry a failed request.
  * @param {number} options.retryDelay - The delay in milliseconds between retries.
- * @param {boolean} options.debug - Whether to log debug information.
  * @returns {Function} The gRPC interceptor function.
  */
-export declare const getRetryInterceptor: ({ maxRetries, retryDelay, debug, }: {
+export declare const getRetryInterceptor: ({ maxRetries, retryDelay, }: {
     maxRetries: number;
     retryDelay: number;
-    debug: boolean;
 }) => (options: any, nextCall: any) => InterceptingCall;
 export {};

package/dist/milvus/utils/Grpc.js

@@ -0,0 +1,190 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRetryInterceptor = exports.getMetaInterceptor = exports.getGRPCService = void 0;
+const path_1 = __importDefault(require("path"));
+const proto_loader_1 = require("@grpc/proto-loader");
+const grpc_js_1 = require("@grpc/grpc-js");
+const _1 = require(".");
+const const_1 = require("../const");
+const PROTO_OPTIONS = {
+    keepCase: true,
+    longs: String,
+    enums: String,
+    defaults: true,
+    oneofs: true,
+};
+/**
+ * Returns a gRPC service client constructor for the given proto file and service name.
+ * @param proto An object containing the proto file path and service name.
+ * @returns A gRPC service client constructor.
+ */
+const getGRPCService = (proto) => {
+    // Resolve the proto file path.
+    const PROTO_PATH = path_1.default.resolve(__dirname, proto.protoPath);
+    // Load the proto file.
+    const packageDefinition = (0, proto_loader_1.loadSync)(PROTO_PATH, PROTO_OPTIONS);
+    // Load the gRPC object.
+    const grpcObj = (0, grpc_js_1.loadPackageDefinition)(packageDefinition);
+    // Get the service object from the gRPC object.
+    const service = proto.serviceName
+        .split('.')
+        .reduce((a, b) => a[b], grpcObj);
+    // Check that the service object is valid.
+    if ((service === null || service === void 0 ? void 0 : service.name) !== 'ServiceClientImpl') {
+        throw new Error(`Unable to load service: ${proto.serviceName} from ${proto.protoPath}`);
+    }
+    // Return the service client constructor.
+    return service;
+};
+exports.getGRPCService = getGRPCService;
+/**
+ * Returns a gRPC interceptor function that adds metadata to outgoing requests.
+ *
+ * @param {Function} onInvoked - A function to be called with the modified metadata.
+ * @param {Object[]} initValues - An array of objects containing key-value pairs to add to the metadata.
+ * @returns {Function} The gRPC interceptor function.
+ */
+const getMetaInterceptor = (onInvoked, initValues = []) => function (options, nextCall) {
+    // Create a new InterceptingCall object with nextCall(options) as its first parameter.
+    return new grpc_js_1.InterceptingCall(nextCall(options), {
+        // Define the start method of the InterceptingCall object.
+        start: function (metadata, listener, next) {
+            initValues.forEach(obj => {
+                Object.entries(obj).forEach(([key, value]) => {
+                    metadata.add(key, value);
+                });
+            });
+            if (onInvoked) {
+                onInvoked(metadata);
+            }
+            // Call next(metadata, listener) to continue the call with the modified metadata.
+            next(metadata, listener);
+        },
+    });
+};
+exports.getMetaInterceptor = getMetaInterceptor;
+/**
+ * Returns a gRPC interceptor function that retries failed requests up to a maximum number of times.
+ *
+ * @param {Object} options - The options object.
+ * @param {number} options.maxRetries - The maximum number of times to retry a failed request.
+ * @param {number} options.retryDelay - The delay in milliseconds between retries.
+ * @returns {Function} The gRPC interceptor function.
+ */
+/* istanbul ignore next */
+const getRetryInterceptor = ({ maxRetries = 3, retryDelay = 30, }) => function (options, nextCall) {
+    let savedMetadata;
+    let savedSendMessage;
+    let savedReceiveMessage;
+    let savedMessageNext;
+    // deadline
+    const deadline = options.deadline;
+    // get method name
+    // option example
+    // {
+    //   deadline: 2023-05-04T09:04:16.231Z,
+    //   method_definition: {
+    //     path: '/milvus.proto.milvus.MilvusService/ListCredUsers',
+    //     requestStream: false,
+    //     responseStream: false,
+    //     requestSerialize: [Function: serialize],
+    //     responseDeserialize: [Function: deserialize]
+    //   }
+    // }
+    const methodName = (0, _1.extractMethodName)(options.method_definition.path);
+    // start time
+    const startTime = new Date();
+    let dbname = '';
+    // requester, used to re-execute method
+    let requester = {
+        start: function (metadata, listener, next) {
+            savedMetadata = metadata;
+            // get db name
+            dbname = metadata.get('dbname') || const_1.DEFAULT_DB;
+            // logger.debug(`[DB:${dbname}:${methodName}] started.`);
+            const newListener = {
+                onReceiveMessage: function (message, next) {
+                    savedReceiveMessage = message;
+                    savedMessageNext = next;
+                },
+                onReceiveStatus: function (status, next) {
+                    // retry count
+                    let retries = 0;
+                    // retry function
+                    let retry = function (message, metadata) {
+                        // retry count
+                        retries++;
+                        // retry delay
+                        const _retryDelay = Math.pow(2, retries) * retryDelay;
+                        // timeout
+                        const _timeout = deadline.getTime() - startTime.getTime();
+                        // log
+                        _1.logger.debug(`[DB:${dbname}:${methodName}] executed failed, status: ${JSON.stringify(status)}, timeout set: ${_timeout}ms, retry after ${_retryDelay} ms.`);
+                        // retry listener
+                        const retryListener = {
+                            onReceiveMessage: function (message) {
+                                savedReceiveMessage = message;
+                            },
+                            onReceiveStatus: function (status) {
+                                if ((0, _1.isStatusCodeMatched)(status.code)) {
+                                    if (retries < maxRetries) {
+                                        setTimeout(() => {
+                                            // need to update the deadline
+                                            retry(message, metadata);
+                                            // double increase delay every retry
+                                        }, _retryDelay);
+                                    }
+                                    else {
+                                        _1.logger.debug(`[DB:${dbname}:${methodName}] retry run out of ${retries} times. ${JSON.stringify(status)}`);
+                                        // we still pop up server information to client
+                                        savedMessageNext(savedReceiveMessage);
+                                        // and do the next call if there is
+                                        next(status);
+                                    }
+                                }
+                                else {
+                                    _1.logger.debug(`[DB:${dbname}:${methodName}] retried successfully in ${Date.now() - startTime.getTime()}ms.`);
+                                    savedMessageNext(savedReceiveMessage);
+                                    next({ code: grpc_js_1.status.OK });
+                                }
+                            },
+                        };
+                        // retry, update deadline
+                        options.deadline = new Date(Date.now() + _timeout);
+                        let newCall = nextCall(options);
+                        newCall.start(metadata, retryListener);
+                    };
+                    // check grpc status
+                    switch (status.code) {
+                        case grpc_js_1.status.DEADLINE_EXCEEDED:
+                        case grpc_js_1.status.UNAVAILABLE:
+                        case grpc_js_1.status.INTERNAL:
+                            retry(savedSendMessage, savedMetadata);
+                            break;
+                        case grpc_js_1.status.UNIMPLEMENTED:
+                            // const returnMsg = { error_code: 'Success', reason: '' };
+                            _1.logger.debug(`[DB:${dbname}:${methodName}] returns ${JSON.stringify(status)}`);
+                            throw new Error('This version of sdk is incompatible with the server, please downgrade your sdk or upgrade your server.');
+                        default:
+                            // OK
+                            _1.logger.debug(`[DB:${dbname}:${methodName}] executed in ${Date.now() - startTime.getTime()}ms, returns ${JSON.stringify(savedReceiveMessage)}`);
+                            savedMessageNext(savedReceiveMessage);
+                            next(status);
+                    }
+                },
+            };
+            next(metadata, newListener);
+        },
+        sendMessage: function (message, next) {
+            _1.logger.debug(`[DB:${dbname}:${methodName}] sending ${JSON.stringify(message)}`);
+            savedSendMessage = message;
+            next(message);
+        },
+    };
+    return new grpc_js_1.InterceptingCall(nextCall(options), requester);
+};
+exports.getRetryInterceptor = getRetryInterceptor;
+//# sourceMappingURL=Grpc.js.map

package/dist/milvus/utils/Grpc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Grpc.js","sourceRoot":"","sources":["../../../milvus/utils/Grpc.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AACxB,qDAA8C;AAC9C,2CAMuB;AACvB,wBAAmE;AACnE,oCAAsC;AAEtC,MAAM,aAAa,GAAG;IACpB,QAAQ,EAAE,IAAI;IACd,KAAK,EAAE,MAAM;IACb,KAAK,EAAE,MAAM;IACb,QAAQ,EAAE,IAAI;IACd,MAAM,EAAE,IAAI;CACb,CAAC;AAOF;;;;GAIG;AACI,MAAM,cAAc,GAAG,CAC5B,KAAsB,EACI,EAAE;IAC5B,+BAA+B;IAC/B,MAAM,UAAU,GAAG,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAC5D,uBAAuB;IACvB,MAAM,iBAAiB,GAAG,IAAA,uBAAQ,EAAC,UAAU,EAAE,aAAa,CAAC,CAAC;IAC9D,wBAAwB;IACxB,MAAM,OAAO,GAAe,IAAA,+BAAqB,EAAC,iBAAiB,CAAC,CAAC;IACrE,+CAA+C;IAC/C,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW;SAC9B,KAAK,CAAC,GAAG,CAAC;SACV,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,OAAc,CAAC,CAAC;IAC1C,0CAA0C;IAC1C,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,MAAK,mBAAmB,EAAE;QACzC,MAAM,IAAI,KAAK,CACb,2BAA2B,KAAK,CAAC,WAAW,SAAS,KAAK,CAAC,SAAS,EAAE,CACvE,CAAC;KACH;IACD,yCAAyC;IACzC,OAAO,OAAmC,CAAC;AAC7C,CAAC,CAAC;AArBW,QAAA,cAAc,kBAqBzB;AAEF;;;;;;GAMG;AACI,MAAM,kBAAkB,GAAG,CAChC,SAAmB,EACnB,aAAuC,EAAE,EACzC,EAAE,CACF,UAAU,OAAY,EAAE,QAAa;IACnC,sFAAsF;IACtF,OAAO,IAAI,0BAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;QAC7C,0DAA0D;QAC1D,KAAK,EAAE,UAAU,QAAQ,EAAE,QAAQ,EAAE,IAAI;YACvC,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;gBACvB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;oBAC3C,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAC3B,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YACH,IAAI,SAAS,EAAE;gBACb,SAAS,CAAC,QAAQ,CAAC,CAAC;aACrB;YACD,iFAAiF;YACjF,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC3B,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AArBS,QAAA,kBAAkB,sBAqB3B;AAEJ;;;;;;;GAOG;AACH,0BAA0B;AACnB,MAAM,mBAAmB,GAAG,CAAC,EAClC,UAAU,GAAG,CAAC,EACd,UAAU,GAAG,EAAE,GAIhB,EAAE,EAAE,CACH,UAAU,OAAY,EAAE,QAAa;IACnC,IAAI,aAAkB,CAAC;IACvB,IAAI,gBAAqB,CAAC;IAC1B,IAAI,mBAAwB,CAAC;IAC7B,IAAI,gBAAqB,CAAC;IAE1B,WAAW;IACX,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAElC,kBAAkB;IAClB,iBAAiB;IACjB,IAAI;IACJ,wCAAwC;IACxC,yBAAyB;IACzB,gEAAgE;IAChE,4BAA4B;IAC5B,6BAA6B;IAC7B,+CAA+C;IAC/C,mDAAmD;IACnD,MAAM;IACN,IAAI;IACJ,MAAM,UAAU,GAAG,IAAA,oBAAiB,EAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAErE,aAAa;IACb,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;IAC7B,IAAI,MAAM,GAAG,EAAE,CAAC;IAEhB,uCAAuC;IACvC,IAAI,SAAS,GAAG;QACd,KAAK,EAAE,UAAU,QAAa,EAAE,QAAa,EAAE,IAAS;YACtD,aAAa,GAAG,QAAQ,CAAC;YAEzB,cAAc;YACd,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,kBAAU,CAAC;YAE9C,yDAAyD;YAEzD,MAAM,WAAW,GAAG;gBAClB,gBAAgB,EAAE,UAAU,OAAY,EAAE,IAAS;oBACjD,mBAAmB,GAAG,OAAO,CAAC;oBAC9B,gBAAgB,GAAG,IAAI,CAAC;gBAC1B,CAAC;gBACD,eAAe,EAAE,UAAU,MAAW,EAAE,IAAS;oBAC/C,cAAc;oBACd,IAAI,OAAO,GAAG,CAAC,CAAC;oBAChB,iBAAiB;oBACjB,IAAI,KAAK,GAAG,UAAU,OAAY,EAAE,QAAa;wBAC/C,cAAc;wBACd,OAAO,EAAE,CAAC;wBACV,cAAc;wBACd,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,UAAU,CAAC;wBAEtD,UAAU;wBACV,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,EAAE,GAAG,SAAS,CAAC,OAAO,EAAE,CAAC;wBAC1D,MAAM;wBACN,SAAM,CAAC,KAAK,CACV,OAAO,MAAM,IAAI,UAAU,8BAA8B,IAAI,CAAC,SAAS,CACrE,MAAM,CACP,kBAAkB,QAAQ,mBAAmB,WAAW,MAAM,CAChE,CAAC;wBAEF,iBAAiB;wBACjB,MAAM,aAAa,GAAG;4BACpB,gBAAgB,EAAE,UAAU,OAAY;gCACtC,mBAAmB,GAAG,OAAO,CAAC;4BAChC,CAAC;4BACD,eAAe,EAAE,UAAU,MAAW;gCACpC,IAAI,IAAA,sBAAmB,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE;oCACpC,IAAI,OAAO,GAAG,UAAU,EAAE;wCACxB,UAAU,CAAC,GAAG,EAAE;4CACd,8BAA8B;4CAC9B,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;4CACzB,oCAAoC;wCACtC,CAAC,EAAE,WAAW,CAAC,CAAC;qCACjB;yCAAM;wCACL,SAAM,CAAC,KAAK,CACV,OAAO,MAAM,IAAI,UAAU,sBAAsB,OAAO,WAAW,IAAI,CAAC,SAAS,CAC/E,MAAM,CACP,EAAE,CACJ,CAAC;wCAEF,+CAA+C;wCAC/C,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;wCACtC,mCAAmC;wCACnC,IAAI,CAAC,MAAM,CAAC,CAAC;qCACd;iCACF;qCAAM;oCACL,SAAM,CAAC,KAAK,CACV,OAAO,MAAM,IAAI,UAAU,6BACzB,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,OAAO,EAChC,KAAK,CACN,CAAC;oCACF,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;oCACtC,IAAI,CAAC,EAAE,IAAI,EAAE,gBAAU,CAAC,EAAE,EAAE,CAAC,CAAC;iCAC/B;4BACH,CAAC;yBACF,CAAC;wBACF,yBAAyB;wBACzB,OAAO,CAAC,QAAQ,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,QAAQ,CAAC,CAAC;wBACnD,IAAI,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;wBAChC,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;oBACzC,CAAC,CAAC;oBAEF,oBAAoB;oBACpB,QAAQ,MAAM,CAAC,IAAI,EAAE;wBACnB,KAAK,gBAAU,CAAC,iBAAiB,CAAC;wBAClC,KAAK,gBAAU,CAAC,WAAW,CAAC;wBAC5B,KAAK,gBAAU,CAAC,QAAQ;4BACtB,KAAK,CAAC,gBAAgB,EAAE,aAAa,CAAC,CAAC;4BACvC,MAAM;wBACR,KAAK,gBAAU,CAAC,aAAa;4BAC3B,2DAA2D;4BAC3D,SAAM,CAAC,KAAK,CACV,OAAO,MAAM,IAAI,UAAU,aAAa,IAAI,CAAC,SAAS,CACpD,MAAM,CACP,EAAE,CACJ,CAAC;4BACF,MAAM,IAAI,KAAK,CACb,wGAAwG,CACzG,CAAC;wBACJ;4BACE,KAAK;4BACL,SAAM,CAAC,KAAK,CACV,OAAO,MAAM,IAAI,UAAU,iBACzB,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,OAAO,EAChC,eAAe,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC,EAAE,CACrD,CAAC;4BACF,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;4BACtC,IAAI,CAAC,MAAM,CAAC,CAAC;qBAChB;gBACH,CAAC;aACF,CAAC;YAEF,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAC9B,CAAC;QACD,WAAW,EAAE,UAAU,OAAY,EAAE,IAAS;YAC5C,SAAM,CAAC,KAAK,CACV,OAAO,MAAM,IAAI,UAAU,aAAa,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAClE,CAAC;YACF,gBAAgB,GAAG,OAAO,CAAC;YAC3B,IAAI,CAAC,OAAO,CAAC,CAAC;QAChB,CAAC;KACF,CAAC;IACF,OAAO,IAAI,0BAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC;AAC5D,CAAC,CAAC;AAvJS,QAAA,mBAAmB,uBAuJ5B"}

package/dist/{utils → milvus/utils}/Validate.d.ts

@@ -1,4 +1,4 @@
-import { FieldType } from '../milvus';
+import { FieldType } from '../';
 /**
  * when create collection, field must contain 2 Fields.
  * Type is int64 or varchar and primary_key = true
@@ -36,3 +36,9 @@ export declare const checkSearchParams: (data: any) => void;
  * @returns {boolean} Whether the gRPC status code matches any of the given codes.
  */
 export declare const isStatusCodeMatched: (code: number, codesToCheck?: number[]) => boolean;
+/**
+ * Validates the number of partitions.
+ * @param {number} num_partitions - The number of partitions to validate.
+ * @throws {Error} Throws an error if the number of partitions is invalid.
+ */
+export declare const validatePartitionNumbers: (num_partitions: number) => void;

package/dist/milvus/utils/Validate.js

@@ -0,0 +1,140 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validatePartitionNumbers = exports.isStatusCodeMatched = exports.checkSearchParams = exports.checkCollectionAndPartitionName = exports.checkCollectionName = exports.checkCollectionFields = void 0;
+const __1 = require("../");
+const grpc_js_1 = require("@grpc/grpc-js");
+/**
+ * when create collection, field must contain 2 Fields.
+ * Type is int64 or varchar and primary_key = true
+ * Type is one of float_vector and binary_vector
+ * Will check fields
+ * @param fields
+ */
+const checkCollectionFields = (fields) => {
+    // Define arrays of data types that are allowed for vector fields and primary keys, respectively
+    const vectorDataTypes = [__1.DataType.BinaryVector, __1.DataType.FloatVector];
+    const int64VarCharTypes = [__1.DataType.Int64, __1.DataType.VarChar];
+    let hasPrimaryKey = false;
+    let hasVectorField = false;
+    let partitionKeyCount = 0;
+    fields.forEach(field => {
+        var _a, _b;
+        if (!field.hasOwnProperty('data_type')) {
+            throw new Error(__1.ERROR_REASONS.CREATE_COLLECTION_MISS_DATA_TYPE);
+        }
+        // get data type
+        const dataType = (0, __1.convertToDataType)(field.data_type);
+        const isPrimaryKey = field.is_primary_key;
+        const isPartitionKey = field.is_partition_key;
+        if (isPrimaryKey && int64VarCharTypes.includes(dataType)) {
+            hasPrimaryKey = true;
+        }
+        // if partition key is set, it should be set on int64 or varchar and non-primary key field
+        if (isPartitionKey) {
+            if (!int64VarCharTypes.includes(dataType) || isPrimaryKey) {
+                throw new Error(__1.ERROR_REASONS.INVALID_PARTITION_KEY_FIELD_TYPE);
+            }
+        }
+        // if this is the partition key field, check the limit
+        if (isPartitionKey) {
+            partitionKeyCount++;
+        }
+        // if this is the vector field, check dimension
+        const isVectorField = vectorDataTypes.includes(dataType);
+        const typeParams = field.type_params;
+        if (isVectorField) {
+            const dim = Number((_a = typeParams === null || typeParams === void 0 ? void 0 : typeParams.dim) !== null && _a !== void 0 ? _a : field.dim);
+            if (!dim) {
+                throw new Error(__1.ERROR_REASONS.CREATE_COLLECTION_CHECK_MISS_DIM);
+            }
+            if (dataType === __1.DataType.BinaryVector && dim % 8 !== 0) {
+                throw new Error(__1.ERROR_REASONS.CREATE_COLLECTION_CHECK_BINARY_DIM);
+            }
+            hasVectorField = true;
+        }
+        // if this is a varchar field, check max_length
+        if (dataType === __1.DataType.VarChar) {
+            const maxLength = (_b = typeParams === null || typeParams === void 0 ? void 0 : typeParams.max_length) !== null && _b !== void 0 ? _b : field.max_length;
+            if (!maxLength) {
+                throw new Error(__1.ERROR_REASONS.CREATE_COLLECTION_CHECK_MISS_MAX_LENGTH);
+            }
+        }
+    });
+    // if no primary key field is found, throw error
+    if (!hasPrimaryKey) {
+        throw new Error(__1.ERROR_REASONS.CREATE_COLLECTION_CHECK_PRIMARY_KEY);
+    }
+    // if no vector field is found, throw error
+    if (!hasVectorField) {
+        throw new Error(__1.ERROR_REASONS.CREATE_COLLECTION_CHECK_VECTOR_FIELD_EXIST);
+    }
+    if (partitionKeyCount > __1.MAX_PARTITION_KEY_FIELD_COUNT) {
+        throw new Error(__1.ERROR_REASONS.PARTITION_KEY_FIELD_MAXED_OUT);
+    }
+    return true;
+};
+exports.checkCollectionFields = checkCollectionFields;
+/**
+ * check if the request contains collection_name
+ * otherwise throw an error
+ * @param data
+ */
+const checkCollectionName = (data) => {
+    if (!data || !data.collection_name) {
+        throw new Error(__1.ERROR_REASONS.COLLECTION_NAME_IS_REQUIRED);
+    }
+};
+exports.checkCollectionName = checkCollectionName;
+/**
+ * check if the request contains collection_name and partition_name
+ * otherwise throw an error
+ * @param data
+ */
+const checkCollectionAndPartitionName = (data) => {
+    if (!data || !data.collection_name || !data.partition_name) {
+        throw new Error(__1.ERROR_REASONS.COLLECTION_PARTITION_NAME_ARE_REQUIRED);
+    }
+};
+exports.checkCollectionAndPartitionName = checkCollectionAndPartitionName;
+/**
+ * Checks the validity of search parameters.
+ * @param {Object} data - The search parameters to be checked.
+ * @throws {Error} Throws an error if any of the search parameters are invalid.
+ */
+const checkSearchParams = (data) => {
+    (0, exports.checkCollectionName)(data);
+    if (!data.vectors && !data.vector && !data.data) {
+        throw new Error(__1.ERROR_REASONS.VECTORS_OR_VECTOR_IS_MISSING);
+    }
+};
+exports.checkSearchParams = checkSearchParams;
+/**
+ * Checks if a gRPC status code matches any of the given codes.
+ * DEADLINE_EXCEEDED means that the task wat not completed
+ * UNAVAILABLE means that the service is not reachable currently
+ * Reference: https://grpc.github.io/grpc/python/grpc.html#grpc-status-code
+ *
+ * @param {number} code - The gRPC status code to check.
+ * @param {number[]} [codesToCheck=[grpcStatus.DEADLINE_EXCEEDED, grpcStatus.UNAVAILABLE]] - An array of gRPC status codes to check against.
+ * @returns {boolean} Whether the gRPC status code matches any of the given codes.
+ */
+const isStatusCodeMatched = (code, codesToCheck = [
+    grpc_js_1.status.DEADLINE_EXCEEDED,
+    grpc_js_1.status.UNAVAILABLE,
+    grpc_js_1.status.INTERNAL,
+]) => {
+    return codesToCheck.includes(code);
+};
+exports.isStatusCodeMatched = isStatusCodeMatched;
+/**
+ * Validates the number of partitions.
+ * @param {number} num_partitions - The number of partitions to validate.
+ * @throws {Error} Throws an error if the number of partitions is invalid.
+ */
+const validatePartitionNumbers = (num_partitions) => {
+    if (num_partitions < 1 || num_partitions > __1.MAX_PARTITIONS_NUMBER) {
+        throw new Error(__1.ERROR_REASONS.INVALID_PARTITION_NUM);
+    }
+};
+exports.validatePartitionNumbers = validatePartitionNumbers;
+//# sourceMappingURL=Validate.js.map

package/dist/milvus/utils/Validate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Validate.js","sourceRoot":"","sources":["../../../milvus/utils/Validate.ts"],"names":[],"mappings":";;;AAAA,2BAOa;AACb,2CAAqD;AAErD;;;;;;GAMG;AACI,MAAM,qBAAqB,GAAG,CAAC,MAAmB,EAAE,EAAE;IAC3D,gGAAgG;IAChG,MAAM,eAAe,GAAG,CAAC,YAAQ,CAAC,YAAY,EAAE,YAAQ,CAAC,WAAW,CAAC,CAAC;IACtE,MAAM,iBAAiB,GAAG,CAAC,YAAQ,CAAC,KAAK,EAAE,YAAQ,CAAC,OAAO,CAAC,CAAC;IAE7D,IAAI,aAAa,GAAG,KAAK,CAAC;IAC1B,IAAI,cAAc,GAAG,KAAK,CAAC;IAC3B,IAAI,iBAAiB,GAAG,CAAC,CAAC;IAE1B,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;;QACrB,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE;YACtC,MAAM,IAAI,KAAK,CAAC,iBAAa,CAAC,gCAAgC,CAAC,CAAC;SACjE;QAED,gBAAgB;QAChB,MAAM,QAAQ,GAAG,IAAA,qBAAiB,EAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACpD,MAAM,YAAY,GAAG,KAAK,CAAC,cAAc,CAAC;QAC1C,MAAM,cAAc,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAE9C,IAAI,YAAY,IAAI,iBAAiB,CAAC,QAAQ,CAAC,QAAS,CAAC,EAAE;YACzD,aAAa,GAAG,IAAI,CAAC;SACtB;QAED,0FAA0F;QAC1F,IAAI,cAAc,EAAE;YAClB,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,QAAS,CAAC,IAAI,YAAY,EAAE;gBAC1D,MAAM,IAAI,KAAK,CAAC,iBAAa,CAAC,gCAAgC,CAAC,CAAC;aACjE;SACF;QAED,sDAAsD;QACtD,IAAI,cAAc,EAAE;YAClB,iBAAiB,EAAE,CAAC;SACrB;QAED,+CAA+C;QAC/C,MAAM,aAAa,GAAG,eAAe,CAAC,QAAQ,CAAC,QAAS,CAAC,CAAC;QAC1D,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,aAAa,EAAE;YACjB,MAAM,GAAG,GAAG,MAAM,CAAC,MAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,GAAG,mCAAI,KAAK,CAAC,GAAG,CAAC,CAAC;YACjD,IAAI,CAAC,GAAG,EAAE;gBACR,MAAM,IAAI,KAAK,CAAC,iBAAa,CAAC,gCAAgC,CAAC,CAAC;aACjE;YAED,IAAI,QAAQ,KAAK,YAAQ,CAAC,YAAY,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,EAAE;gBACvD,MAAM,IAAI,KAAK,CAAC,iBAAa,CAAC,kCAAkC,CAAC,CAAC;aACnE;YAED,cAAc,GAAG,IAAI,CAAC;SACvB;QAED,+CAA+C;QAC/C,IAAI,QAAQ,KAAK,YAAQ,CAAC,OAAO,EAAE;YACjC,MAAM,SAAS,GAAG,MAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,UAAU,mCAAI,KAAK,CAAC,UAAU,CAAC;YAC7D,IAAI,CAAC,SAAS,EAAE;gBACd,MAAM,IAAI,KAAK,CAAC,iBAAa,CAAC,uCAAuC,CAAC,CAAC;aACxE;SACF;IACH,CAAC,CAAC,CAAC;IAEH,gDAAgD;IAChD,IAAI,CAAC,aAAa,EAAE;QAClB,MAAM,IAAI,KAAK,CAAC,iBAAa,CAAC,mCAAmC,CAAC,CAAC;KACpE;IAED,2CAA2C;IAC3C,IAAI,CAAC,cAAc,EAAE;QACnB,MAAM,IAAI,KAAK,CAAC,iBAAa,CAAC,0CAA0C,CAAC,CAAC;KAC3E;IAED,IAAI,iBAAiB,GAAG,iCAA6B,EAAE;QACrD,MAAM,IAAI,KAAK,CAAC,iBAAa,CAAC,6BAA6B,CAAC,CAAC;KAC9D;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AA3EW,QAAA,qBAAqB,yBA2EhC;AAEF;;;;GAIG;AACI,MAAM,mBAAmB,GAAG,CAAC,IAAS,EAAE,EAAE;IAC/C,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;QAClC,MAAM,IAAI,KAAK,CAAC,iBAAa,CAAC,2BAA2B,CAAC,CAAC;KAC5D;AACH,CAAC,CAAC;AAJW,QAAA,mBAAmB,uBAI9B;AAEF;;;;GAIG;AACI,MAAM,+BAA+B,GAAG,CAAC,IAAS,EAAE,EAAE;IAC3D,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,eAAe,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;QAC1D,MAAM,IAAI,KAAK,CAAC,iBAAa,CAAC,sCAAsC,CAAC,CAAC;KACvE;AACH,CAAC,CAAC;AAJW,QAAA,+BAA+B,mCAI1C;AAEF;;;;GAIG;AACI,MAAM,iBAAiB,GAAG,CAAC,IAAS,EAAE,EAAE;IAC7C,IAAA,2BAAmB,EAAC,IAAI,CAAC,CAAC;IAE1B,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;QAC/C,MAAM,IAAI,KAAK,CAAC,iBAAa,CAAC,4BAA4B,CAAC,CAAC;KAC7D;AACH,CAAC,CAAC;AANW,QAAA,iBAAiB,qBAM5B;AAEF;;;;;;;;;GASG;AACI,MAAM,mBAAmB,GAAG,CACjC,IAAY,EACZ,eAAyB;IACvB,gBAAU,CAAC,iBAAiB;IAC5B,gBAAU,CAAC,WAAW;IACtB,gBAAU,CAAC,QAAQ;CACpB,EACQ,EAAE;IACX,OAAO,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AACrC,CAAC,CAAC;AATW,QAAA,mBAAmB,uBAS9B;AAEF;;;;GAIG;AACI,MAAM,wBAAwB,GAAG,CAAC,cAAsB,EAAE,EAAE;IACjE,IAAI,cAAc,GAAG,CAAC,IAAI,cAAc,GAAG,yBAAqB,EAAE;QAChE,MAAM,IAAI,KAAK,CAAC,iBAAa,CAAC,qBAAqB,CAAC,CAAC;KACtD;AACH,CAAC,CAAC;AAJW,QAAA,wBAAwB,4BAInC"}

package/dist/{utils → milvus/utils}/index.d.ts

@@ -3,3 +3,5 @@ export * from './Blob';
 export * from './Format';
 export * from './Validate';
 export * from './Function';
+export * from './Function';
+export * from './logger';

package/dist/{utils → milvus/utils}/index.js

@@ -19,4 +19,6 @@ __exportStar(require("./Blob"), exports);
 __exportStar(require("./Format"), exports);
 __exportStar(require("./Validate"), exports);
 __exportStar(require("./Function"), exports);
+__exportStar(require("./Function"), exports);
+__exportStar(require("./logger"), exports);
 //# sourceMappingURL=index.js.map

package/dist/milvus/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../milvus/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAuB;AACvB,yCAAuB;AACvB,2CAAyB;AACzB,6CAA2B;AAC3B,6CAA2B;AAC3B,6CAA2B;AAC3B,2CAAyB"}

package/dist/milvus/utils/logger.d.ts

@@ -0,0 +1 @@
+export declare const logger: import("winston").Logger;

package/dist/milvus/utils/logger.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+const winston_1 = require("winston");
+const level = process.env.NODE_ENV === 'test' || process.env.NODE_ENV === 'development'
+    ? 'debug'
+    : 'info';
+exports.logger = (0, winston_1.createLogger)({
+    transports: [new winston_1.transports.Console()],
+    format: winston_1.format.combine(winston_1.format.colorize(), winston_1.format.timestamp(), winston_1.format.printf(({ timestamp, level, message, service }) => {
+        return `[${timestamp}] ${service} ${level}: ${message}`;
+    })),
+    defaultMeta: {
+        service: 'Milvus-sdk-node',
+    },
+    level,
+});
+//# sourceMappingURL=logger.js.map

package/dist/milvus/utils/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../../milvus/utils/logger.ts"],"names":[],"mappings":";;;AAAA,qCAA2D;AAE3D,MAAM,KAAK,GACT,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa;IACvE,CAAC,CAAC,OAAO;IACT,CAAC,CAAC,MAAM,CAAC;AAEA,QAAA,MAAM,GAAG,IAAA,sBAAY,EAAC;IACjC,UAAU,EAAE,CAAC,IAAI,oBAAU,CAAC,OAAO,EAAE,CAAC;IACtC,MAAM,EAAE,gBAAM,CAAC,OAAO,CACpB,gBAAM,CAAC,QAAQ,EAAE,EACjB,gBAAM,CAAC,SAAS,EAAE,EAClB,gBAAM,CAAC,MAAM,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE;QACvD,OAAO,IAAI,SAAS,KAAK,OAAO,IAAI,KAAK,KAAK,OAAO,EAAE,CAAC;IAC1D,CAAC,CAAC,CACH;IACD,WAAW,EAAE;QACX,OAAO,EAAE,iBAAiB;KAC3B;IACD,KAAK;CACN,CAAC,CAAC"}

package/dist/proto/proto/common.proto

@@ -12,7 +12,6 @@ option csharp_namespace = "IO.Milvus.Grpc";
 
 import "google/protobuf/descriptor.proto";
 
-// Deprecated
 enum ErrorCode {
     Success = 0;
     UnexpectedError = 1;
@@ -72,6 +71,9 @@ enum ErrorCode {
     NotReadyServe = 56;
     // Coord is switching from standby mode to active mode 
     NotReadyCoordActivating = 57;
+
+    NotFoundTSafer = 58;
+
     // Service availability.
     // NA: Not Available.
     DataCoordNA = 100;
@@ -103,7 +105,6 @@ enum SegmentState {
 message Status {
     ErrorCode error_code = 1;
     string reason = 2;
-    int32 code = 3;
 }
 
 message KeyValuePair {
@@ -159,9 +160,7 @@ enum MsgType {
     AlterAlias = 110;
     AlterCollection = 111;
     RenameCollection = 112;
-    DescribeAlias = 113;
-    ListAliases = 114;
-    
+
     /* DEFINITION REQUESTS: PARTITION */
     CreatePartition = 200;
     DropPartition = 201;
@@ -179,8 +178,6 @@ enum MsgType {
     HandoffSegments = 254;
     LoadBalanceSegments = 255;
     DescribeSegments = 256;
-    FederListIndexedSegment = 257;
-    FederDescribeSegmentIndexData = 258;
 
     /* DEFINITION REQUESTS: INDEX */
     CreateIndex = 300;
@@ -193,7 +190,6 @@ enum MsgType {
     Delete = 401;
     Flush = 402;
     ResendSegmentStats = 403;
-    Upsert = 404;
 
     /* QUERY */
     Search = 500;
@@ -233,6 +229,8 @@ enum MsgType {
     SegmentFlushDone = 1207;
 
     DataNodeTt = 1208;
+    Connect = 1209;
+    ListClientInfos = 1210;
 
     /* Credential */
     CreateCredential = 1500;
@@ -260,6 +258,11 @@ enum MsgType {
     DescribeResourceGroup = 1703;
     TransferNode = 1704;
     TransferReplica = 1705;
+
+    /* Database group */
+    CreateDatabase = 1801;
+    DropDatabase = 1802;
+    ListDatabases = 1803;
 }
 
 message MsgBase {
@@ -304,8 +307,7 @@ enum ImportState {
     ImportPending = 0;              // the task in in pending list of rootCoord, waiting to be executed
     ImportFailed = 1;               // the task failed for some reason, get detail reason from GetImportStateResponse.infos
     ImportStarted = 2;              // the task has been sent to datanode to execute
-    ImportPersisted = 5;            // all data files have been parsed and all meta data already persisted, ready to be flushed.
-    ImportFlushed = 8;              // all segments are successfully flushed.
+    ImportPersisted = 5;            // all data files have been parsed and data already persisted
     ImportCompleted = 6;            // all indexes are successfully built and segments are able to be compacted as normal.
     ImportFailedAndCleaned = 7;     // the task failed and all segments it generated are cleaned up.
 }
@@ -343,7 +345,7 @@ enum ObjectPrivilege {
     PrivilegeSelectOwnership = 22;
     PrivilegeManageOwnership = 23;
     PrivilegeSelectUser = 24;
-    PrivilegeUpsert = 25;
+
     PrivilegeCreateResourceGroup = 26;
     PrivilegeDropResourceGroup = 27;
     PrivilegeDescribeResourceGroup = 28;
@@ -352,6 +354,11 @@ enum ObjectPrivilege {
     PrivilegeTransferReplica = 31;
     PrivilegeGetLoadingProgress = 32;
     PrivilegeGetLoadState = 33;
+
+    PrivilegeRenameCollection = 34;
+    PrivilegeCreateDatabase = 35;
+    PrivilegeDropDatabase = 36;
+    PrivilegeListDatabases = 37;
 }
 
 message PrivilegeExt {
@@ -380,7 +387,24 @@ enum LoadState {
     LoadStateLoaded = 3;
 }
 
-message SegmentStats {
-    int64 SegmentID = 1;
-    int64 NumRows = 2;
+message ClientInfo {
+    // sdk_type can be `python`, `golang`, `nodejs` and etc. It's not proper to make `sdk_type` an
+    // enumerate type, since we cannot always update the enum value everytime when newly sdk is supported.
+    string sdk_type = 1;
+    string sdk_version = 2;
+    string local_time = 3;
+    string user = 4;
+    string host = 5;
+    // reserved for newly-added feature if necessary.
+    map<string, string> reserved = 6;
+}
+
+message ServerInfo {
+    string build_tags = 1;
+    string build_time = 2;
+    string git_commit = 3;
+    string go_version = 4;
+    string deploy_mode = 5;
+    // reserved for newly-added feature if necessary.
+    map<string, string> reserved = 6;
 }

package/dist/proto/proto/google/protobuf/descriptor.proto

@@ -159,10 +159,9 @@ message ExtensionRangeOptions {
     optional bool repeated = 6;
   }
 
-  // go/protobuf-stripping-extension-declarations
-  // Like Metadata, but we use a repeated field to hold all extension
-  // declarations. This should avoid the size increases of transforming a large
-  // extension range into small ranges in generated binaries.
+  // For external users: DO NOT USE. We are in the process of open sourcing
+  // extension declaration and executing internal cleanups before it can be
+  // used externally.
   repeated Declaration declaration = 2 [retention = RETENTION_SOURCE];
 
   // The verification state of the extension range.
@@ -768,6 +767,11 @@ message EnumValueOptions {
   // this is a formalization for deprecating enum values.
   optional bool deprecated = 1 [default = false];
 
+  // Indicate that fields annotated with this enum value should not be printed
+  // out when using debug formats, e.g. when the field contains sensitive
+  // credentials.
+  optional bool debug_redact = 3 [default = false];
+
   // The parser stores options it doesn't recognize here. See above.
   repeated UninterpretedOption uninterpreted_option = 999;