@zilliz/milvus2-sdk-node 2.2.2 → 2.2.4

package/dist/milvus/Resource.js

@@ -0,0 +1,356 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Resource = void 0;
+var utils_1 = require("../utils");
+var Client_1 = require("./Client");
+var Milvus_1 = require("./const/Milvus");
+var Resource = /** @class */ (function (_super) {
+    __extends(Resource, _super);
+    function Resource() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * Create a resource group.
+     *
+     * @param data
+     *  | Property | Type | Description |
+     *  | :--- | :-- | :-- |
+     *  | resource_group | String | Resource group 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 | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | status.error_code | string | error code |
+     *  | status.reason | string | error reason |
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).resourceManager.createResourceGroup({
+     *     resource_group: "vector_01",
+     *  });
+     * ```
+     */
+    Resource.prototype.createResourceGroup = function (data) {
+        return __awaiter(this, void 0, void 0, function () {
+            var promise;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'CreateResourceGroup', data, data.timeout)];
+                    case 1:
+                        promise = _a.sent();
+                        return [2 /*return*/, promise];
+                }
+            });
+        });
+    };
+    /**
+     * list resource groups.
+     *
+     * @returns
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | status.error_code | string | error code |
+     *  | status.reason | string | error reason |
+     *  | resource_groups | string[] | Resource group string array |
+     *  | 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 |
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).resourceManager.listResourceGroups();
+     * ```
+     */
+    Resource.prototype.listResourceGroups = function (data) {
+        return __awaiter(this, void 0, void 0, function () {
+            var promise;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'ListResourceGroups', {}, data === null || data === void 0 ? void 0 : data.timeout)];
+                    case 1:
+                        promise = _a.sent();
+                        return [2 /*return*/, promise];
+                }
+            });
+        });
+    };
+    /**
+     * Describe a resource group.
+     *
+     * @param data
+     *  | Property | Type | Description |
+     *  | :--- | :-- | :-- |
+     *  | resource_group | String | Resource group 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 | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | status.error_code | string | error code |
+     *  | status.reason | string | error reason |
+     *  | resource_group.capacity | number | num_node which has been transfer to this rg |
+     *  | resource_group.num_available_node | number | available node_num, some node may shutdown |
+     *  | resource_group.num_loaded_replica | { [key: string]: number } | from collection_name to loaded replica of each collecion in this rg |
+     *  | resource_group.num_outgoing_node | { [key: string]: number } | from collection_name to outgoging accessed node num by replica loaded in this rg |
+     *  | resource_group.num_incoming_node | { [key: string]: number } | from collection_name to incoming accessed node num by replica loaded in other rg |
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).resourceManager.describeResrouceGroup({
+     *    resource_group: 'my-resource-group'
+     * });
+     * ```
+     */
+    Resource.prototype.describeResourceGroup = function (data) {
+        return __awaiter(this, void 0, void 0, function () {
+            var promise;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'DescribeResourceGroup', data, data.timeout)];
+                    case 1:
+                        promise = _a.sent();
+                        return [2 /*return*/, promise];
+                }
+            });
+        });
+    };
+    /**
+     * drop a resource group.
+     * @param data
+     *  | Property | Type | Description |
+     *  | :--- | :-- | :-- |
+     *  | resource_group | String | Resource group 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 | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | status.error_code | string | error code |
+     *  | status.reason | string | error reason |
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).resourceManager.dropResourceGroup({
+     *    resource_group: 'my-resource-group'
+     * });
+     * ```
+     */
+    Resource.prototype.dropResourceGroup = function (data) {
+        return __awaiter(this, void 0, void 0, function () {
+            var promise;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'DropResourceGroup', data, data.timeout)];
+                    case 1:
+                        promise = _a.sent();
+                        return [2 /*return*/, promise];
+                }
+            });
+        });
+    };
+    /**
+     * transfer nodes from one resource group to another
+     * @param data
+     *  | Property | Type | Description |
+     *  | :--- | :-- | :-- |
+     *  | source_resource_group | String | source resource group name |
+     *  | target_resource_group | String | target resource group name |
+     *  | collection_name | String | collection name |
+     *  | num_replica | Number | number of replicas to transfer |
+     *  | 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 | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | status.error_code | string | error code |
+     *  | status.reason | string | error reason |
+     *
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).resourceManager.transferNode({
+     *    source_resource_group: 'source-resource-group',
+     *    target_resource_group: 'target-resource-group',
+     *    collection_name: 'my-collection',
+     *    num_replica: 2
+     * });
+     * ```
+     */
+    /* istanbul ignore next */
+    Resource.prototype.transferReplica = function (data) {
+        return __awaiter(this, void 0, void 0, function () {
+            var promise;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'TransferReplica', data, data.timeout)];
+                    case 1:
+                        promise = _a.sent();
+                        return [2 /*return*/, promise];
+                }
+            });
+        });
+    };
+    /**
+     * transfer nodes from one resource group to another
+     * @param data
+     *  | Property | Type | Description |
+     *  | :--- | :-- | :-- |
+     *  | source_resource_group | String | source resource group name |
+     *  | target_resource_group | String | target resource group name |
+     *  | num_node | Number | number of nodes to transfer |
+     *  | 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 | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | status.error_code | string | error code |
+     *  | status.reason | string | error reason |
+     *
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).resourceManager.transferNode({
+     *    source_resource_group: 'source-resource-group',
+     *    target_resource_group: 'target-resource-group',
+     *    num_node: 4
+     * });
+     * ```
+     */
+    /* istanbul ignore next */
+    Resource.prototype.transferNode = function (data) {
+        return __awaiter(this, void 0, void 0, function () {
+            var promise;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'TransferNode', data, data.timeout)];
+                    case 1:
+                        promise = _a.sent();
+                        return [2 /*return*/, promise];
+                }
+            });
+        });
+    };
+    /**
+     * drop all resource groups, transfer all nodes to the default group
+     *
+     * @returns
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | status.error_code | string | error code |
+     *  | status.reason | string[] | error reason |
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).resourceManager.dropResourceGroups();
+     * ```
+     */
+    Resource.prototype.dropAllResourceGroups = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var resource_groups, res, i, sourceRg, detail, _a, _b;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0: return [4 /*yield*/, this.listResourceGroups()];
+                    case 1:
+                        resource_groups = (_c.sent()).resource_groups;
+                        res = [];
+                        i = 0;
+                        _c.label = 2;
+                    case 2:
+                        if (!(i < resource_groups.length)) return [3 /*break*/, 8];
+                        sourceRg = resource_groups[i];
+                        if (!(sourceRg !== Milvus_1.DEFAULT_RESOURCE_GROUP)) return [3 /*break*/, 7];
+                        return [4 /*yield*/, this.describeResourceGroup({
+                                resource_group: sourceRg,
+                            })];
+                    case 3:
+                        detail = _c.sent();
+                        if (!(detail.resource_group.capacity > 0)) return [3 /*break*/, 5];
+                        // istanbul ignore next
+                        return [4 /*yield*/, this.transferNode({
+                                source_resource_group: sourceRg,
+                                target_resource_group: Milvus_1.DEFAULT_RESOURCE_GROUP,
+                                num_node: detail.resource_group.capacity,
+                            })];
+                    case 4:
+                        // istanbul ignore next
+                        _c.sent();
+                        _c.label = 5;
+                    case 5:
+                        // drop rg
+                        _b = (_a = res).push;
+                        return [4 /*yield*/, this.dropResourceGroup({
+                                resource_group: sourceRg,
+                            })];
+                    case 6:
+                        // drop rg
+                        _b.apply(_a, [_c.sent()]);
+                        _c.label = 7;
+                    case 7:
+                        i++;
+                        return [3 /*break*/, 2];
+                    case 8: return [2 /*return*/, Promise.all(res)];
+                }
+            });
+        });
+    };
+    return Resource;
+}(Client_1.Client));
+exports.Resource = Resource;
+//# sourceMappingURL=Resource.js.map

package/dist/milvus/Resource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Resource.js","sourceRoot":"","sources":["../../milvus/Resource.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kCAAqC;AACrC,mCAAkC;AAElC,yCAAwD;AAYxD;IAA8B,4BAAM;IAApC;;IAyQA,CAAC;IAxQC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,sCAAmB,GAAzB,UAA0B,IAA4B;;;;;4BACpC,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,MAAM,EACX,qBAAqB,EACrB,IAAI,EACJ,IAAI,CAAC,OAAO,CACb,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;OAgBG;IACG,qCAAkB,GAAxB,UACE,IAAkB;;;;;4BAEF,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,MAAM,EACX,oBAAoB,EACpB,EAAE,EACF,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,CACd,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,wCAAqB,GAA3B,UACE,IAA8B;;;;;4BAEd,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,MAAM,EACX,uBAAuB,EACvB,IAAI,EACJ,IAAI,CAAC,OAAO,CACb,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,oCAAiB,GAAvB,UAAwB,IAA2B;;;;;4BACjC,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,MAAM,EACX,mBAAmB,EACnB,IAAI,EACJ,IAAI,CAAC,OAAO,CACb,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,0BAA0B;IACpB,kCAAe,GAArB,UAAsB,IAAwB;;;;;4BAC5B,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,MAAM,EACX,iBAAiB,EACjB,IAAI,EACJ,IAAI,CAAC,OAAO,CACb,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,0BAA0B;IACpB,+BAAY,GAAlB,UAAmB,IAAqB;;;;;4BACtB,qBAAM,IAAA,iBAAS,EAC7B,IAAI,CAAC,MAAM,EACX,cAAc,EACd,IAAI,EACJ,IAAI,CAAC,OAAO,CACb,EAAA;;wBALK,OAAO,GAAG,SAKf;wBACD,sBAAO,OAAO,EAAC;;;;KAChB;IAED;;;;;;;;;;;;;;OAcG;IACG,wCAAqB,GAA3B;;;;;4BAE8B,qBAAM,IAAI,CAAC,kBAAkB,EAAE,EAAA;;wBAAnD,eAAe,GAAK,CAAA,SAA+B,CAAA,gBAApC;wBAEjB,GAAG,GAAG,EAAE,CAAC;wBAKN,CAAC,GAAG,CAAC;;;6BAAE,CAAA,CAAC,GAAG,eAAe,CAAC,MAAM,CAAA;wBAClC,QAAQ,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC;6BAChC,CAAA,QAAQ,KAAK,+BAAsB,CAAA,EAAnC,wBAAmC;wBAEtB,qBAAM,IAAI,CAAC,qBAAqB,CAAC;gCAC9C,cAAc,EAAE,QAAQ;6BACzB,CAAC,EAAA;;wBAFI,MAAM,GAAG,SAEb;6BAGE,CAAA,MAAM,CAAC,cAAc,CAAC,QAAQ,GAAG,CAAC,CAAA,EAAlC,wBAAkC;wBACpC,uBAAuB;wBACvB,qBAAM,IAAI,CAAC,YAAY,CAAC;gCACtB,qBAAqB,EAAE,QAAQ;gCAC/B,qBAAqB,EAAE,+BAAsB;gCAC7C,QAAQ,EAAE,MAAM,CAAC,cAAc,CAAC,QAAQ;6BACzC,CAAC,EAAA;;wBALF,uBAAuB;wBACvB,SAIE,CAAC;;;wBAGL,UAAU;wBACV,KAAA,CAAA,KAAA,GAAG,CAAA,CAAC,IAAI,CAAA;wBACN,qBAAM,IAAI,CAAC,iBAAiB,CAAC;gCAC3B,cAAc,EAAE,QAAQ;6BACzB,CAAC,EAAA;;wBAJJ,UAAU;wBACV,cACE,SAEE,EACH,CAAC;;;wBAvBsC,CAAC,EAAE,CAAA;;4BA0B/C,sBAAO,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAC;;;;KACzB;IACH,eAAC;AAAD,CAAC,AAzQD,CAA8B,eAAM,GAyQnC;AAzQY,4BAAQ"}