@zilliz/milvus2-sdk-node 2.0.1 → 2.1.0

package/dist/{grpc-proto → proto/proto}/milvus.proto

@@ -3,8 +3,14 @@ package milvus.proto.milvus;
 
 option go_package = "github.com/milvus-io/milvus/internal/proto/milvuspb";
 
+option java_multiple_files = true;
+option java_package = "io.milvus.grpc";
+option java_outer_classname = "MilvusProto";
+option java_generate_equals_and_hash = true;
+
 import "common.proto";
 import "schema.proto";
+import "google/protobuf/descriptor.proto";
 
 service MilvusService {
   rpc CreateCollection(CreateCollectionRequest) returns (common.Status) {}
@@ -44,6 +50,7 @@ service MilvusService {
   rpc GetFlushState(GetFlushStateRequest) returns (GetFlushStateResponse) {}
   rpc GetPersistentSegmentInfo(GetPersistentSegmentInfoRequest) returns (GetPersistentSegmentInfoResponse) {}
   rpc GetQuerySegmentInfo(GetQuerySegmentInfoRequest) returns (GetQuerySegmentInfoResponse) {}
+  rpc GetReplicas(GetReplicasRequest) returns (GetReplicasResponse) {}
 
   rpc Dummy(DummyRequest) returns (DummyResponse) {}
 
@@ -56,6 +63,27 @@ service MilvusService {
   rpc GetCompactionState(GetCompactionStateRequest) returns (GetCompactionStateResponse) {}
   rpc ManualCompaction(ManualCompactionRequest) returns (ManualCompactionResponse) {}
   rpc GetCompactionStateWithPlans(GetCompactionPlansRequest) returns (GetCompactionPlansResponse) {}
+
+  // https://wiki.lfaidata.foundation/display/MIL/MEP+24+--+Support+bulk+load
+  rpc Import(ImportRequest) returns (ImportResponse) {}
+  rpc GetImportState(GetImportStateRequest) returns (GetImportStateResponse) {}
+  rpc ListImportTasks(ListImportTasksRequest) returns (ListImportTasksResponse) {}
+
+  // https://wiki.lfaidata.foundation/display/MIL/MEP+27+--+Support+Basic+Authentication
+  rpc CreateCredential(CreateCredentialRequest) returns (common.Status) {}
+  rpc UpdateCredential(UpdateCredentialRequest) returns (common.Status) {}
+  rpc DeleteCredential(DeleteCredentialRequest) returns (common.Status) {}
+  rpc ListCredUsers(ListCredUsersRequest) returns (ListCredUsersResponse) {}
+
+  // https://wiki.lfaidata.foundation/display/MIL/MEP+29+--+Support+Role-Based+Access+Control
+  rpc CreateRole(CreateRoleRequest) returns (common.Status) {}
+  rpc DropRole(DropRoleRequest) returns (common.Status) {}
+  rpc OperateUserRole(OperateUserRoleRequest) returns (common.Status) {}
+  rpc SelectRole(SelectRoleRequest) returns (SelectRoleResponse) {}
+  rpc SelectUser(SelectUserRequest) returns (SelectUserResponse) {}
+  rpc SelectResource(SelectResourceRequest) returns (SelectResourceResponse) {}
+  rpc OperatePrivilege(OperatePrivilegeRequest) returns (common.Status) {}
+  rpc SelectGrant(SelectGrantRequest) returns (SelectGrantResponse) {}
 }
 
 message CreateAliasRequest {
@@ -82,14 +110,19 @@ message AlterAliasRequest{
 * Create collection in milvus
 */
 message CreateCollectionRequest {
+  option (common.privilege_ext_obj) = {
+    resource_type: Collection
+    resource_privilege: PrivilegeCreate
+    resource_name_index: 3
+  };
   // 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; 
+  string collection_name = 3;
   // The serialized `schema.CollectionSchema`(Required)
-  bytes schema = 4; 
+  bytes schema = 4;
   // Once set, no modification is allowed (Optional)
   // https://github.com/milvus-io/milvus/issues/6690
   int32 shards_num = 5;
@@ -98,11 +131,16 @@ message CreateCollectionRequest {
 }
 
 /**
-* Drop collection in milvus, also will drop data in collection. 
+* Drop collection in milvus, also will drop data in collection.
 */
 message DropCollectionRequest {
+  option (common.privilege_ext_obj) = {
+    resource_type: Collection
+    resource_privilege: PrivilegeDrop
+    resource_name_index: 3
+  };
   // Not useful for now
-  common.MsgBase base = 1; 
+  common.MsgBase base = 1;
   // Not useful for now
   string db_name = 2;
   // The unique collection name in milvus.(Required)
@@ -113,12 +151,17 @@ message DropCollectionRequest {
 * Check collection exist in milvus or not.
 */
 message HasCollectionRequest {
+  option (common.privilege_ext_obj) = {
+    resource_type: Collection
+    resource_privilege: PrivilegeRead
+    resource_name_index: 3
+  };
   // 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; 
+  string collection_name = 3;
   // If time_stamp is not zero, will return true when time_stamp >= created collection timestamp, otherwise will return false.
   uint64 time_stamp = 4;
 }
@@ -138,6 +181,11 @@ message StringResponse {
 * Get collection meta datas like: schema, collectionID, shards number ...
 */
 message DescribeCollectionRequest {
+  option (common.privilege_ext_obj) = {
+    resource_type: Collection
+    resource_privilege: PrivilegeRead
+    resource_name_index: 3
+  };
   // Not useful for now
   common.MsgBase base = 1;
   // Not useful for now
@@ -176,24 +224,38 @@ message DescribeCollectionResponse {
   repeated common.KeyDataPair start_positions = 10;
   // The consistency level that the collection used, modification is not supported now.
   common.ConsistencyLevel consistency_level = 11;
+  // The collection name
+  string collection_name = 12;
 }
 
 /**
 * Load collection data into query nodes, then you can do vector search on this collection.
 */
 message LoadCollectionRequest {
+  option (common.privilege_ext_obj) = {
+    resource_type: Collection
+    resource_privilege: PrivilegeLoad
+    resource_name_index: 3
+  };
   // 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;
 }
 
 /**
 * Release collection data from query nodes, then you can't do vector search on this collection.
 */
 message ReleaseCollectionRequest {
+  option (common.privilege_ext_obj) = {
+    resource_type: Collection
+    resource_privilege: PrivilegeRelease
+    resource_name_index: 3
+  };
   // Not useful for now
   common.MsgBase base = 1;
   // Not useful for now
@@ -206,6 +268,11 @@ message ReleaseCollectionRequest {
 * Get collection statistics like row_count.
 */
 message GetCollectionStatisticsRequest {
+  option (common.privilege_ext_obj) = {
+    resource_type: Collection
+    resource_privilege: PrivilegeRead
+    resource_name_index: 3
+  };
   // Not useful for now
   common.MsgBase base = 1;
   // Not useful for now
@@ -228,16 +295,20 @@ message GetCollectionStatisticsResponse {
 * This is for ShowCollectionsRequest type field.
 */
 enum ShowType {
-  // Will return all colloections 
+  // Will return all colloections
   All = 0;
   // Will return loaded collections with their inMemory_percentages
   InMemory = 1;
 }
 
 /*
-* List collections 
+* List collections
 */
 message ShowCollectionsRequest {
+  option (common.privilege_ext_obj) = {
+    resource_type: Collection
+    resource_privilege: PrivilegeRead
+  };
   // Not useful for now
   common.MsgBase base = 1;
   // Not useful for now
@@ -247,7 +318,7 @@ message ShowCollectionsRequest {
   // Decide return Loaded collections or All collections(Optional)
   ShowType type = 4;
   // When type is InMemory, will return these collection's inMemory_percentages.(Optional)
-  repeated string collection_names = 5; 
+  repeated string collection_names = 5;
 }
 
 /*
@@ -265,7 +336,9 @@ message ShowCollectionsResponse {
   // The utc timestamp calculated by created_timestamp
   repeated uint64 created_utc_timestamps = 5;
   // Load percentage on querynode when type is InMemory
-  repeated int64 inMemory_percentages = 6; 
+  repeated int64 inMemory_percentages = 6;
+  // Indicate whether query service is available
+  repeated bool query_service_available = 7;
 }
 
 /*
@@ -293,7 +366,7 @@ message DropPartitionRequest {
   // The collection name in milvus
   string collection_name = 3;
   // The partition name you want to drop
-  string partition_name = 4; 
+  string partition_name = 4;
 }
 
 /*
@@ -323,6 +396,8 @@ message LoadPartitionsRequest {
   string collection_name = 3;
   // The partition names you want to load
   repeated string partition_names = 4;
+  // The replicas number you would load, 1 by default
+  int32 replica_number = 5;
 }
 
 /*
@@ -351,7 +426,7 @@ message GetPartitionStatisticsRequest {
   // The collection name in milvus
   string collection_name = 3;
   // The partition name you want to collect statistics
-  string partition_name = 4; 
+  string partition_name = 4;
 }
 
 message GetPartitionStatisticsResponse {
@@ -426,7 +501,7 @@ message ShowSegmentsResponse {
 */
 message CreateIndexRequest {
   // Not useful for now
-  common.MsgBase base = 1; 
+  common.MsgBase base = 1;
   // Not useful for now
   string db_name = 2;
   // The particular collection name you want to create index.
@@ -434,11 +509,13 @@ message CreateIndexRequest {
   // 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; 
+  repeated common.KeyValuePair extra_params = 5;
+  // Version before 2.0.2 doesn't contain index_name, we use default index name.
+  string index_name = 6;
 }
 
 /*
-* Get created index information. 
+* Get created index information.
 * Current release of Milvus only supports showing latest built index.
 */
 message DescribeIndexRequest {
@@ -451,7 +528,7 @@ message DescribeIndexRequest {
    // The vector field name in this particular collection
   string field_name = 4;
   // No need to set up for now @2021.06.30
-  string index_name = 5; 
+  string index_name = 5;
 }
 
 /*
@@ -479,7 +556,7 @@ message DescribeIndexResponse {
 }
 
 /*
-*  Get index building progress 
+*  Get index building progress
 */
 message GetIndexBuildProgressRequest {
   // Not useful for now
@@ -553,22 +630,6 @@ message DeleteRequest {
   repeated uint32 hash_keys = 6;
 }
 
-enum PlaceholderType {
-  None = 0;
-  BinaryVector = 100;
-  FloatVector = 101;
-}
-
-message PlaceholderValue {
-  string tag = 1;
-  PlaceholderType type = 2;
-  // values is a 2d-array, every array contains a vector
-  repeated bytes values = 3;
-}
-
-message PlaceholderGroup {
-  repeated PlaceholderValue placeholders = 1;
-}
 
 message SearchRequest {
   common.MsgBase base = 1; // must
@@ -583,6 +644,7 @@ message SearchRequest {
   repeated common.KeyValuePair search_params = 9; // must
   uint64 travel_timestamp = 10;
   uint64 guarantee_timestamp = 11; // guarantee_timestamp
+  int64  nq = 12;
 }
 
 message Hits {
@@ -594,6 +656,7 @@ message Hits {
 message SearchResults {
   common.Status status = 1;
   schema.SearchResultData results = 2;
+  string collection_name = 3;
 }
 
 message FlushRequest {
@@ -622,6 +685,7 @@ message QueryRequest {
 message QueryResults {
   common.Status status = 1;
   repeated schema.FieldData fields_data = 2;
+  string collection_name = 3;
 }
 
 message VectorIDs {
@@ -635,7 +699,7 @@ message VectorsArray {
   oneof array {
     VectorIDs id_array = 1; // vector ids
     schema.VectorField data_array = 2; // vectors data
-  } 
+  }
 }
 
 message CalcDistanceRequest {
@@ -681,8 +745,10 @@ message QuerySegmentInfo {
   int64 num_rows = 5;
   string index_name = 6;
   int64 indexID = 7;
+  // deprecated, check node_ids(NodeIds) field
   int64 nodeID = 8;
   common.SegmentState state = 9;
+  repeated int64 nodeIds = 10;
 }
 
 message GetQuerySegmentInfoRequest {
@@ -731,6 +797,7 @@ message LoadBalanceRequest {
   int64 src_nodeID = 2;
   repeated int64 dst_nodeIDs = 3;
   repeated int64 sealed_segmentIDs = 4;
+  string collectionName = 5;
 }
 
 message ManualCompactionRequest {
@@ -779,6 +846,296 @@ message GetFlushStateResponse {
   bool flushed = 2;
 }
 
+message ImportRequest {
+  string collection_name = 1;                // target collection
+  string partition_name = 2;                 // target partition
+  repeated string channel_names = 3;         // channel names for the collection
+  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.
+}
+
+message ImportResponse {
+  common.Status status = 1;
+  repeated int64 tasks = 2;  // id array of import tasks
+}
+
+message GetImportStateRequest {
+  int64 task = 1;  // id of an import task
+}
+
+message GetImportStateResponse {
+  common.Status status = 1;
+  common.ImportState state = 2;                      // is this import task finished or not
+  int64 row_count = 3;                               // if the task is finished, this value is how many rows are imported. if the task is not finished, this value is how many rows are parsed. return 0 if failed.
+  repeated int64 id_list = 4;                        // auto generated ids if the primary key is autoid
+  repeated common.KeyValuePair infos = 5;            // more information about the task, progress percent, file path, failed reason, etc.
+  int64 id = 6;                                      // id of an import task
+  bool data_queryable = 7;                           // A flag indicating whether import data are queryable (i.e. loaded in query nodes)
+  bool data_indexed = 8;                             // A flag indicating whether import data are indexed.
+}
+
+message ListImportTasksRequest {
+}
+
+message ListImportTasksResponse {
+  common.Status status = 1;
+  repeated GetImportStateResponse tasks = 2;  // list of all import tasks
+}
+
+message GetReplicasRequest {
+  common.MsgBase base = 1;
+  int64 collectionID = 2;
+  bool with_shard_nodes = 3;
+}
+
+message GetReplicasResponse {
+  common.Status status = 1;
+  repeated ReplicaInfo replicas = 2;
+}
+
+message ReplicaInfo {    // ReplicaGroup
+  int64 replicaID = 1;
+  int64 collectionID = 2;
+  repeated int64 partition_ids = 3;    // empty indicates to load collection
+  repeated ShardReplica shard_replicas = 4;
+  repeated int64 node_ids = 5; // include leaders
+}
+
+message ShardReplica {
+    int64 leaderID = 1;
+    string leader_addr = 2; // IP:port
+    string dm_channel_name = 3;
+    // optional, DO NOT save it in meta, set it only for GetReplicas()
+    // if with_shard_nodes is true
+    repeated int64 node_ids = 4;
+}
+
 service ProxyService {
   rpc RegisterLink(RegisterLinkRequest) returns (RegisterLinkResponse) {}
 }
+
+// https://wiki.lfaidata.foundation/display/MIL/MEP+27+--+Support+Basic+Authentication
+
+message CreateCredentialRequest {
+  // Not useful for now
+  common.MsgBase base = 1;
+  // username
+  string username = 2;
+  // ciphertext password
+  string password = 3;
+  // create time
+  uint64 created_utc_timestamps = 4;
+  // modify time
+  uint64 modified_utc_timestamps = 5;
+}
+
+message UpdateCredentialRequest {
+  // Not useful for now
+  common.MsgBase base = 1;
+  // username
+  string username = 2;
+  // old password
+  string oldPassword = 3;
+  // new password
+  string newPassword = 4;
+  // create time
+  uint64 created_utc_timestamps = 5;
+  // modify time
+  uint64 modified_utc_timestamps = 6;
+}
+
+message DeleteCredentialRequest {
+  // Not useful for now
+  common.MsgBase base = 1;
+  // Not useful for now
+  string username = 2;
+}
+
+message ListCredUsersResponse {
+  // Contain error_code and reason
+  common.Status status = 1;
+  // username array
+  repeated string usernames = 2;
+}
+
+message ListCredUsersRequest {
+  // Not useful for now
+  common.MsgBase base = 1;
+}
+
+// https://wiki.lfaidata.foundation/display/MIL/MEP+29+--+Support+Role-Based+Access+Control
+message RoleEntity {
+  string name = 1;
+}
+
+message UserEntity {
+  string name = 1;
+}
+
+message CreateRoleRequest {
+  // Not useful for now
+  common.MsgBase base = 1;
+  // role
+  RoleEntity entity = 2;
+}
+
+message DropRoleRequest {
+  // Not useful for now
+  common.MsgBase base = 1;
+  // role name
+  string role_name = 2;
+}
+
+enum OperateUserRoleType {
+  AddUserToRole = 0;
+  RemoveUserFromRole = 1;
+}
+
+message OperateUserRoleRequest {
+  // Not useful for now
+  common.MsgBase base = 1;
+  // username
+  string username = 2;
+  // role name
+  string role_name = 3;
+  // operation type
+  OperateUserRoleType type = 4;
+}
+
+message SelectRoleRequest {
+  // Not useful for now
+  common.MsgBase base = 1;
+  // role
+  RoleEntity role = 2;
+  // include user info
+  bool include_user_info = 3;
+}
+
+message RoleResult {
+  RoleEntity role = 1;
+  repeated UserEntity users = 2;
+}
+
+message SelectRoleResponse {
+  // Not useful for now
+  common.Status status = 1;
+  // role result array
+  repeated RoleResult results = 2;
+}
+
+message SelectUserRequest {
+  // Not useful for now
+  common.MsgBase base = 1;
+  // user
+  UserEntity user = 2;
+  // include user info
+  bool include_role_info = 3;
+}
+
+message UserResult {
+  UserEntity user = 1;
+  repeated RoleEntity roles = 2;
+}
+
+message SelectUserResponse {
+  // Not useful for now
+  common.Status status = 1;
+  // user result array
+  repeated UserResult result = 2;
+}
+
+message ResourceEntity {
+  string type = 1;
+}
+
+message PrivilegeEntity {
+  string name = 1;
+}
+
+message SelectResourceRequest {
+  // Not useful for now
+  common.MsgBase base = 1;
+  // resource
+  ResourceEntity entity = 2;
+  // include privilege info
+  bool include_privilege_info = 3;
+}
+
+message ResourceResult {
+  ResourceEntity resource = 1;
+  repeated PrivilegeEntity privileges = 2;
+}
+
+message SelectResourceResponse {
+  // Not useful for now
+  common.Status status = 1;
+  // resource result array
+  repeated ResourceResult results = 2;
+}
+
+message PrincipalEntity {
+  // principal type, including user, role
+  string principal_type = 1;
+  // principal, including user entity or role entity
+  oneof principal {
+    UserEntity user = 2;
+    RoleEntity role = 3;
+  }
+}
+
+message GrantorEntity {
+  UserEntity user = 1;
+  PrivilegeEntity privilege = 2;
+}
+
+message GrantEntity {
+  // principal
+  PrincipalEntity principal = 1;
+  // resource
+  ResourceEntity resource = 2;
+  // resource name
+  string resource_name = 3;
+  // privilege
+  GrantorEntity grantor = 4;
+}
+
+message SelectGrantRequest {
+  // Not useful for now
+  common.MsgBase base = 1;
+  // grant
+  GrantEntity entity = 2;
+}
+
+message SelectGrantResponse {
+  // Not useful for now
+  common.Status status = 1;
+  // grant info array
+  repeated GrantEntity entities = 2;
+}
+
+enum OperatePrivilegeType {
+  Grant = 0;
+  Revoke = 1;
+}
+
+message OperatePrivilegeRequest {
+  // Not useful for now
+  common.MsgBase base = 1;
+  // grant
+  GrantEntity entity = 2;
+  // operation type
+  OperatePrivilegeType type = 3;
+}
+
+message MilvusExt {
+  string version = 1;
+}
+
+extend google.protobuf.FileOptions {
+  MilvusExt milvus_ext_obj = 1001;
+}
+
+option (milvus_ext_obj) = {
+  version: "2.1.0"
+};

package/dist/{grpc-proto → proto/proto}/schema.proto

@@ -1,11 +1,16 @@
 syntax = "proto3";
-
 package milvus.proto.schema;
+
 option go_package = "github.com/milvus-io/milvus/internal/proto/schemapb";
 
+option java_multiple_files = true;
+option java_package = "io.milvus.grpc";
+option java_outer_classname = "SchemaProto";
+option java_generate_equals_and_hash = true;
+
 import "common.proto";
 
-/**
+/** 
  * @brief Field data type
  */
 enum DataType {
@@ -20,6 +25,7 @@ enum DataType {
   Double = 11;
 
   String = 20;
+  VarChar = 21; // variable-length strings with a specified maximum length
 
   BinaryVector = 100;
   FloatVector = 101;
@@ -123,3 +129,4 @@ message SearchResultData {
   IDs ids = 5;
   repeated int64 topks = 6;
 }
+

package/dist/sdk.json

@@ -1 +1 @@
-{"version":"2.0.1","milvusVersion":"v2.0.1"}
+{"version":"2.1.0","milvusVersion":"v2.1.0"}

package/package.json

@@ -1,16 +1,18 @@
 {
   "name": "@zilliz/milvus2-sdk-node",
   "author": "ued@zilliz.com",
-  "version": "2.0.1",
-  "milvusVersion": "v2.0.1",
+  "version": "2.1.0",
+  "milvusVersion": "v2.1.0",
   "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",
+    "testAll": "jest --testPathIgnorePatterns=/test/build/",
     "test": "jest",
-    "coverage": "jest --coverage=true --testPathIgnorePatterns=/test/build/",
+    "coverage": "jest --coverage=true --config jest.config.js --no-cache --testPathIgnorePatterns=/test/build/ test/User.spec.ts ",
     "build-test": "yarn build && jest test/build/Collection.spec.ts",
     "example": "npx ts-node",
     "doc": "rm -rf docs && npx typedoc && node doc",
@@ -23,7 +25,7 @@
     "@microsoft/api-extractor": "^7.18.5",
     "json-schema": "^0.4.0",
     "node-forge": "^1.0.0",
-    "protobufjs": "^6.11.2"
+    "protobufjs": "^6.11.3"
   },
   "devDependencies": {
     "@babel/plugin-transform-modules-commonjs": "^7.13.8",