@zilliz/milvus2-sdk-node 2.2.2 → 2.2.4

package/dist/proto/proto/common.proto

@@ -68,7 +68,9 @@ enum ErrorCode {
     MemoryQuotaExhausted = 53;
     DiskQuotaExhausted = 54;
     TimeTickLongDelay = 55;
-
+    NotReadyServe = 56;
+    // Coord is switching from standby mode to active mode 
+    NotReadyCoordActivating = 57;
     // Service availability.
     // NA: Not Available.
     DataCoordNA = 100;
@@ -154,7 +156,7 @@ enum MsgType {
     DropAlias = 109;
     AlterAlias = 110;
     AlterCollection = 111;
-
+    RenameCollection = 112;
 
     /* DEFINITION REQUESTS: PARTITION */
     CreatePartition = 200;
@@ -243,6 +245,14 @@ enum MsgType {
     SelectGrant = 1607;
     RefreshPolicyInfoCache = 1608;
     ListPolicy = 1609;
+
+    /* Resource group */
+    CreateResourceGroup = 1700;
+    DropResourceGroup = 1701;
+    ListResourceGroups = 1702;
+    DescribeResourceGroup = 1703;
+    TransferNode = 1704;
+    TransferReplica = 1705;
 }
 
 message MsgBase {
@@ -327,6 +337,14 @@ enum ObjectPrivilege {
     PrivilegeManageOwnership = 23;
     PrivilegeSelectUser = 24;
     PrivilegeUpsert = 25;
+    PrivilegeCreateResourceGroup = 26;
+    PrivilegeDropResourceGroup = 27;
+    PrivilegeDescribeResourceGroup = 28;
+    PrivilegeListResourceGroups = 29;
+    PrivilegeTransferNode = 30;
+    PrivilegeTransferReplica = 31;
+    PrivilegeGetLoadingProgress = 32;
+    PrivilegeGetLoadState = 33;
 }
 
 message PrivilegeExt {
@@ -354,3 +372,8 @@ enum LoadState {
     LoadStateLoading = 2;
     LoadStateLoaded = 3;
 }
+
+message SegmentStats {
+    int64 SegmentID = 1;
+    int64 NumRows = 2;
+}

package/dist/proto/proto/google/protobuf/descriptor.proto

@@ -631,6 +631,36 @@ message FieldOptions {
   // formats, e.g. when the field contains sensitive credentials.
   optional bool debug_redact = 16 [default = false];
 
+  // If set to RETENTION_SOURCE, the option will be omitted from the binary.
+  // Note: as of January 2023, support for this is in progress and does not yet
+  // have an effect (b/264593489).
+  enum OptionRetention {
+    RETENTION_UNKNOWN = 0;
+    RETENTION_RUNTIME = 1;
+    RETENTION_SOURCE = 2;
+  }
+
+  optional OptionRetention retention = 17;
+
+  // This indicates the types of entities that the field may apply to when used
+  // as an option. If it is unset, then the field may be freely used as an
+  // option on any kind of entity. Note: as of January 2023, support for this is
+  // in progress and does not yet have an effect (b/264593489).
+  enum OptionTargetType {
+    TARGET_TYPE_UNKNOWN = 0;
+    TARGET_TYPE_FILE = 1;
+    TARGET_TYPE_EXTENSION_RANGE = 2;
+    TARGET_TYPE_MESSAGE = 3;
+    TARGET_TYPE_FIELD = 4;
+    TARGET_TYPE_ONEOF = 5;
+    TARGET_TYPE_ENUM = 6;
+    TARGET_TYPE_ENUM_ENTRY = 7;
+    TARGET_TYPE_SERVICE = 8;
+    TARGET_TYPE_METHOD = 9;
+  }
+
+  optional OptionTargetType target = 18;
+
   // The parser stores options it doesn't recognize here. See above.
   repeated UninterpretedOption uninterpreted_option = 999;
 

package/dist/proto/proto/milvus.proto

@@ -97,6 +97,15 @@ service MilvusService {
 
   rpc GetVersion(GetVersionRequest) returns (GetVersionResponse) {}
   rpc CheckHealth(CheckHealthRequest) returns (CheckHealthResponse) {}
+
+  rpc CreateResourceGroup(CreateResourceGroupRequest) returns (common.Status) {}
+  rpc DropResourceGroup(DropResourceGroupRequest) returns (common.Status) {}
+  rpc TransferNode(TransferNodeRequest) returns (common.Status) {}
+  rpc TransferReplica(TransferReplicaRequest) returns (common.Status) {}
+  rpc ListResourceGroups(ListResourceGroupsRequest) returns (ListResourceGroupsResponse) {}
+  rpc DescribeResourceGroup(DescribeResourceGroupRequest) returns (DescribeResourceGroupResponse) {}
+
+  rpc RenameCollection(RenameCollectionRequest) returns (common.Status) {}
 }
 
 message CreateAliasRequest {
@@ -274,6 +283,10 @@ message LoadCollectionRequest {
   string collection_name = 3;
   // The replica number to load, default by 1
   int32 replica_number = 4;
+  // create replica used resource group
+  repeated string resource_groups = 5;
+  // Whether to enable refresh mode.
+  bool refresh = 6;
 }
 
 /**
@@ -464,6 +477,10 @@ 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
+  repeated string resource_groups = 6;
+  // Whether to enable refresh mode.
+  bool refresh = 7;
 }
 
 /*
@@ -1065,6 +1082,7 @@ message GetReplicasRequest {
   common.MsgBase base = 1;
   int64 collectionID = 2;
   bool with_shard_nodes = 3;
+  string collection_name = 4;
 }
 
 message GetReplicasResponse {
@@ -1078,6 +1096,9 @@ message ReplicaInfo {    // ReplicaGroup
   repeated int64 partition_ids = 3;    // empty indicates to load collection
   repeated ShardReplica shard_replicas = 4;
   repeated int64 node_ids = 5; // include leaders
+  string resource_group_name = 6;
+  // outbound access rg -> node num
+  map<string, int32> num_outbound_node = 7;
 }
 
 message ShardReplica {
@@ -1335,6 +1356,11 @@ message OperatePrivilegeRequest {
 }
 
 message GetLoadingProgressRequest {
+  option (common.privilege_ext_obj) = {
+    object_type: Collection
+    object_privilege: PrivilegeGetLoadingProgress
+    object_name_index: 2
+  };
   // Not useful for now
   common.MsgBase base = 1;
   string collection_name = 2;
@@ -1347,6 +1373,11 @@ message GetLoadingProgressResponse {
 }
 
 message GetLoadStateRequest {
+  option (common.privilege_ext_obj) = {
+    object_type: Collection
+    object_privilege: PrivilegeGetLoadState
+    object_name_index: 2
+  };
   // Not useful for now
   common.MsgBase base = 1;
   string collection_name = 2;
@@ -1391,3 +1422,98 @@ message CheckHealthResponse {
   repeated string reasons = 3;
   repeated QuotaState quota_states = 4;
 }
+
+message CreateResourceGroupRequest {
+  option (common.privilege_ext_obj) = {
+    object_type: Global
+    object_privilege: PrivilegeCreateResourceGroup
+    object_name_index: -1
+  };
+  common.MsgBase base = 1;
+  string resource_group = 2;
+}
+
+message DropResourceGroupRequest {
+  option (common.privilege_ext_obj) = {
+    object_type: Global
+    object_privilege: PrivilegeDropResourceGroup
+    object_name_index: -1
+  };
+  common.MsgBase base = 1;
+  string resource_group = 2;
+}
+
+// transfer `nodeNum` nodes from `source_resource_group` to `target_resource_group`
+message TransferNodeRequest {
+  option (common.privilege_ext_obj) = {
+    object_type: Global
+    object_privilege: PrivilegeTransferNode
+    object_name_index: -1
+  };
+  common.MsgBase base = 1;
+  string source_resource_group = 2;
+  string target_resource_group = 3;
+  int32  num_node = 4;
+}
+
+// transfer `replicaNum` replicas in `collectionID` from `source_resource_group` to `target_resource_group`
+message TransferReplicaRequest {
+  option (common.privilege_ext_obj) = {
+    object_type: Global
+    object_privilege: PrivilegeTransferReplica
+    object_name_index: -1
+  };
+  common.MsgBase base = 1;
+  string source_resource_group = 2;
+  string target_resource_group = 3;
+  string  collection_name = 4;
+  int64  num_replica = 5;
+}
+
+message ListResourceGroupsRequest {
+  option (common.privilege_ext_obj) = {
+    object_type: Global
+    object_privilege: PrivilegeListResourceGroups
+    object_name_index: -1
+  };
+  common.MsgBase base = 1;
+}
+
+message ListResourceGroupsResponse {
+  common.Status status = 1;
+  repeated string  resource_groups = 2;
+}
+
+message DescribeResourceGroupRequest {
+  option (common.privilege_ext_obj) = {
+    object_type: Global
+    object_privilege: PrivilegeDescribeResourceGroup
+    object_name_index: -1
+  };
+  common.MsgBase base = 1;
+  string resource_group = 2;
+}
+
+message DescribeResourceGroupResponse {
+  common.Status status = 1;
+  ResourceGroup  resource_group = 2;
+}
+
+message ResourceGroup {
+  string name = 1;
+  int32 capacity = 2;
+  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
+  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 {
+  common.MsgBase base = 1;
+  string db = 2;
+  string oldName = 3;
+  string newName = 4;
+}

package/dist/proto/proto/msg.proto

@@ -0,0 +1,107 @@
+syntax = "proto3";
+package milvus.proto.msg;
+option go_package = "github.com/milvus-io/milvus-proto/go-api/msgpb";
+
+import "common.proto";
+import "schema.proto";
+
+enum InsertDataVersion {
+  // 0 must refer to row-based format, since it's the first version in Milvus.
+  RowBased = 0;
+  ColumnBased = 1;
+}
+
+message InsertRequest {
+  common.MsgBase base = 1;
+  string shardName = 2;
+  string db_name = 3;
+  string collection_name = 4;
+  string partition_name = 5;
+  int64 dbID = 6;
+  int64 collectionID = 7;
+  int64 partitionID = 8;
+  int64 segmentID = 9;
+  repeated uint64 timestamps = 10;
+  repeated int64 rowIDs = 11;
+  // row_data was reserved for compatibility
+  repeated common.Blob row_data = 12;
+  repeated schema.FieldData fields_data = 13;
+  uint64 num_rows = 14;
+  InsertDataVersion version = 15;
+}
+
+message DeleteRequest {
+  common.MsgBase base = 1;
+  string shardName = 2;
+  string db_name = 3;
+  string collection_name = 4;
+  string partition_name = 5;
+  int64 dbID = 6;
+  int64 collectionID = 7;
+  int64 partitionID = 8;
+  repeated int64 int64_primary_keys = 9; // deprecated
+  repeated uint64 timestamps = 10;
+  int64 num_rows = 11;
+  schema.IDs primary_keys = 12;
+}
+
+message MsgPosition {
+  string channel_name = 1;
+  bytes msgID = 2;
+  string msgGroup = 3;
+  uint64 timestamp = 4;
+}
+
+message CreateCollectionRequest {
+  common.MsgBase base = 1;
+  string db_name = 2;
+  string collectionName = 3;
+  string partitionName = 4;
+  // `schema` is the serialized `schema.CollectionSchema`
+  int64 dbID = 5;
+  int64 collectionID = 6;
+  int64 partitionID = 7;
+  bytes schema = 8;
+  repeated string virtualChannelNames = 9;
+  repeated string physicalChannelNames = 10;
+}
+
+message DropCollectionRequest {
+  common.MsgBase base = 1;
+  string db_name = 2;
+  string collectionName = 3;
+  int64 dbID = 4;
+  int64 collectionID = 5;
+}
+
+message CreatePartitionRequest {
+  common.MsgBase base = 1;
+  string db_name = 2;
+  string collection_name = 3;
+  string partition_name = 4;
+  int64 dbID = 5;
+  int64 collectionID = 6;
+  int64 partitionID = 7;
+}
+
+message DropPartitionRequest {
+  common.MsgBase base = 1;
+  string db_name = 2;
+  string collection_name = 3;
+  string partition_name = 4;
+  int64 dbID = 5;
+  int64 collectionID = 6;
+  int64 partitionID = 7;
+}
+
+message TimeTickMsg {
+  common.MsgBase base = 1;
+}
+
+message DataNodeTtMsg {
+  common.MsgBase base =1;
+  string channel_name = 2;
+  uint64 timestamp = 3;
+  repeated common.SegmentStats segments_stats = 4;
+}
+

package/dist/sdk.json

@@ -1 +1 @@
-{"version":"2.2.2","milvusVersion":"v2.2.1"}
+{"version":"2.2.4","milvusVersion":"2.2.0-latest"}

package/dist/utils/index.d.ts

@@ -1,7 +1 @@
 export declare function promisify(obj: any, target: string, params: any, timeout?: number): Promise<any>;
-export declare function generateInsertData(fields: {
-    isVector: boolean;
-    dim?: number;
-    name: string;
-    isBool?: boolean;
-}[], count: number): any[];

package/dist/utils/index.js

@@ -1,17 +1,11 @@
 "use strict";
-var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
-    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
-        if (ar || !(i in from)) {
-            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-            ar[i] = from[i];
-        }
-    }
-    return to.concat(ar || Array.prototype.slice.call(from));
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateInsertData = exports.promisify = void 0;
+exports.promisify = void 0;
+var Milvus_1 = require("../milvus/const/Milvus");
 function promisify(obj, target, params, timeout) {
-    var deadline = timeout ? new Date(Date.now() + timeout) : timeout;
+    var deadline = timeout
+        ? new Date(Date.now() + timeout)
+        : new Date(Date.now() + Milvus_1.DEFAULT_CONNECT_TIMEOUT);
     var res = new Promise(function (resolve, reject) {
         try {
             obj[target](params, { deadline: deadline }, function (err, result) {
@@ -30,25 +24,4 @@ function promisify(obj, target, params, timeout) {
     return res;
 }
 exports.promisify = promisify;
-function generateInsertData(fields, count) {
-    var results = [];
-    var _loop_1 = function () {
-        var value = {};
-        fields.forEach(function (v) {
-            var isVector = v.isVector, dim = v.dim, name = v.name, isBool = v.isBool;
-            value[name] = isVector
-                ? __spreadArray([], Array(dim), true).map(function () { return Math.random() * 10; })
-                : isBool
-                    ? count % 2 === 0
-                    : Math.floor(Math.random() * 100000);
-        });
-        results.push(value);
-        count--;
-    };
-    while (count > 0) {
-        _loop_1();
-    }
-    return results;
-}
-exports.generateInsertData = generateInsertData;
 //# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,SAAgB,SAAS,CACvB,GAAQ,EACR,MAAc,EACd,MAAW,EACX,OAAgB;IAEhB,IAAM,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;IAEpE,IAAM,GAAG,GAAG,IAAI,OAAO,CAAC,UAAC,OAAO,EAAE,MAAM;QACtC,IAAI;YACF,GAAG,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,QAAQ,UAAA,EAAE,EAAE,UAAC,GAAQ,EAAE,MAAW;gBACtD,IAAI,GAAG,EAAE;oBACP,MAAM,CAAC,GAAG,CAAC,CAAC;iBACb;gBACD,OAAO,CAAC,MAAM,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;SACJ;QAAC,OAAO,CAAM,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC;SACpB;IACH,CAAC,CAAC,CAAC,KAAK,CAAC,UAAA,GAAG;QACV,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,OAAO,GAAG,CAAC;AACb,CAAC;AAxBD,8BAwBC;AAED,SAAgB,kBAAkB,CAChC,MAA6E,EAC7E,KAAa;IAEb,IAAM,OAAO,GAAG,EAAE,CAAC;;QAEjB,IAAI,KAAK,GAAQ,EAAE,CAAC;QAEpB,MAAM,CAAC,OAAO,CAAC,UAAA,CAAC;YACN,IAAA,QAAQ,GAAwB,CAAC,SAAzB,EAAE,GAAG,GAAmB,CAAC,IAApB,EAAE,IAAI,GAAa,CAAC,KAAd,EAAE,MAAM,GAAK,CAAC,OAAN,CAAO;YAC1C,KAAK,CAAC,IAAI,CAAC,GAAG,QAAQ;gBACpB,CAAC,CAAC,kBAAI,KAAK,CAAC,GAAG,CAAC,QAAE,GAAG,CAAC,cAAM,OAAA,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,EAAlB,CAAkB,CAAC;gBAC/C,CAAC,CAAC,MAAM;oBACR,CAAC,CAAC,KAAK,GAAG,CAAC,KAAK,CAAC;oBACjB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpB,KAAK,EAAE,CAAC;;IAZV,OAAO,KAAK,GAAG,CAAC;;KAaf;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AApBD,gDAoBC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../utils/index.ts"],"names":[],"mappings":";;;AAAA,iDAAiE;AAEjE,SAAgB,SAAS,CACvB,GAAQ,EACR,MAAc,EACd,MAAW,EACX,OAAgB;IAEhB,IAAM,QAAQ,GAAG,OAAO;QACtB,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC;QAChC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,gCAAuB,CAAC,CAAC;IAEnD,IAAM,GAAG,GAAG,IAAI,OAAO,CAAC,UAAC,OAAO,EAAE,MAAM;QACtC,IAAI;YACF,GAAG,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,QAAQ,UAAA,EAAE,EAAE,UAAC,GAAQ,EAAE,MAAW;gBACtD,IAAI,GAAG,EAAE;oBACP,MAAM,CAAC,GAAG,CAAC,CAAC;iBACb;gBACD,OAAO,CAAC,MAAM,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;SACJ;QAAC,OAAO,CAAM,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC;SACpB;IACH,CAAC,CAAC,CAAC,KAAK,CAAC,UAAA,GAAG;QACV,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,OAAO,GAAG,CAAC;AACb,CAAC;AA1BD,8BA0BC"}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@zilliz/milvus2-sdk-node",
   "author": "ued@zilliz.com",
-  "version": "2.2.2",
-  "milvusVersion": "v2.2.1",
+  "version": "2.2.4",
+  "milvusVersion": "2.2.0-latest",
   "main": "dist/milvus",
   "files": [
     "dist"
@@ -15,16 +15,12 @@
     "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",
+    "doc": "rm -rf docs && npx typedoc",
     "doc-json": "npx typedoc milvus --json"
   },
   "dependencies": {
     "@grpc/grpc-js": "^1.2.12",
     "@grpc/proto-loader": "^0.7.3",
-    "@microsoft/api-documenter": "^7.13.39",
-    "@microsoft/api-extractor": "^7.18.5",
-    "json-schema": "^0.4.0",
-    "node-forge": "^1.0.0",
     "protobufjs": "^7.1.2"
   },
   "devDependencies": {
@@ -33,9 +29,8 @@
     "jest": "^29.2.1",
     "ts-jest": "^29.0.3",
     "ts-node": "^10.9.1",
-    "typedoc": "^0.23.17",
-    "typedoc-neo-theme": "^1.1.0",
-    "typescript": "^4.2.4"
+    "typedoc": "^0.23.26",
+    "typescript": "^4.9.5"
   },
   "publishConfig": {
     "access": "public"

package/dist/milvus/types/Search.d.ts

@@ -1,81 +0,0 @@
-/// <reference types="node" />
-import { DataType, GrpcTimeOut } from './Common';
-import { ResStatus } from './Response';
-export interface SearchParam {
-    anns_field: string;
-    topk: string;
-    metric_type: string;
-    params: string;
-    round_decimal?: number;
-}
-export interface SearchReq extends GrpcTimeOut {
-    collection_name: string;
-    partition_names?: string[];
-    expr?: string;
-    search_params: SearchParam;
-    vectors: number[][];
-    output_fields?: string[];
-    travel_timestamp?: string;
-    vector_type: DataType.BinaryVector | DataType.FloatVector;
-    nq?: number;
-}
-export interface SearchRes {
-    status: ResStatus;
-    results: {
-        top_k: number;
-        fields_data: {
-            type: string;
-            field_name: string;
-            field: 'scalars';
-            scalars: {
-                [x: string]: any;
-            };
-        }[];
-        scores: number[];
-        ids: {
-            int_id?: {
-                data: number[];
-            };
-            str_id?: {
-                data: string[];
-            };
-            id_field: 'int_id' | 'str_id';
-        };
-        num_queries: number;
-        topks: number[];
-    };
-}
-export interface QueryReq extends GrpcTimeOut {
-    collection_name: string;
-    expr: string;
-    output_fields?: string[];
-    partition_names?: string[];
-    offset?: number;
-    limit?: number;
-}
-export interface QueryRes {
-    status: ResStatus;
-    fields_data: {
-        type: DataType;
-        field_name: string;
-        field: 'vectors' | 'scalars';
-        field_id: number;
-        vectors?: {
-            dim: string;
-            data: 'float_vector' | 'binary_vector';
-            float_vector?: {
-                data: number[];
-            };
-            binary_vector?: Buffer;
-        };
-        scalars?: {
-            [x: string]: any;
-            data: string;
-        };
-    }[];
-}
-export interface GetMetricsRequest extends GrpcTimeOut {
-    request: {
-        metric_type: 'system_info' | 'system_statistics' | 'system_log';
-    };
-}

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

@@ -1 +0,0 @@
-{"version":3,"file":"Search.js","sourceRoot":"","sources":["../../../milvus/types/Search.ts"],"names":[],"mappings":""}