@zilliz/milvus2-sdk-node 2.2.10 → 2.2.11

package/dist/milvus/const/highLevel.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_HIGH_LEVEL_INDEX_PARAMS = exports.DEFAULT_HIGH_LEVEL_SCHEMA = void 0;
+const _1 = require("./");
+const DEFAULT_HIGH_LEVEL_SCHEMA = (dimension) => [
+    {
+        name: 'id',
+        data_type: _1.DataType.Int64,
+        is_primary_key: true,
+        autoID: false,
+    },
+    {
+        name: 'vector',
+        data_type: _1.DataType.FloatVector,
+        dim: dimension,
+    },
+];
+exports.DEFAULT_HIGH_LEVEL_SCHEMA = DEFAULT_HIGH_LEVEL_SCHEMA;
+const DEFAULT_HIGH_LEVEL_INDEX_PARAMS = (field_name) => ({
+    field_name,
+    index_type: 'HNSW',
+    metric_type: 'L2',
+    params: { efConstruction: 10, M: 4 },
+});
+exports.DEFAULT_HIGH_LEVEL_INDEX_PARAMS = DEFAULT_HIGH_LEVEL_INDEX_PARAMS;
+//# sourceMappingURL=highLevel.js.map

package/dist/milvus/const/highLevel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"highLevel.js","sourceRoot":"","sources":["../../../milvus/const/highLevel.ts"],"names":[],"mappings":";;;AAAA,yBAA8B;AAEvB,MAAM,yBAAyB,GAAG,CAAC,SAAiB,EAAE,EAAE,CAAC;IAC9D;QACE,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,WAAQ,CAAC,KAAK;QACzB,cAAc,EAAE,IAAI;QACpB,MAAM,EAAE,KAAK;KACd;IACD;QACE,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,WAAQ,CAAC,WAAW;QAC/B,GAAG,EAAE,SAAS;KACf;CACF,CAAC;AAZW,QAAA,yBAAyB,6BAYpC;AAEK,MAAM,+BAA+B,GAAG,CAAC,UAAkB,EAAE,EAAE,CAAC,CAAC;IACtE,UAAU;IACV,UAAU,EAAE,MAAM;IAClB,WAAW,EAAE,IAAI;IACjB,MAAM,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE;CACrC,CAAC,CAAC;AALU,QAAA,+BAA+B,mCAKzC"}

package/dist/milvus/const/index.d.ts

@@ -1,2 +1,5 @@
-export * from './ErrorReason';
 export * from './Milvus';
+export * from './limits';
+export * from './defaults';
+export * from './ErrorReason';
+export * from './client';

package/dist/milvus/const/index.js

@@ -15,6 +15,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 // consts
-__exportStar(require("./ErrorReason"), exports);
 __exportStar(require("./Milvus"), exports);
+__exportStar(require("./limits"), exports);
+__exportStar(require("./defaults"), exports);
+__exportStar(require("./ErrorReason"), exports);
+__exportStar(require("./client"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../milvus/const/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,SAAS;AACT,gDAA8B;AAC9B,2CAAyB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../milvus/const/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,SAAS;AACT,2CAAyB;AACzB,2CAAyB;AACzB,6CAA2B;AAC3B,gDAA8B;AAC9B,2CAAyB"}

package/dist/milvus/const/limits.d.ts

@@ -0,0 +1,2 @@
+export declare const MAX_PARTITION_KEY_FIELD_COUNT = 1;
+export declare const MAX_PARTITIONS_NUMBER = 4096;

package/dist/milvus/const/limits.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MAX_PARTITIONS_NUMBER = exports.MAX_PARTITION_KEY_FIELD_COUNT = void 0;
+// limits
+exports.MAX_PARTITION_KEY_FIELD_COUNT = 1;
+exports.MAX_PARTITIONS_NUMBER = 4096;
+//# sourceMappingURL=limits.js.map

package/dist/milvus/const/limits.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"limits.js","sourceRoot":"","sources":["../../../milvus/const/limits.ts"],"names":[],"mappings":";;;AAAA,SAAS;AACI,QAAA,6BAA6B,GAAG,CAAC,CAAC;AAClC,QAAA,qBAAqB,GAAG,IAAI,CAAC"}

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

@@ -1,16 +1,25 @@
-import { Root } from 'protobufjs';
+import { Root, Type } from 'protobufjs';
 import { Client, ChannelOptions } from '@grpc/grpc-js';
-import { ClientConfig } from '..';
+import { ClientConfig, ServerInfo } from '../';
 /**
  * Base gRPC client, setup all configuration here
  */
 export declare class BaseClient {
-    client: Client | undefined;
-    protoPath: string;
-    schemaProto: Root;
-    milvusProto: Root;
+    protected metadata: Map<string, string>;
+    protected protoPath: string;
+    protected schemaProto: Root;
+    protected milvusProto: Root;
+    protected collectionSchemaType: Type;
+    protected fieldSchemaType: Type;
+    protected protoInternalPath: {
+        serviceName: string;
+        collectionSchema: string;
+        fieldSchema: string;
+    };
     config: ClientConfig;
-    serviceName: string;
+    channelOptions: ChannelOptions;
+    client: Client | undefined;
+    serverInfo: ServerInfo;
     timeout: number;
     /**
      * Sets up the configuration object for the gRPC client.

package/dist/milvus/grpc/BaseClient.js

@@ -4,17 +4,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseClient = void 0;
-var path_1 = __importDefault(require("path"));
-var protobufjs_1 = __importDefault(require("protobufjs"));
-var __1 = require("..");
-var utils_1 = require("../../utils");
+const path_1 = __importDefault(require("path"));
+const protobufjs_1 = __importDefault(require("protobufjs"));
+const __1 = require("../");
 // path
-var protoPath = path_1.default.resolve(__dirname, '../../proto/proto/milvus.proto');
-var schemaProtoPath = path_1.default.resolve(__dirname, '../../proto/proto/schema.proto');
+const protoPath = path_1.default.resolve(__dirname, '../../proto/proto/milvus.proto');
+const schemaProtoPath = path_1.default.resolve(__dirname, '../../proto/proto/schema.proto');
 /**
  * Base gRPC client, setup all configuration here
  */
-var BaseClient = /** @class */ (function () {
+class BaseClient {
     /**
      * Sets up the configuration object for the gRPC client.
      *
@@ -23,12 +22,20 @@ var BaseClient = /** @class */ (function () {
      * @param username The username for authentication. Required if password is provided.
      * @param password The password for authentication. Required if username is provided.
      */
-    function BaseClient(configOrAddress, ssl, username, password, channelOptions) {
-        // The name of the Milvus service.
-        this.serviceName = 'milvus.proto.milvus.MilvusService';
+    constructor(configOrAddress, ssl, username, password, channelOptions) {
+        // metadata
+        this.metadata = new Map();
+        // milvus proto
+        this.protoInternalPath = {
+            serviceName: 'milvus.proto.milvus.MilvusService',
+            collectionSchema: 'milvus.proto.schema.CollectionSchema',
+            fieldSchema: 'milvus.proto.schema.FieldSchema',
+        };
+        // server info
+        this.serverInfo = {};
         // The timeout for connecting to the Milvus service.
         this.timeout = __1.DEFAULT_CONNECT_TIMEOUT;
-        var config;
+        let config;
         // If a configuration object is provided, use it. Otherwise, create a new object with the provided parameters.
         if (typeof configOrAddress === 'object') {
             config = configOrAddress;
@@ -36,29 +43,41 @@ var BaseClient = /** @class */ (function () {
         else {
             config = {
                 address: configOrAddress,
-                ssl: ssl,
-                username: username,
-                password: password,
-                channelOptions: channelOptions,
+                ssl,
+                username,
+                password,
+                channelOptions,
             };
         }
         // Check if the Milvus address is set.
         if (!config.address) {
             throw new Error(__1.ERROR_REASONS.MILVUS_ADDRESS_IS_REQUIRED);
         }
+        // if the address starts with https, no need to set the ssl
+        config.ssl = config.address.startsWith('https://') || !!config.ssl;
+        // make sure these are strings
+        config.username = config.username || '';
+        config.password = config.password || '';
         // Assign the configuration object.
         this.config = config;
         // Load the Milvus protobuf.
         this.protoPath = protoPath;
         this.schemaProto = protobufjs_1.default.loadSync(schemaProtoPath);
         this.milvusProto = protobufjs_1.default.loadSync(protoPath);
+        // Get the CollectionSchemaType and FieldSchemaType from the schemaProto object.
+        this.collectionSchemaType = this.schemaProto.lookupType(this.protoInternalPath.collectionSchema);
+        this.fieldSchemaType = this.schemaProto.lookupType(this.protoInternalPath.fieldSchema);
+        // options
+        this.channelOptions = Object.assign({ 
+            // Milvus default max_receive_message_length is 100MB, but Milvus support change max_receive_message_length .
+            // So SDK should support max_receive_message_length unlimited.
+            'grpc.max_receive_message_length': -1, 'grpc.max_send_message_length': -1, 'grpc.keepalive_time_ms': 10 * 1000, 'grpc.keepalive_timeout_ms': 5 * 1000, 'grpc.keepalive_permit_without_calls': 1, 'grpc.enable_retries': 1 }, this.config.channelOptions);
         // Set up the timeout for connecting to the Milvus service.
         this.timeout =
             typeof config.timeout === 'string'
-                ? (0, utils_1.parseTimeToken)(config.timeout)
+                ? (0, __1.parseTimeToken)(config.timeout)
                 : config.timeout || __1.DEFAULT_CONNECT_TIMEOUT;
     }
-    return BaseClient;
-}());
+}
 exports.BaseClient = BaseClient;
 //# sourceMappingURL=BaseClient.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"BaseClient.js","sourceRoot":"","sources":["../../../milvus/grpc/BaseClient.ts"],"names":[],"mappings":";;;;;;AAAA,8CAAwB;AACxB,0DAA4C;AAE5C,wBAA0E;AAC1E,qCAA6C;AAE7C,OAAO;AACP,IAAM,SAAS,GAAG,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,gCAAgC,CAAC,CAAC;AAC5E,IAAM,eAAe,GAAG,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,gCAAgC,CAAC,CAAC;AAElF;;GAEG;AACH;IAiBE;;;;;;;OAOG;IACH,oBACE,eAAsC,EACtC,GAAa,EACb,QAAiB,EACjB,QAAiB,EACjB,cAA+B;QAnBjC,kCAAkC;QAClC,gBAAW,GAAW,mCAAmC,CAAC;QAE1D,oDAAoD;QACpD,YAAO,GAAW,2BAAuB,CAAC;QAiBxC,IAAI,MAAoB,CAAC;QAEzB,8GAA8G;QAC9G,IAAI,OAAO,eAAe,KAAK,QAAQ,EAAE;YACvC,MAAM,GAAG,eAAe,CAAC;SAC1B;aAAM;YACL,MAAM,GAAG;gBACP,OAAO,EAAE,eAAe;gBACxB,GAAG,KAAA;gBACH,QAAQ,UAAA;gBACR,QAAQ,UAAA;gBACR,cAAc,gBAAA;aACf,CAAC;SACH;QAED,sCAAsC;QACtC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,iBAAa,CAAC,0BAA0B,CAAC,CAAC;SAC3D;QAED,mCAAmC;QACnC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,4BAA4B;QAC5B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,WAAW,GAAG,oBAAQ,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;QACtD,IAAI,CAAC,WAAW,GAAG,oBAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAEhD,2DAA2D;QAC3D,IAAI,CAAC,OAAO;YACV,OAAO,MAAM,CAAC,OAAO,KAAK,QAAQ;gBAChC,CAAC,CAAC,IAAA,sBAAc,EAAC,MAAM,CAAC,OAAO,CAAC;gBAChC,CAAC,CAAC,MAAM,CAAC,OAAO,IAAI,2BAAuB,CAAC;IAClD,CAAC;IACH,iBAAC;AAAD,CAAC,AAjED,IAiEC;AAjEY,gCAAU"}
+{"version":3,"file":"BaseClient.js","sourceRoot":"","sources":["../../../milvus/grpc/BaseClient.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AACxB,4DAAkD;AAElD,2BAMa;AAEb,OAAO;AACP,MAAM,SAAS,GAAG,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,gCAAgC,CAAC,CAAC;AAC5E,MAAM,eAAe,GAAG,cAAI,CAAC,OAAO,CAClC,SAAS,EACT,gCAAgC,CACjC,CAAC;AAEF;;GAEG;AACH,MAAa,UAAU;IAiCrB;;;;;;;OAOG;IACH,YACE,eAAsC,EACtC,GAAa,EACb,QAAiB,EACjB,QAAiB,EACjB,cAA+B;QA7CjC,WAAW;QACD,aAAQ,GAAwB,IAAI,GAAG,EAAkB,CAAC;QAYpE,eAAe;QACL,sBAAiB,GAAG;YAC5B,WAAW,EAAE,mCAAmC;YAChD,gBAAgB,EAAE,sCAAsC;YACxD,WAAW,EAAE,iCAAiC;SAC/C,CAAC;QAQF,cAAc;QACP,eAAU,GAAe,EAAE,CAAC;QAEnC,oDAAoD;QAC7C,YAAO,GAAW,2BAAuB,CAAC;QAiB/C,IAAI,MAAoB,CAAC;QAEzB,8GAA8G;QAC9G,IAAI,OAAO,eAAe,KAAK,QAAQ,EAAE;YACvC,MAAM,GAAG,eAAe,CAAC;SAC1B;aAAM;YACL,MAAM,GAAG;gBACP,OAAO,EAAE,eAAe;gBACxB,GAAG;gBACH,QAAQ;gBACR,QAAQ;gBACR,cAAc;aACf,CAAC;SACH;QAED,sCAAsC;QACtC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,iBAAa,CAAC,0BAA0B,CAAC,CAAC;SAC3D;QAED,2DAA2D;QAC3D,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;QACnE,8BAA8B;QAC9B,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,EAAE,CAAC;QACxC,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,EAAE,CAAC;QAExC,mCAAmC;QACnC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,4BAA4B;QAC5B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,WAAW,GAAG,oBAAQ,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;QACtD,IAAI,CAAC,WAAW,GAAG,oBAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAEhD,gFAAgF;QAChF,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CACrD,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,CACxC,CAAC;QACF,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAChD,IAAI,CAAC,iBAAiB,CAAC,WAAW,CACnC,CAAC;QAEF,UAAU;QACV,IAAI,CAAC,cAAc;YACjB,6GAA6G;YAC7G,8DAA8D;YAC9D,iCAAiC,EAAE,CAAC,CAAC,EACrC,8BAA8B,EAAE,CAAC,CAAC,EAClC,wBAAwB,EAAE,EAAE,GAAG,IAAI,EACnC,2BAA2B,EAAE,CAAC,GAAG,IAAI,EACrC,qCAAqC,EAAE,CAAC,EACxC,qBAAqB,EAAE,CAAC,IACrB,IAAI,CAAC,MAAM,CAAC,cAAc,CAC9B,CAAC;QAEF,2DAA2D;QAC3D,IAAI,CAAC,OAAO;YACV,OAAO,MAAM,CAAC,OAAO,KAAK,QAAQ;gBAChC,CAAC,CAAC,IAAA,kBAAc,EAAC,MAAM,CAAC,OAAO,CAAC;gBAChC,CAAC,CAAC,MAAM,CAAC,OAAO,IAAI,2BAAuB,CAAC;IAClD,CAAC;CACF;AA5GD,gCA4GC"}

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

@@ -1,9 +1,9 @@
-import { BaseClient } from './BaseClient';
-import { CreateCollectionReq, DescribeCollectionReq, DropCollectionReq, GetCollectionStatisticsReq, LoadCollectionReq, ReleaseLoadCollectionReq, ShowCollectionsReq, HasCollectionReq, CreateAliasReq, DropAliasReq, AlterAliasReq, CompactReq, GetCompactionStateReq, GetCompactionPlansReq, GetReplicaReq, RenameCollectionReq, GetLoadingProgressReq, GetLoadStateReq, BoolResponse, ResStatus, CompactionResponse, DescribeCollectionResponse, GetCompactionPlansResponse, GetCompactionStateResponse, ShowCollectionsResponse, StatisticsResponse, ReplicasResponse, GetLoadingProgressResponse, GetLoadStateResponse } from '..';
+import { Database } from './Database';
+import { CreateCollectionReq, DescribeCollectionReq, DropCollectionReq, GetCollectionStatisticsReq, LoadCollectionReq, ReleaseLoadCollectionReq, ShowCollectionsReq, HasCollectionReq, CreateAliasReq, DropAliasReq, AlterAliasReq, CompactReq, GetCompactionStateReq, GetCompactionPlansReq, GetReplicaReq, RenameCollectionReq, GetLoadingProgressReq, GetLoadStateReq, BoolResponse, ResStatus, CompactionResponse, DescribeCollectionResponse, GetCompactionPlansResponse, GetCompactionStateResponse, ShowCollectionsResponse, StatisticsResponse, ReplicasResponse, GetLoadingProgressResponse, GetLoadStateResponse } from '../';
 /**
  * @see [collection operation examples](https://github.com/milvus-io/milvus-sdk-node/blob/main/example/Collection.ts)
  */
-export declare class Collection extends BaseClient {
+export declare class Collection extends Database {
     /**
      * Create a collection in Milvus.
      *
@@ -12,6 +12,7 @@ export declare class Collection extends BaseClient {
      *  | :-- | :-- | :-- |
      *  | 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 |
@@ -98,6 +99,7 @@ export declare class Collection extends BaseClient {
    * ```
    */
     showCollections(data?: ShowCollectionsReq): Promise<ShowCollectionsResponse>;
+    list_collections: (data?: ShowCollectionsReq) => Promise<ShowCollectionsResponse>;
     /**
      * Show the details of a collection, e.g. name, schema.
      *
@@ -279,6 +281,7 @@ export declare class Collection extends BaseClient {
      * ```
      */
     dropCollection(data: DropCollectionReq): Promise<ResStatus>;
+    drop_collection: (data: DropCollectionReq) => Promise<ResStatus>;
     /**
      * Create collection alias, then you can use alias instead of collection_name when you do vector search
      *
@@ -526,4 +529,30 @@ export declare class Collection extends BaseClient {
      * ```
      */
     getLoadState(data: GetLoadStateReq): Promise<GetLoadStateResponse>;
+    listCollections: (data?: ShowCollectionsReq) => Promise<ShowCollectionsResponse>;
+    /**
+     * 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: DescribeCollectionReq): Promise<string>;
 }