@zilliz/milvus2-sdk-node 1.0.18 → 2.0.0

package/README.md

@@ -1,12 +1,20 @@
 [![typescript](https://badges.aleen42.com/src/typescript.svg)](https://badges.aleen42.com/src/typescript.svg)
 [![version](https://img.shields.io/npm/v/@zilliz/milvus2-sdk-node)](https://img.shields.io/npm/v/@zilliz/milvus2-sdk-node)
 [![downloads](https://img.shields.io/npm/dw/@zilliz/milvus2-sdk-node)](https://img.shields.io/npm/dw/@zilliz/milvus2-sdk-node)
-[![codecov](https://codecov.io/gh/milvus-io/milvus-sdk-node/branch/v2.x/graph/badge.svg?token=Zu5FwWstwI)](https://codecov.io/gh/milvus-io/milvus-sdk-node)
+[![codecov](https://codecov.io/gh/milvus-io/milvus-sdk-node/branch/main/graph/badge.svg?token=Zu5FwWstwI)](https://codecov.io/gh/milvus-io/milvus-sdk-node)
 
 # Milvus2-sdk-node
 
 This is node sdk for [Milvus](https://github.com/milvus-io/milvus).
 
+## Compatibility
+
+The following collection shows Milvus versions and recommended @zilliz/milvus2-sdk-node versions:
+
+| Milvus version | Recommended @zilliz/milvus2-sdk-node version |
+| :------------: | :------------------------------------------: |
+|     2.0.0      |                    2.0.0                     |
+
 ## Dependencies
 
 Milvus: v2+
@@ -19,7 +27,7 @@ Node: v12+
    npm install @zilliz/milvus2-sdk-node
 ```
 
-## API
+## API Support
 
 | Name                    | Async |               Description                |
 | :---------------------- | :---- | :--------------------------------------: |
@@ -45,12 +53,16 @@ Node: v12+
 | dropIndex               | true  |                Drop index                |
 | insert                  | false |         Insert data into milvus          |
 | search                  | false |         Vector similarity search         |
-| flush                   | false |                Flush Data                |
+| flush                   | true  |                Flush Data                |
+| flushSync               | false |             Flush Data Sync              |
 | query                   | false |             Get data by expr             |
+| compact                 | true  |     Do compaction for the collection     |
+| getCompactionState      | true  |   Get compaction states by compact id    |
 
 ## Example
 
-1. [How to operate collection](https://github.com/milvus-io/milvus-sdk-node/blob/main/example/Collection.ts)
-2. [How to insert data](https://github.com/milvus-io/milvus-sdk-node/blob/main/example/Insert.ts)
-3. [Vector similarity search on float field](https://github.com/milvus-io/milvus-sdk-node/blob/main/example/Search.ts)
-4. [Vector similarity search on binary field](https://github.com/milvus-io/milvus-sdk-node/blob/main/example/BinarySearch.ts)
+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)

package/dist/grpc-proto/common.proto

@@ -51,6 +51,7 @@ enum SegmentState {
     Sealed = 3;
     Flushed = 4;
     Flushing = 5;
+    Dropped = 6;
 }
 
 message Status {
@@ -133,9 +134,14 @@ enum MsgType {
     RemoveDmChannels = 509;
     WatchQueryChannels = 510;
     RemoveQueryChannels = 511;
+    SealedSegmentsChangeInfo = 512;
+    WatchDeltaChannels = 513;
 
     /* DATA SERVICE */
     SegmentInfo = 600;
+    SystemInfo = 601;
+    GetRecoveryInfo = 602;
+    GetSegmentState = 603;
 
     /* SYSTEM CONTROL */
     TimeTick = 1200;
@@ -171,4 +177,18 @@ message MsgHeader {
 message DMLMsgHeader {
     common.MsgBase base = 1;
     string shardName = 2;
-}
+}
+
+enum CompactionState {
+  UndefiedState = 0;
+  Executing = 1;
+  Completed = 2;
+}
+
+enum ConsistencyLevel {
+    Strong = 0;
+    Session = 1; // default in PyMilvus
+    Bounded = 2;
+    Eventually = 3;
+    Customized = 4; // Users pass their own `guarantee_timestamp`.
+}

package/dist/grpc-proto/milvus.proto

@@ -41,6 +41,7 @@ service MilvusService {
   rpc Query(QueryRequest) returns (QueryResults) {}
   rpc CalcDistance(CalcDistanceRequest) returns (CalcDistanceResults) {}
 
+  rpc GetFlushState(GetFlushStateRequest) returns (GetFlushStateResponse) {}
   rpc GetPersistentSegmentInfo(GetPersistentSegmentInfoRequest) returns (GetPersistentSegmentInfoResponse) {}
   rpc GetQuerySegmentInfo(GetQuerySegmentInfoRequest) returns (GetQuerySegmentInfoResponse) {}
 
@@ -51,23 +52,30 @@ service MilvusService {
 
   // https://wiki.lfaidata.foundation/display/MIL/MEP+8+--+Add+metrics+for+proxy
   rpc GetMetrics(GetMetricsRequest) returns (GetMetricsResponse) {}
+  rpc LoadBalance(LoadBalanceRequest) returns (common.Status) {}
+  rpc GetCompactionState(GetCompactionStateRequest) returns (GetCompactionStateResponse) {}
+  rpc ManualCompaction(ManualCompactionRequest) returns (ManualCompactionResponse) {}
+  rpc GetCompactionStateWithPlans(GetCompactionPlansRequest) returns (GetCompactionPlansResponse) {}
 }
 
 message CreateAliasRequest {
   common.MsgBase base = 1;
-  string collection_name = 2;
-  string alias = 3;
+  string db_name = 2;
+  string collection_name = 3;
+  string alias = 4;
 }
 
 message DropAliasRequest {
   common.MsgBase base = 1;
-  string alias = 2;
+  string db_name = 2;
+  string alias = 3;
 }
 
 message AlterAliasRequest{
   common.MsgBase base = 1;
-  string collection_name = 2;
-  string alias = 3;
+  string db_name = 2;
+  string collection_name = 3;
+  string alias = 4;
 }
 
 /**
@@ -85,6 +93,8 @@ message CreateCollectionRequest {
   // Once set, no modification is allowed (Optional)
   // https://github.com/milvus-io/milvus/issues/6690
   int32 shards_num = 5;
+  // The consistency level that the collection used, modification is not supported now.
+  common.ConsistencyLevel consistency_level = 6;
 }
 
 /**
@@ -164,6 +174,8 @@ message DescribeCollectionResponse {
   repeated string aliases = 9;
   // The message ID/posititon when collection is created
   repeated common.KeyDataPair start_positions = 10;
+  // The consistency level that the collection used, modification is not supported now.
+  common.ConsistencyLevel consistency_level = 11;
 }
 
 /**
@@ -346,6 +358,7 @@ message GetPartitionStatisticsResponse {
   common.Status status = 1;
   repeated common.KeyValuePair stats = 2;
 }
+
 /*
 * List all partitions for particular collection
 */
@@ -364,13 +377,23 @@ message ShowPartitionsRequest {
   ShowType type = 6;
 }
 
+/*
+* List all partitions for particular collection response.
+* The returned datas are all rows, we can format to columns by therir index.
+*/
 message ShowPartitionsResponse {
+  // Contain error_code and reason
   common.Status status = 1;
+  // All partition names for this collection
   repeated string partition_names = 2;
+  // All partition ids for this collection
   repeated int64 partitionIDs = 3;
-  repeated uint64 created_timestamps = 4; // hybrid timestamps
-  repeated uint64 created_utc_timestamps = 5; // physical timestamps
-  repeated int64 inMemory_percentages = 6; // load percentage on querynode
+  // All hybrid timestamps
+  repeated uint64 created_timestamps = 4;
+  // All utc timestamps calculated by created_timestamps
+  repeated uint64 created_utc_timestamps = 5;
+  // Load percentage on querynode
+  repeated int64 inMemory_percentages = 6;
 }
 
 message DescribeSegmentRequest {
@@ -384,6 +407,7 @@ message DescribeSegmentResponse {
   int64 indexID = 2;
   int64 buildID = 3;
   bool enable_index = 4;
+  int64 fieldID = 5;
 }
 
 message ShowSegmentsRequest {
@@ -397,40 +421,77 @@ message ShowSegmentsResponse {
   repeated int64 segmentIDs = 2;
 }
 
+/*
+* Create index for vector datas
+*/
 message CreateIndexRequest {
-  common.MsgBase base = 1; // must
+  // Not useful for now
+  common.MsgBase base = 1; 
+  // Not useful for now
   string db_name = 2;
-  string collection_name = 3; // must
-  string field_name = 4; // must
-  repeated common.KeyValuePair extra_params = 5; // must
+  // The particular collection name you want to create index.
+  string collection_name = 3;
+  // The vector field name in this particular collection
+  string field_name = 4;
+  // Support keys: index_type,metric_type, params. Different index_type may has different params.
+  repeated common.KeyValuePair extra_params = 5; 
 }
 
+/*
+* Get created index information. 
+* Current release of Milvus only supports showing latest built index.
+*/
 message DescribeIndexRequest {
-  common.MsgBase base = 1; // must
+  // Not useful for now
+  common.MsgBase base = 1;
+  // Not useful for now
   string db_name = 2;
-  string collection_name = 3; // must
+  // The particular collection name in Milvus
+  string collection_name = 3;
+   // The vector field name in this particular collection
   string field_name = 4;
-  string index_name = 5; // No need to set up for now @2021.06.30
+  // No need to set up for now @2021.06.30
+  string index_name = 5; 
 }
 
+/*
+* Index informations
+*/
 message IndexDescription {
+  // Index name
   string index_name = 1;
+  // Index id
   int64 indexID = 2;
+  // Will return index_type, metric_type, params(like nlist).
   repeated common.KeyValuePair params = 3;
+  // The vector field name
   string field_name = 4;
 }
 
+/*
+* Describe index response
+*/
 message DescribeIndexResponse {
+  // Response status
   common.Status status = 1;
+  // All index informations, for now only return tha latest index you created for the collection.
   repeated IndexDescription index_descriptions = 2;
 }
 
+/*
+*  Get index building progress 
+*/
 message GetIndexBuildProgressRequest {
-  common.MsgBase base = 1; // must
+  // Not useful for now
+  common.MsgBase base = 1;
+  // Not useful for now
   string db_name = 2 ;
-  string collection_name = 3; // must
+  // The collection name in milvus
+  string collection_name = 3;
+  // The vector field name in this collection
   string field_name = 4;
-  string index_name = 5; // must
+  // Not useful for now
+  string index_name = 5;
 }
 
 message GetIndexBuildProgressResponse {
@@ -489,6 +550,7 @@ message DeleteRequest {
   string collection_name = 3;
   string partition_name = 4;
   string expr = 5;
+  repeated uint32 hash_keys = 6;
 }
 
 enum PlaceholderType {
@@ -619,6 +681,8 @@ message QuerySegmentInfo {
   int64 num_rows = 5;
   string index_name = 6;
   int64 indexID = 7;
+  int64 nodeID = 8;
+  common.SegmentState state = 9;
 }
 
 message GetQuerySegmentInfoRequest {
@@ -659,6 +723,62 @@ message GetMetricsResponse {
   string component_name = 3; // metrics from which component
 }
 
+/*
+* Do load balancing operation from src_nodeID to dst_nodeID.
+*/
+message LoadBalanceRequest {
+  common.MsgBase base = 1;
+  int64 src_nodeID = 2;
+  repeated int64 dst_nodeIDs = 3;
+  repeated int64 sealed_segmentIDs = 4;
+}
+
+message ManualCompactionRequest {
+  int64 collectionID = 1;
+  uint64 timetravel = 2;
+}
+
+message ManualCompactionResponse {
+  common.Status status = 1;
+  int64 compactionID = 2;
+}
+
+message GetCompactionStateRequest {
+  int64 compactionID = 1;
+}
+
+message GetCompactionStateResponse {
+  common.Status status = 1;
+  common.CompactionState state = 2;
+  int64 executingPlanNo = 3;
+  int64 timeoutPlanNo = 4;
+  int64 completedPlanNo = 5;
+}
+
+message GetCompactionPlansRequest {
+  int64 compactionID = 1;
+}
+
+message GetCompactionPlansResponse {
+  common.Status status = 1;
+  common.CompactionState state = 2;
+  repeated CompactionMergeInfo mergeInfos = 3;
+}
+
+message CompactionMergeInfo {
+  repeated int64 sources = 1;
+  int64 target = 2;
+}
+
+message GetFlushStateRequest {
+  repeated int64 segmentIDs = 1;
+}
+
+message GetFlushStateResponse {
+  common.Status status = 1;
+  bool flushed = 2;
+}
+
 service ProxyService {
   rpc RegisterLink(RegisterLinkRequest) returns (RegisterLinkResponse) {}
 }

package/dist/milvus/Client.d.ts

@@ -1,4 +1,6 @@
 export declare class Client {
     client: any;
     constructor(client: any);
+    checkCollectionName(data: any): void;
+    checkCollectionAndPartitionName(data: any): void;
 }

package/dist/milvus/Client.js

@@ -1,10 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Client = void 0;
+var ErrorReason_1 = require("./const/ErrorReason");
 var Client = /** @class */ (function () {
     function Client(client) {
         this.client = client;
     }
+    Client.prototype.checkCollectionName = function (data) {
+        if (!data || !data.collection_name) {
+            throw new Error(ErrorReason_1.ERROR_REASONS.COLLECTION_NAME_IS_REQUIRED);
+        }
+    };
+    Client.prototype.checkCollectionAndPartitionName = function (data) {
+        if (!data || !data.collection_name || !data.partition_name) {
+            throw new Error(ErrorReason_1.ERROR_REASONS.COLLECTION_PARTITION_NAME_ARE_REQUIRED);
+        }
+    };
     return Client;
 }());
 exports.Client = Client;

package/dist/milvus/Client.js.map

@@ -1 +1 @@
-{"version":3,"file":"Client.js","sourceRoot":"","sources":["../../milvus/Client.ts"],"names":[],"mappings":";;;AAAA;IAGE,gBAAY,MAAW;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IACH,aAAC;AAAD,CAAC,AAND,IAMC;AANY,wBAAM"}
+{"version":3,"file":"Client.js","sourceRoot":"","sources":["../../milvus/Client.ts"],"names":[],"mappings":";;;AAAA,mDAAoD;AAEpD;IAGE,gBAAY,MAAW;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,oCAAmB,GAAnB,UAAoB,IAAS;QAC3B,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;YAClC,MAAM,IAAI,KAAK,CAAC,2BAAa,CAAC,2BAA2B,CAAC,CAAC;SAC5D;IACH,CAAC;IAED,gDAA+B,GAA/B,UAAgC,IAAS;QACvC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,eAAe,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;YAC1D,MAAM,IAAI,KAAK,CAAC,2BAAa,CAAC,sCAAsC,CAAC,CAAC;SACvE;IACH,CAAC;IACH,aAAC;AAAD,CAAC,AAlBD,IAkBC;AAlBY,wBAAM"}

package/dist/milvus/Collection.d.ts

@@ -1,5 +1,5 @@
-import { CreateCollectionReq, DescribeCollectionReq, DropCollectionReq, GetCollectionStatisticsReq, LoadCollectionReq, ReleaseLoadCollectionReq, ShowCollectionsReq, HasCollectionReq } from "./types/Collection";
-import { BoolResponse, DescribeCollectionResponse, ResStatus, ShowCollectionsResponse, StatisticsResponse } from "./types/Response";
+import { CreateCollectionReq, DescribeCollectionReq, DropCollectionReq, GetCollectionStatisticsReq, LoadCollectionReq, ReleaseLoadCollectionReq, ShowCollectionsReq, HasCollectionReq, CreateAliasReq, DropAliasReq, AlterAliasReq, CompactReq, GetCompactionStateReq, GetCompactionPlansReq } from "./types/Collection";
+import { BoolResponse, CompactionResponse, DescribeCollectionResponse, GetCompactionPlansResponse, GetCompactionStateResponse, ResStatus, ShowCollectionsResponse, StatisticsResponse } from "./types/Response";
 import { Client } from "./Client";
 /**
  * See all [collection operation examples](https://github.com/milvus-io/milvus-sdk-node/blob/main/example/Collection.ts).
@@ -11,7 +11,7 @@ export declare class Collection extends Client {
      * @param data
      *  | Property                | Type   |           Description              |
      *  | :---------------------- | :----  | :-------------------------------  |
-     *  | createCollection        | String |        Collection name       |
+     *  | collection_name        | String |        Collection name       |
      *  | description             | String |        Collection description       |
      *  | fields        | <a href="https://github.com/milvus-io/milvus-sdk-node/blob/main/milvus/types/Collection.ts#L8" target="_blank">FieldType</a> |     Field data      |
      *
@@ -239,4 +239,89 @@ export declare class Collection extends Client {
      * ```
      */
     dropCollection(data: DropCollectionReq): Promise<ResStatus>;
+    /**
+     * @ignore
+     * Create collection alias, then you can use alias instead of collection_name when you do vector search
+     * @param data
+     */
+    createAlias(data: CreateAliasReq): Promise<ResStatus>;
+    /**
+     * @ignore
+     * @param data
+     */
+    dropAlias(data: DropAliasReq): Promise<ResStatus>;
+    /**
+     * @ignore
+     * @param data
+     */
+    alterAlias(data: AlterAliasReq): Promise<ResStatus>;
+    /**
+     * Do compaction for the collection.
+     *
+     * @param data
+     *  | Property           | Type   |           Description              |
+     *  | :----------------- | :----  | :-------------------------------  |
+     *  | collection_name        | String |       The collection name to compact       |
+     *
+     * @return
+     *  | Property      | Description |
+     *  | :-------------| :--------  |
+     *  | status        |  { error_code: number, reason: string }|
+     *  | compactionID  | compaction ID |
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).collectionManager.compact({
+     *    collection_name: 'my_collection',
+     *  });
+     * ```
+     */
+    compact(data: CompactReq): Promise<CompactionResponse>;
+    /**
+     * Get compaction states of a targeted compaction id
+     *
+     * @param data
+     *  | Property           | Type   |           Description              |
+     *  | :----------------- | :----  | :-------------------------------  |
+     *  | compactionID       | number or string |       the id returned by compact       |
+     *
+     * @return
+     *  | Property      | Description |
+     *  | :-------------| :--------  |
+     *  | status        |  { error_code: number, reason: string }|
+     *  | state         | the state of the compaction |
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).collectionManager.getCompactionState({
+     *    compactionID: compactionID,
+     *  });
+     * ```
+     */
+    getCompactionState(data: GetCompactionStateReq): Promise<GetCompactionStateResponse>;
+    /**
+     * Get compaction states of a targeted compaction id
+     *
+     * @param data
+     *  | Property           | Type   |           Description              |
+     *  | :----------------- | :----  | :-------------------------------  |
+     *  | compactionID       | number or string |       the id returned by compact       |
+     *
+     * @return
+     *  | Property      | Description |
+     *  | :-------------| :--------  |
+     *  | status        |  { error_code: number, reason: string }|
+     *  | state         | the state of the compaction |
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).collectionManager.getCompactionStateWithPlans({
+     *    compactionID: compactionID,
+     *  });
+     * ```
+     */
+    getCompactionStateWithPlans(data: GetCompactionPlansReq): Promise<GetCompactionPlansResponse>;
 }