@zilliz/milvus2-sdk-node 2.2.10 → 2.2.12

package/dist/proto/proto/milvus.proto

@@ -12,7 +12,6 @@ option csharp_namespace = "IO.Milvus.Grpc";
 
 import "common.proto";
 import "schema.proto";
-import "feder.proto";
 import "google/protobuf/descriptor.proto";
 
 service MilvusService {
@@ -40,8 +39,6 @@ service MilvusService {
   rpc CreateAlias(CreateAliasRequest) returns (common.Status) {}
   rpc DropAlias(DropAliasRequest) returns (common.Status) {}
   rpc AlterAlias(AlterAliasRequest) returns (common.Status) {}
-  rpc DescribeAlias(DescribeAliasRequest) returns (DescribeAliasResponse) {}
-  rpc ListAliases(ListAliasesRequest) returns (ListAliasesResponse) {}
 
   rpc CreateIndex(CreateIndexRequest) returns (common.Status) {}
   rpc DescribeIndex(DescribeIndexRequest) returns (DescribeIndexResponse) {}
@@ -54,7 +51,6 @@ service MilvusService {
 
   rpc Insert(InsertRequest) returns (MutationResult) {}
   rpc Delete(DeleteRequest) returns (MutationResult) {}
-  rpc Upsert(UpsertRequest) returns (MutationResult) {}
   rpc Search(SearchRequest) returns (SearchResults) {}
   rpc Flush(FlushRequest) returns (FlushResponse) {}
   rpc Query(QueryRequest) returns (QueryResults) {}
@@ -113,8 +109,11 @@ service MilvusService {
 
   rpc RenameCollection(RenameCollectionRequest) returns (common.Status) {}
 
-  rpc ListIndexedSegment(feder.ListIndexedSegmentRequest) returns(feder.ListIndexedSegmentResponse) {}
-  rpc DescribeSegmentIndexData(feder.DescribeSegmentIndexDataRequest) returns(feder.DescribeSegmentIndexDataResponse) {}
+  rpc CreateDatabase(CreateDatabaseRequest) returns (common.Status) {}
+  rpc DropDatabase(DropDatabaseRequest) returns (common.Status) {}
+  rpc ListDatabases(ListDatabasesRequest) returns (ListDatabasesResponse) {}
+
+  rpc Connect(ConnectRequest) returns (ConnectResponse) {}
 }
 
 message CreateAliasRequest {
@@ -137,40 +136,6 @@ message AlterAliasRequest{
   string alias = 4;
 }
 
-message DescribeAliasRequest{
-  common.MsgBase base = 1;
-  string db_name = 2;
-  string alias = 3;
-}
-
-/*
-* Describe alias response
-*/
-message DescribeAliasResponse {
-  // Response status
-  common.Status status = 1;
-  string db_name = 2;
-  string alias = 3;
-  string collection = 4;
-}
-
-message ListAliasesRequest{
-  common.MsgBase base = 1;
-  string db_name = 2;
-  string collection_name = 3;
-}
-
-/*
-* List aliases response
-*/
-message ListAliasesResponse {
-  // Response status
-  common.Status status = 1;
-  string db_name = 2;
-  string collection_name = 3;
-  repeated string aliases = 4;
-}
-
 /**
 * Create collection in milvus
 */
@@ -182,7 +147,6 @@ message CreateCollectionRequest {
   };
   // Not useful for now
   common.MsgBase base = 1;
-  // Not useful for now
   string db_name = 2;
   // The unique collection name in milvus.(Required)
   string collection_name = 3;
@@ -194,6 +158,7 @@ message CreateCollectionRequest {
   // The consistency level that the collection used, modification is not supported now.
   common.ConsistencyLevel consistency_level = 6;
   repeated common.KeyValuePair properties = 7;
+  int64 num_partitions = 8; // num of default physical partitions, only used in partition key mode and changes are not supported
 }
 
 /**
@@ -207,7 +172,6 @@ message DropCollectionRequest {
   };
   // Not useful for now
   common.MsgBase base = 1;
-  // Not useful for now
   string db_name = 2;
   // The unique collection name in milvus.(Required)
   string collection_name = 3;
@@ -224,7 +188,6 @@ message AlterCollectionRequest {
   };
   // Not useful for now
   common.MsgBase base = 1;
-  // Not useful for now
   string db_name = 2;
   // The unique collection name in milvus.(Required)
   string collection_name = 3;
@@ -238,7 +201,6 @@ message AlterCollectionRequest {
 message HasCollectionRequest {
   // Not useful for now
   common.MsgBase base = 1;
-  // Not useful for now
   string db_name = 2;
   // The collection name you want to check.
   string collection_name = 3;
@@ -268,7 +230,6 @@ message DescribeCollectionRequest {
   };
   // Not useful for now
   common.MsgBase base = 1;
-  // Not useful for now
   string db_name = 2;
   // The collection name you want to describe, you can pass collection_name or collectionID
   string collection_name = 3;
@@ -307,6 +268,8 @@ message DescribeCollectionResponse {
   // The collection name
   string collection_name = 12;
   repeated common.KeyValuePair properties = 13;
+  string db_name = 14;
+  int64 num_partitions = 15;
 }
 
 /**
@@ -320,13 +283,12 @@ message LoadCollectionRequest {
   };
   // Not useful for now
   common.MsgBase base = 1;
-  // Not useful for now
   string db_name = 2;
   // The collection name you want to load
   string collection_name = 3;
   // The replica number to load, default by 1
   int32 replica_number = 4;
-  // create replica used resource group
+  // create replica used resource group 
   repeated string resource_groups = 5;
   // Whether to enable refresh mode.
   bool refresh = 6;
@@ -343,7 +305,6 @@ message ReleaseCollectionRequest {
   };
   // Not useful for now
   common.MsgBase base = 1;
-  // Not useful for now
   string db_name = 2;
   // The collection name you want to release
   string collection_name = 3;
@@ -361,7 +322,6 @@ message GetStatisticsRequest {
   };
   // Not useful for now
   common.MsgBase base = 1;
-  // Not useful for now
   string db_name = 2;
   // The collection name you want get statistics
   string collection_name = 3;
@@ -393,7 +353,6 @@ message GetCollectionStatisticsRequest {
   };
   // Not useful for now
   common.MsgBase base = 1;
-  // Not useful for now
   string db_name = 2;
   // The collection name you want get statistics
   string collection_name = 3;
@@ -431,7 +390,6 @@ message ShowCollectionsRequest {
   };
   // Not useful for now
   common.MsgBase base = 1;
-  // Not useful for now
   string db_name = 2;
   // Not useful for now
   uint64 time_stamp = 3;
@@ -469,7 +427,6 @@ message ShowCollectionsResponse {
 message CreatePartitionRequest {
   // Not useful for now
   common.MsgBase base = 1;
-  // Not useful for now
   string db_name = 2;
   // The collection name in milvus
   string collection_name = 3;
@@ -483,7 +440,6 @@ message CreatePartitionRequest {
 message DropPartitionRequest {
   // Not useful for now
   common.MsgBase base = 1;
-  // Not useful for now
   string db_name = 2;
   // The collection name in milvus
   string collection_name = 3;
@@ -497,7 +453,6 @@ message DropPartitionRequest {
 message HasPartitionRequest {
   // Not useful for now
   common.MsgBase base = 1;
-  // Not useful for now
   string db_name = 2;
   // The collection name in milvus
   string collection_name = 3;
@@ -512,7 +467,6 @@ message HasPartitionRequest {
 message LoadPartitionsRequest {
   // Not useful for now
   common.MsgBase base = 1;
-  // Not useful for now
   string db_name = 2;
   // The collection name in milvus
   string collection_name = 3;
@@ -520,7 +474,7 @@ message LoadPartitionsRequest {
   repeated string partition_names = 4;
   // The replicas number you would load, 1 by default
   int32 replica_number = 5;
-  // create replica used resource group
+  // create replica used resource group 
   repeated string resource_groups = 6;
   // Whether to enable refresh mode.
   bool refresh = 7;
@@ -533,7 +487,6 @@ message LoadPartitionsRequest {
 message ReleasePartitionsRequest {
   // Not useful for now
   common.MsgBase base = 1;
-  // Not useful for now
   string db_name = 2;
   // The collection name in milvus
   string collection_name = 3;
@@ -547,7 +500,6 @@ message ReleasePartitionsRequest {
 message GetPartitionStatisticsRequest {
   // Not useful for now
   common.MsgBase base = 1;
-  // Not useful for now
   string db_name = 2;
   // The collection name in milvus
   string collection_name = 3;
@@ -566,7 +518,6 @@ message GetPartitionStatisticsResponse {
 message ShowPartitionsRequest {
   // Not useful for now
   common.MsgBase base = 1;
-  // Not useful for now
   string db_name = 2;
   // The collection name you want to describe, you can pass collection_name or collectionID
   string collection_name = 3;
@@ -635,7 +586,6 @@ message CreateIndexRequest {
   };
   // Not useful for now
   common.MsgBase base = 1;
-  // Not useful for now
   string db_name = 2;
   // The particular collection name you want to create index.
   string collection_name = 3;
@@ -659,7 +609,6 @@ message DescribeIndexRequest {
   };
   // Not useful for now
   common.MsgBase base = 1;
-  // Not useful for now
   string db_name = 2;
   // The particular collection name in Milvus
   string collection_name = 3;
@@ -687,6 +636,7 @@ message IndexDescription {
   // index state
   common.IndexState state = 7;
   string index_state_fail_reason = 8;
+  int64 pending_index_rows = 9;
 }
 
 /*
@@ -710,7 +660,6 @@ message GetIndexBuildProgressRequest {
   };
   // Not useful for now
   common.MsgBase base = 1;
-  // Not useful for now
   string db_name = 2 ;
   // The collection name in milvus
   string collection_name = 3;
@@ -773,24 +722,9 @@ message InsertRequest {
   uint32 num_rows = 7;
 }
 
-message UpsertRequest {
-  option (common.privilege_ext_obj) = {
-    object_type: Collection
-    object_privilege: PrivilegeUpsert
-    object_name_index: 3
-  };
-  common.MsgBase base = 1;
-  string db_name = 2;
-  string collection_name = 3;
-  string partition_name = 4;
-  repeated schema.FieldData fields_data = 5;
-  repeated uint32 hash_keys = 6;
-  uint32 num_rows = 7;
-}
-
 message MutationResult {
   common.Status status = 1;
-  schema.IDs IDs = 2; // required for insert, delete, upsert
+  schema.IDs IDs = 2; // required for insert, delete
   repeated uint32 succ_index = 3; // error indexes indicate
   repeated uint32 err_index = 4; // error indexes indicate
   bool acknowledged = 5;
@@ -834,6 +768,9 @@ message SearchRequest {
   uint64 travel_timestamp = 10;
   uint64 guarantee_timestamp = 11; // guarantee_timestamp
   int64  nq = 12;
+  bool not_return_all_meta = 13;
+  common.ConsistencyLevel consistency_level = 14;
+  bool use_default_consistency = 15;
 }
 
 message Hits {
@@ -882,12 +819,16 @@ message QueryRequest {
   uint64 travel_timestamp = 7;
   uint64 guarantee_timestamp = 8; // guarantee_timestamp
   repeated common.KeyValuePair query_params = 9; // optional
+  bool not_return_all_meta = 10;
+  common.ConsistencyLevel consistency_level = 11;
+  bool use_default_consistency = 12;
 }
 
 message QueryResults {
   common.Status status = 1;
   repeated schema.FieldData fields_data = 2;
   string collection_name = 3;
+  repeated string output_fields = 4;
 }
 
 message VectorIDs {
@@ -1029,6 +970,7 @@ message LoadBalanceRequest {
   repeated int64 dst_nodeIDs = 3;
   repeated int64 sealed_segmentIDs = 4;
   string collectionName = 5;
+  string db_name = 6;
 }
 
 message ManualCompactionRequest {
@@ -1044,7 +986,6 @@ message ManualCompactionRequest {
 message ManualCompactionResponse {
   common.Status status = 1;
   int64 compactionID = 2;
-  int32 compactionPlanCount = 3;
 }
 
 message GetCompactionStateRequest {
@@ -1106,6 +1047,7 @@ message ImportRequest {
   bool row_based = 4;                        // the file is row-based or column-based
   repeated string files = 5;                 // file paths to be imported
   repeated common.KeyValuePair options = 6;  // import options, bucket, etc.
+  string db_name = 7;
 }
 
 message ImportResponse {
@@ -1132,6 +1074,7 @@ message GetImportStateResponse {
 message ListImportTasksRequest {
   string collection_name = 1; // target collection, list all tasks if the name is empty
   int64 limit = 2;            // maximum number of tasks returned, list all tasks if the value is 0
+  string db_name = 3;
 }
 
 message ListImportTasksResponse {
@@ -1144,6 +1087,7 @@ message GetReplicasRequest {
   int64 collectionID = 2;
   bool with_shard_nodes = 3;
   string collection_name = 4;
+  string db_name = 5;
 }
 
 message GetReplicasResponse {
@@ -1376,6 +1320,8 @@ message GrantEntity {
   string object_name = 3;
   // privilege
   GrantorEntity grantor = 4;
+  // db name
+  string db_name = 5;
 }
 
 message SelectGrantRequest {
@@ -1426,12 +1372,12 @@ message GetLoadingProgressRequest {
   common.MsgBase base = 1;
   string collection_name = 2;
   repeated string partition_names = 3;
+  string db_name = 4;
 }
 
 message GetLoadingProgressResponse {
   common.Status status = 1;
   int64 progress = 2;
-  int64 refresh_progress = 3;
 }
 
 message GetLoadStateRequest {
@@ -1444,6 +1390,7 @@ message GetLoadStateRequest {
   common.MsgBase base = 1;
   string collection_name = 2;
   repeated string partition_names = 3;
+  string db_name = 4;
 }
 
 message GetLoadStateResponse {
@@ -1505,7 +1452,7 @@ message DropResourceGroupRequest {
   string resource_group = 2;
 }
 
-// transfer `nodeNum` nodes from `source_resource_group` to `target_resource_group`
+// transfer `nodeNum` nodes from `source_resource_group` to `target_resource_group` 
 message TransferNodeRequest {
   option (common.privilege_ext_obj) = {
     object_type: Global
@@ -1530,6 +1477,7 @@ message TransferReplicaRequest {
   string target_resource_group = 3;
   string  collection_name = 4;
   int64  num_replica = 5;
+  string db_name = 6;
 }
 
 message ListResourceGroupsRequest {
@@ -1567,19 +1515,63 @@ message ResourceGroup {
   int32 num_available_node = 3;
   // collection name -> loaded replica num
   map<string, int32> num_loaded_replica = 4;
-  // collection name -> accessed other rg's node num
+  // collection name -> accessed other rg's node num 
   map<string, int32> num_outgoing_node = 5;
    // collection name -> be accessed node num by other rg
   map<string, int32> num_incoming_node = 6;
 }
 
 message RenameCollectionRequest {
+  option (common.privilege_ext_obj) = {
+    object_type: Global
+    object_privilege: PrivilegeRenameCollection
+    object_name_index: -1
+  };
   common.MsgBase base = 1;
-  string db = 2;
+  string db_name = 2;
   string oldName = 3;
   string newName = 4;
 }
 
+message CreateDatabaseRequest {
+  option (common.privilege_ext_obj) = {
+    object_type: Global
+    object_privilege: PrivilegeCreateDatabase
+    object_name_index: -1
+  };
+  common.MsgBase base = 1;
+  string db_name = 2;
+}
+
+message DropDatabaseRequest {
+  option (common.privilege_ext_obj) = {
+    object_type: Global
+    object_privilege: PrivilegeDropDatabase
+    object_name_index: -1
+  };
+  common.MsgBase base = 1;
+  string db_name = 2;
+}
+
+message ListDatabasesRequest {
+  option (common.privilege_ext_obj) = {
+    object_type: Global
+    object_privilege: PrivilegeListDatabases
+    object_name_index: -1
+  };
+  common.MsgBase base = 1;
+}
+
+message ListDatabasesResponse {
+  option (common.privilege_ext_obj) = {
+    object_type: Global
+    object_privilege: PrivilegeShowCollections
+    object_name_index: -1
+  };
+  common.Status status = 1;
+  repeated string db_names = 2;
+}
+
 message GetIndexStatisticsRequest {
   option (common.privilege_ext_obj) = {
     object_type: Collection
@@ -1602,3 +1594,14 @@ message GetIndexStatisticsResponse {
   // All index information.
   repeated IndexDescription index_descriptions = 2;
 }
+
+message ConnectRequest {
+  common.MsgBase base = 1;
+  common.ClientInfo client_info = 2;
+}
+
+message ConnectResponse {
+  common.Status status = 1;
+  common.ServerInfo server_info = 2;
+  int64 identifier = 3;
+}

package/dist/proto/proto/schema.proto

@@ -58,6 +58,8 @@ message FieldSchema {
                         // state is `Created`.
   DataType element_type = 10; // For array type, the element type is stored here
   ValueField default_value = 11; // default_value only support scalars except array and json for now
+  bool is_dynamic = 12; // mark whether this field is the dynamic field
+  bool is_partition_key = 13; // enable logic partitions
 }
 
 /**
@@ -68,6 +70,7 @@ message CollectionSchema {
   string description = 2;
   bool autoID = 3; // deprecated later, keep compatible with c++ part now
   repeated FieldSchema fields = 4;
+  bool enable_dynamic_field = 5; // mark whether this table has the dynamic field function enabled.
 }
 
 message BoolArray { repeated bool data = 1; }
@@ -134,6 +137,7 @@ message FieldData {
     VectorField vectors = 4;
   }
   int64 field_id = 5;
+  bool is_dynamic = 6; 
 }
 
 message IDs {
@@ -150,4 +154,5 @@ message SearchResultData {
   repeated float scores = 4;
   IDs ids = 5;
   repeated int64 topks = 6;
+  repeated string output_fields = 7;
 }

package/dist/sdk.json

@@ -1 +1 @@
-{"version":"2.2.10","milvusVersion":"v2.2.8"}
+{"version":"2.2.12","milvusVersion":"v2.2.9"}

package/package.json

@@ -1,36 +1,39 @@
 {
   "name": "@zilliz/milvus2-sdk-node",
   "author": "ued@zilliz.com",
-  "version": "2.2.10",
-  "milvusVersion": "v2.2.8",
+  "version": "2.2.12",
+  "milvusVersion": "v2.2.9",
   "main": "dist/milvus",
   "files": [
     "dist"
   ],
   "scripts": {
     "pre": "git submodule update --remote && rm -rf proto/proto/google && mkdir -p proto/proto/google/protobuf && wget https://raw.githubusercontent.com/protocolbuffers/protobuf/main/src/google/protobuf/descriptor.proto -O proto/proto/google/protobuf/descriptor.proto",
-    "build": "tsc --declaration && node build.js",
+    "build": "rm -rf dist && tsc --declaration && node build.js",
     "testAll": "jest --testPathIgnorePatterns=/test/build/",
     "test": "jest",
+    "test2": "jest --runInBand",
     "coverage": "jest --coverage=true --config jest.config.js --no-cache --testPathIgnorePatterns=/test/build/",
-    "build-test": "yarn build && jest test/build/Collection.spec.ts",
+    "build-test": " yarn build && jest test/build/Collection.spec.ts",
     "example": "npx ts-node",
     "doc": "rm -rf docs && npx typedoc",
     "doc-json": "npx typedoc milvus --json"
   },
   "dependencies": {
     "@grpc/grpc-js": "^1.8.14",
-    "@grpc/proto-loader": "^0.7.6",
-    "protobufjs": "^7.2.3"
+    "@grpc/proto-loader": "^0.7.7",
+    "dayjs": "^1.11.7",
+    "protobufjs": "^7.2.3",
+    "winston": "^3.9.0"
   },
   "devDependencies": {
-    "@babel/plugin-transform-modules-commonjs": "^7.13.8",
-    "@types/jest": "^29.5.0",
+    "@babel/plugin-transform-modules-commonjs": "^7.21.5",
+    "@types/jest": "^29.5.1",
     "jest": "^29.5.0",
-    "ts-jest": "^29.0.3",
+    "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",
-    "typedoc": "^0.23.26",
-    "typescript": "^4.9.5"
+    "typedoc": "^0.24.7",
+    "typescript": "^5.0.4"
   },
   "publishConfig": {
     "access": "public"

package/dist/milvus/types/Index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Index.js","sourceRoot":"","sources":["../../../milvus/types/Index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,eAAe;AACf,+CAA6B;AAC7B,yCAAuB;AACvB,2CAAyB;AACzB,gDAA8B;AAC9B,8CAA4B;AAC5B,6CAA2B;AAC3B,yCAAuB;AACvB,6CAA2B;AAC3B,2CAAyB;AACzB,gDAA8B"}

package/dist/milvus/types.d.ts

@@ -1,9 +0,0 @@
-export * from './types/Collection';
-export * from './types/Data';
-export * from './types/Common';
-export * from './types/MilvusIndex';
-export * from './types/Partition';
-export * from './types/Response';
-export * from './types/User';
-export * from './types/Resource';
-export * from './types/Client';

package/dist/milvus/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../milvus/types.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,cAAc;AACd,qDAAmC;AACnC,+CAA6B;AAC7B,iDAA+B;AAC/B,sDAAoC;AACpC,oDAAkC;AAClC,mDAAiC;AACjC,+CAA6B;AAC7B,mDAAiC;AACjC,iDAA+B"}

package/dist/proto/proto/feder.proto

@@ -1,40 +0,0 @@
-syntax = "proto3";
-package milvus.proto.feder;
-option go_package = "github.com/milvus-io/milvus-proto/go-api/federpb";
-
-import "common.proto";
-
-message SegmentIndexData {
-  int64 segmentID = 1;
-  string index_data = 2; // data from knownwhere
-}
-
-message FederSegmentSearchResult {
-  int64 segmentID = 1;
-  string visit_info = 2;
-}
-
-message ListIndexedSegmentRequest {
-  common.MsgBase base = 1;
-  string collection_name = 2;
-  string index_name = 3;
-}
-
-message ListIndexedSegmentResponse {
-  common.Status status = 1;
-  repeated int64 segmentIDs = 2;
-}
-
-message DescribeSegmentIndexDataRequest {
-  common.MsgBase base = 1;
-  string collection_name = 2;
-  string index_name = 3;
-  repeated int64 segmentsIDs = 4;
-}
-
-message DescribeSegmentIndexDataResponse {
-  common.Status status = 1;
-  // segmentID => segmentIndexData
-  map<int64, feder.SegmentIndexData> index_data = 2;
-  repeated common.KeyValuePair index_params = 3;
-}