@zilliz/milvus2-sdk-node 2.2.4 → 2.2.6

package/README.md

@@ -29,32 +29,15 @@ The following collection shows Milvus versions and recommended @zilliz/milvus2-s
 npm install @zilliz/milvus2-sdk-node
 ```
 
-## SDK
-
-- [Client](./milvus/Index.ts)
-- [Collection](./milvus/Collection.ts)
-- [Index](./milvus/MilvusIndex.ts)
-  - [FLAT](https://github.com/milvus-io/milvus-sdk-node/blob/main/test/Index.spec.ts#L63)
-  - [IVF_FLAT](https://github.com/milvus-io/milvus-sdk-node/blob/main/test/Index.spec.ts#L76)
-  - [IVF_SQ8](https://github.com/milvus-io/milvus-sdk-node/blob/main/test/Index.spec.ts#L91)
-  - [IVF_PQ](https://github.com/milvus-io/milvus-sdk-node/blob/main/test/Index.spec.ts#L106)
-  - [HNSW](https://github.com/milvus-io/milvus-sdk-node/blob/main/test/Index.spec.ts#L121)
-  - [ANNOY](https://github.com/milvus-io/milvus-sdk-node/blob/main/test/Index.spec.ts#L136)
-  - DISKANN (not supported yet)
-- [Partition](./milvus/Partition.ts)
-- [User](./milvus/User.ts)
-- [Utils](./milvus/Utils.ts)
-- [Data](./milvus/Data.ts)
-
 More documentation, you can refer [Milvus offical website](https://milvus.io/).
 
 ## Example
 
 1. [Hello World](https://github.com/milvus-io/milvus-sdk-node/blob/main/example/HelloMilvus.ts)
-2. [How to operate collection](https://github.com/milvus-io/milvus-sdk-node/blob/main/example/Collection.ts)
-3. [How to insert data](https://github.com/milvus-io/milvus-sdk-node/blob/main/example/Insert.ts)
-4. [Vector similarity search on float field](https://github.com/milvus-io/milvus-sdk-node/blob/main/example/Search.ts)
-5. [Vector similarity search on binary field](https://github.com/milvus-io/milvus-sdk-node/blob/main/example/BinarySearch.ts)
+2. [Create a collection](https://milvus.io/docs/create_collection.md)
+3. [Insert data](https://milvus.io/docs/insert_data.md)
+4. [Build index](https://milvus.io/docs/build_index.md)
+5. [Do vector search](https://milvus.io/docs/search.md)
 
 ## How to contribute
 

package/dist/milvus/BaseClient.d.ts

@@ -0,0 +1,17 @@
+import { Root } from 'protobufjs';
+import { Client } from '@grpc/grpc-js';
+export declare class BaseClient {
+    schemaProto: Root;
+    milvusProto: Root;
+    grpcClient: Client;
+    /**
+     * Connect to milvus grpc client.
+     *
+     * @param address milvus address like: 127.0.0.1:19530
+     * @param ssl ssl connect or not, default is false
+     * @param username After created user in Milvus, username is required
+     * @param password After created user in Milvus, password is required
+     *
+     */
+    constructor(address: string, ssl?: boolean, username?: string, password?: string);
+}

package/dist/milvus/BaseClient.js

@@ -0,0 +1,58 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseClient = void 0;
+var path_1 = __importDefault(require("path"));
+var protobufjs_1 = __importDefault(require("protobufjs"));
+var grpc_js_1 = require("@grpc/grpc-js");
+var _1 = require(".");
+var utils_1 = require("../utils");
+// pathes
+var protoPath = path_1.default.resolve(__dirname, '../proto/proto/milvus.proto');
+var schemaProtoPath = path_1.default.resolve(__dirname, '../proto/proto/schema.proto');
+// Base Client
+var BaseClient = /** @class */ (function () {
+    /**
+     * Connect to milvus grpc client.
+     *
+     * @param address milvus address like: 127.0.0.1:19530
+     * @param ssl ssl connect or not, default is false
+     * @param username After created user in Milvus, username is required
+     * @param password After created user in Milvus, password is required
+     *
+     */
+    function BaseClient(address, ssl, username, password) {
+        // check if address is set
+        if (!address) {
+            throw new Error(_1.ERROR_REASONS.MILVUS_ADDRESS_IS_REQUIRED);
+        }
+        // if we need to create auth interceptors
+        var needAuth = username !== undefined && password !== undefined;
+        // get Milvus GRPC service
+        var MilvusService = (0, utils_1.getGRPCService)({
+            protoPath: protoPath,
+            serviceName: 'milvus.proto.milvus.MilvusService', // the name of the Milvus service
+        });
+        // create interceptors
+        var interceptors = needAuth
+            ? (0, utils_1.getAuthInterceptor)(username, password)
+            : null;
+        // load proto
+        this.schemaProto = protobufjs_1.default.loadSync(schemaProtoPath);
+        this.milvusProto = protobufjs_1.default.loadSync(protoPath);
+        // create grpc client
+        this.grpcClient = new MilvusService((0, utils_1.formatAddress)(address), // format the address
+        ssl ? grpc_js_1.credentials.createSsl() : grpc_js_1.credentials.createInsecure(), // create SSL or insecure credentials
+        {
+            interceptors: [interceptors],
+            // 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, // set max_receive_message_length to unlimited
+        });
+    }
+    return BaseClient;
+}());
+exports.BaseClient = BaseClient;
+//# sourceMappingURL=BaseClient.js.map

package/dist/milvus/BaseClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseClient.js","sourceRoot":"","sources":["../../milvus/BaseClient.ts"],"names":[],"mappings":";;;;;;AAAA,8CAAwB;AACxB,0DAA4C;AAC5C,yCAAoD;AACpD,sBAAkC;AAClC,kCAA6E;AAE7E,SAAS;AACT,IAAM,SAAS,GAAG,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,6BAA6B,CAAC,CAAC;AACzE,IAAM,eAAe,GAAG,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,6BAA6B,CAAC,CAAC;AAE/E,cAAc;AACd;IAQE;;;;;;;;OAQG;IACH,oBACE,OAAe,EACf,GAAa,EACb,QAAiB,EACjB,QAAiB;QAEjB,0BAA0B;QAC1B,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,gBAAa,CAAC,0BAA0B,CAAC,CAAC;SAC3D;QAED,yCAAyC;QACzC,IAAM,QAAQ,GAAG,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,SAAS,CAAC;QAElE,0BAA0B;QAC1B,IAAM,aAAa,GAAG,IAAA,sBAAc,EAAC;YACnC,SAAS,WAAA;YACT,WAAW,EAAE,mCAAmC,EAAE,iCAAiC;SACpF,CAAC,CAAC;QAEH,sBAAsB;QACtB,IAAM,YAAY,GAAG,QAAQ;YAC3B,CAAC,CAAC,IAAA,0BAAkB,EAAC,QAAQ,EAAE,QAAQ,CAAC;YACxC,CAAC,CAAC,IAAI,CAAC;QAET,aAAa;QACb,IAAI,CAAC,WAAW,GAAG,oBAAQ,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;QACtD,IAAI,CAAC,WAAW,GAAG,oBAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAEhD,qBAAqB;QACrB,IAAI,CAAC,UAAU,GAAG,IAAI,aAAa,CACjC,IAAA,qBAAa,EAAC,OAAO,CAAC,EAAE,qBAAqB;QAC7C,GAAG,CAAC,CAAC,CAAC,qBAAW,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,qBAAW,CAAC,cAAc,EAAE,EAAE,qCAAqC;QACnG;YACE,YAAY,EAAE,CAAC,YAAY,CAAC;YAC5B,6GAA6G;YAC7G,8DAA8D;YAC9D,iCAAiC,EAAE,CAAC,CAAC,EAAE,8CAA8C;SACtF,CACF,CAAC;IACJ,CAAC;IACH,iBAAC;AAAD,CAAC,AA1DD,IA0DC;AA1DY,gCAAU"}

package/dist/milvus/Collection.d.ts

@@ -1,11 +1,9 @@
-import { Client } from './Client';
-import { CreateCollectionReq, DescribeCollectionReq, DropCollectionReq, GetCollectionStatisticsReq, LoadCollectionReq, ReleaseLoadCollectionReq, ShowCollectionsReq, HasCollectionReq, CreateAliasReq, DropAliasReq, AlterAliasReq, CompactReq, GetCompactionStateReq, GetCompactionPlansReq, GetReplicaReq, RenameCollectionReq, BoolResponse, ResStatus, CompactionResponse, DescribeCollectionResponse, GetCompactionPlansResponse, GetCompactionStateResponse, ShowCollectionsResponse, StatisticsResponse, ReplicasResponse } from './types';
+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 '.';
 /**
  * @see [collection operation examples](https://github.com/milvus-io/milvus-sdk-node/blob/main/example/Collection.ts)
  */
-export declare class Collection extends Client {
-    private readonly _protoRoot;
-    constructor(client: any);
+export declare class Collection extends BaseClient {
     /**
      * Create a collection in Milvus.
      *
@@ -27,7 +25,7 @@ export declare class Collection extends Client {
      * #### Example
      *
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).collectionManager.createCollection({
+     *  new milvusClient(MILUVS_ADDRESS).createCollection({
      *    collection_name: 'my_collection',
      *    fields: [
      *      {
@@ -51,54 +49,54 @@ export declare class Collection extends Client {
      */
     createCollection(data: CreateCollectionReq): Promise<ResStatus>;
     /**
-     * Check if a collection exists.
-     *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | collection_name | String | Collection name |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
-     *
-     * @returns
-     *  | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | value | `true` or `false` |
-    
-     *
-     * #### Example
-     *
-     * ```
-     *  new milvusClient(MILUVS_ADDRESS).collectionManager.hasCollection({
-     *     collection_name: 'my_collection',
-     *  });
-     * ```
-     */
+   * Check if a collection exists.
+   *
+   * @param data
+   *  | Property | Type | Description |
+   *  | :-- | :-- | :-- |
+   *  | collection_name | String | Collection name |
+   *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+   *
+   * @returns
+   *  | Property | Description |
+   *  | :-- | :-- |
+   *  | status | { error_code: number, reason: string } |
+   *  | value | `true` or `false` |
+  
+   *
+   * #### Example
+   *
+   * ```
+   *  new milvusClient(MILUVS_ADDRESS).hasCollection({
+   *     collection_name: 'my_collection',
+   *  });
+   * ```
+   */
     hasCollection(data: HasCollectionReq): Promise<BoolResponse>;
     /**
-     * List all collections or get collection loading status.
-     *
-     * @param data
-     *  | Property | Type | Description |
-     *  | :-- | :-- | :-- |
-     *  | type(optional) | enum | All -> 0, Loaded -> 1 |
-     *  | collection_names(optional) | String[] | If `type = Loaded`, Milvus will return `collection_names inMemory_percentages` |
-     *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+   * List all collections or get collection loading status.
+   *
+   * @param data
+   *  | Property | Type | Description |
+   *  | :-- | :-- | :-- |
+   *  | type(optional) | enum | All -> 0, Loaded -> 1 |
+   *  | collection_names(optional) | String[] | If `type = Loaded`, Milvus will return `collection_names inMemory_percentages` |
+   *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
   
-     *
-     * @returns
-     * | Property | Description |
-     *  | :-- | :-- |
-     *  | status | { error_code: number, reason: string } |
-     *  | data |  Contains collection name, ID , timestamp (UTC created time), and loadedPercentage (100 means loaded) |
-     *
-     *
-     * #### Example
-     *
-     * ```
-     *  new milvusClient(MILUVS_ADDRESS).collectionManager.showCollections();
-     * ```
-     */
+   *
+   * @returns
+   * | Property | Description |
+   *  | :-- | :-- |
+   *  | status | { error_code: number, reason: string } |
+   *  | data |  Contains collection name, ID , timestamp (UTC created time), and loadedPercentage (100 means loaded) |
+   *
+   *
+   * #### Example
+   *
+   * ```
+   *  new milvusClient(MILUVS_ADDRESS).showCollections();
+   * ```
+   */
     showCollections(data?: ShowCollectionsReq): Promise<ShowCollectionsResponse>;
     /**
      * Show the details of a collection, e.g. name, schema.
@@ -120,7 +118,7 @@ export declare class Collection extends Client {
      * #### Example
      *
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).collectionManager.describeCollection({
+     *  new milvusClient(MILUVS_ADDRESS).describeCollection({
      *    collection_name: 'my_collection',
      *  });
      * ```
@@ -146,7 +144,7 @@ export declare class Collection extends Client {
      * #### Example
      *
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).collectionManager.getCollectionStatistics({
+     *  new milvusClient(MILUVS_ADDRESS).getCollectionStatistics({
      *    collection_name: 'my_collection',
      *  });
      * ```
@@ -173,7 +171,7 @@ export declare class Collection extends Client {
      * #### Example
      *
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).collectionManager.loadCollection({
+     *  new milvusClient(MILUVS_ADDRESS).loadCollection({
      *    collection_name: 'my_collection',
      *  });
      * ```
@@ -200,7 +198,7 @@ export declare class Collection extends Client {
      * #### Example
      *
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).collectionManager.loadCollectionSync({
+     *  new milvusClient(MILUVS_ADDRESS).loadCollectionSync({
      *    collection_name: 'my_collection',
      *  });
      * ```
@@ -225,7 +223,7 @@ export declare class Collection extends Client {
      * #### Example
      *
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).collectionManager.releaseCollection({
+     *  new milvusClient(MILUVS_ADDRESS).releaseCollection({
      *    collection_name: 'my_collection',
      *  });
      * ```
@@ -250,7 +248,7 @@ export declare class Collection extends Client {
      * #### Example
      *
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).collectionManager.renameCollection({
+     *  new milvusClient(MILUVS_ADDRESS).renameCollection({
      *    collection_name: 'my_collection',
      *    new_collection_name: 'my_new_collection'
      *  });
@@ -275,7 +273,7 @@ export declare class Collection extends Client {
      * #### Example
      *
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).collectionManager.dropCollection({
+     *  new milvusClient(MILUVS_ADDRESS).dropCollection({
      *    collection_name: 'my_collection',
      *  });
      * ```
@@ -301,7 +299,7 @@ export declare class Collection extends Client {
      * #### Example
      *
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).collectionManager.createAlias({
+     *  new milvusClient(MILUVS_ADDRESS).createAlias({
      *    alias: 'my_collection_alis',
      *    collection_name: 'my_collection',
      *  });
@@ -328,7 +326,7 @@ export declare class Collection extends Client {
      * #### Example
      *
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).collectionManager.dropAlias({
+     *  new milvusClient(MILUVS_ADDRESS).dropAlias({
      *    alias: 'my_collection_alis',
      *    collection_name: 'my_collection',
      *  });
@@ -355,7 +353,7 @@ export declare class Collection extends Client {
      * #### Example
      *
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).collectionManager.alterAlais({
+     *  new milvusClient(MILUVS_ADDRESS).alterAlais({
      *    alias: 'my_collection_alis',
      *    collection_name: 'my_collection',
      *  });
@@ -380,7 +378,7 @@ export declare class Collection extends Client {
      * #### Example
      *
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).collectionManager.compact({
+     *  new milvusClient(MILUVS_ADDRESS).compact({
      *    collection_name: 'my_collection',
      *  });
      * ```
@@ -404,7 +402,7 @@ export declare class Collection extends Client {
      * #### Example
      *
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).collectionManager.getCompactionState({
+     *  new milvusClient(MILUVS_ADDRESS).getCompactionState({
      *    compactionID: compactionID,
      *  });
      * ```
@@ -428,7 +426,7 @@ export declare class Collection extends Client {
      * #### Example
      *
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).collectionManager.getCompactionStateWithPlans({
+     *  new milvusClient(MILUVS_ADDRESS).getCompactionStateWithPlans({
      *    compactionID: compactionID,
      *  });
      * ```
@@ -452,7 +450,7 @@ export declare class Collection extends Client {
      * #### Example
      *
      * ```
-     *  new milvusClient(MILUVS_ADDRESS).collectionManager.getReplicas({
+     *  new milvusClient(MILUVS_ADDRESS).getReplicas({
      *    collectionID: collectionID,
      *  });
      *
@@ -475,4 +473,57 @@ export declare class Collection extends Client {
      * ```
      */
     getReplicas(data: GetReplicaReq): Promise<ReplicasResponse>;
+    /**
+   * Get loading progress of a collection
+   *
+   * @param data
+   *  | Property | Type | Description |
+   *  | :-- | :-- | :-- |
+   *  | collection_name | string | the name of the collection |
+   *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
+   *
+   * @returns
+   *  | Property | Description |
+   *  | :-- | :-- |
+   *  | status | { error_code: number, reason: string } |
+   *  | total_row_num | the total number of rows in the collection |
+   *  | total_loaded_row_num | the total number of loaded rows in the collection |
+   *
+   * @throws {Error} if `collection_name` property is not present in `data`
+   *
+   * #### Example
+   *
+   * ```
+   *  new milvusClient(MILUVS_ADDRESS).getLoadingProgress({
+   *    collection_name: 'my_collection',
+   *  });
+   * ```
+   */
+    getLoadingProgress(data: GetLoadingProgressReq): Promise<GetLoadingProgressResponse>;
+    /**
+   * Get the loading state of a collection
+   *
+   * @param data
+   *  | Property | Type | Description |
+   *  | :-- | :-- | :-- |
+   *  | collection_name | string | the name of the collection |
+   *  | timeout? | number | An optional duration of time in milliseconds to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or an error occurs. Default is undefined |
+   *
+   * @returns
+   *  | Property | Description |
+   *  | :-- | :-- |
+   *  | status | { error_code: number, reason: string } |
+   *  | state | the loading state of the collection |
+   *
+   * @throws {Error} if `collection_name` property is not present in `data`
+   *
+   * #### Example
+   *
+   * ```
+   *  new milvusClient(MILUVS_ADDRESS).getLoadState({
+   *    collection_name: 'my_collection',
+   *  });
+   * ```
+   */
+    getLoadState(data: GetLoadStateReq): Promise<GetLoadStateResponse>;
 }