@zilliz/milvus2-sdk-node 2.2.3 → 2.2.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (93) hide show
  1. package/README.md +4 -21
  2. package/dist/milvus/BaseClient.d.ts +17 -0
  3. package/dist/milvus/BaseClient.js +58 -0
  4. package/dist/milvus/BaseClient.js.map +1 -0
  5. package/dist/milvus/Collection.d.ts +263 -171
  6. package/dist/milvus/Collection.js +328 -233
  7. package/dist/milvus/Collection.js.map +1 -1
  8. package/dist/milvus/Data.d.ts +142 -142
  9. package/dist/milvus/Data.js +211 -216
  10. package/dist/milvus/Data.js.map +1 -1
  11. package/dist/milvus/MilvusClient.d.ts +17 -0
  12. package/dist/milvus/MilvusClient.js +163 -0
  13. package/dist/milvus/MilvusClient.js.map +1 -0
  14. package/dist/milvus/MilvusIndex.d.ts +64 -60
  15. package/dist/milvus/MilvusIndex.js +74 -69
  16. package/dist/milvus/MilvusIndex.js.map +1 -1
  17. package/dist/milvus/Partition.d.ts +95 -88
  18. package/dist/milvus/Partition.js +108 -101
  19. package/dist/milvus/Partition.js.map +1 -1
  20. package/dist/milvus/Resource.d.ts +172 -0
  21. package/dist/milvus/Resource.js +356 -0
  22. package/dist/milvus/Resource.js.map +1 -0
  23. package/dist/milvus/User.d.ts +136 -110
  24. package/dist/milvus/User.js +171 -140
  25. package/dist/milvus/User.js.map +1 -1
  26. package/dist/milvus/Utils.d.ts +1 -1
  27. package/dist/milvus/Utils.js +1 -1
  28. package/dist/milvus/Utils.js.map +1 -1
  29. package/dist/milvus/const/Milvus.d.ts +270 -0
  30. package/dist/milvus/const/Milvus.js +370 -1
  31. package/dist/milvus/const/Milvus.js.map +1 -1
  32. package/dist/milvus/index.d.ts +11 -46
  33. package/dist/milvus/index.js +16 -186
  34. package/dist/milvus/index.js.map +1 -1
  35. package/dist/milvus/types/Collection.d.ts +88 -8
  36. package/dist/milvus/types/Collection.js +1 -9
  37. package/dist/milvus/types/Collection.js.map +1 -1
  38. package/dist/milvus/types/Common.d.ts +11 -267
  39. package/dist/milvus/types/Common.js +1 -369
  40. package/dist/milvus/types/Common.js.map +1 -1
  41. package/dist/milvus/types/Data.d.ts +154 -1
  42. package/dist/milvus/types/Index.d.ts +20 -1
  43. package/dist/milvus/types/Partition.d.ts +8 -1
  44. package/dist/milvus/types/Resource.d.ts +44 -0
  45. package/dist/milvus/types/{Search.js → Resource.js} +1 -1
  46. package/dist/milvus/types/Resource.js.map +1 -0
  47. package/dist/milvus/types/Response.d.ts +0 -246
  48. package/dist/milvus/types/Response.js.map +1 -1
  49. package/dist/milvus/types/User.d.ts +54 -2
  50. package/dist/milvus/types.d.ts +8 -7
  51. package/dist/milvus/types.js +2 -1
  52. package/dist/milvus/types.js.map +1 -1
  53. package/dist/proto/proto/common.proto +23 -2
  54. package/dist/proto/proto/feder.proto +40 -0
  55. package/dist/proto/proto/google/protobuf/descriptor.proto +31 -1
  56. package/dist/proto/proto/milvus.proto +101 -0
  57. package/dist/proto/proto/msg.proto +107 -0
  58. package/dist/proto/proto/schema.proto +18 -23
  59. package/dist/sdk.json +1 -1
  60. package/dist/utils/Blob.js.map +1 -0
  61. package/dist/{milvus/utils → utils}/Format.d.ts +12 -11
  62. package/dist/{milvus/utils → utils}/Format.js +18 -17
  63. package/dist/utils/Format.js.map +1 -0
  64. package/dist/utils/Function.d.ts +4 -0
  65. package/dist/utils/Function.js +33 -0
  66. package/dist/utils/Function.js.map +1 -0
  67. package/dist/utils/Grpc.d.ts +19 -0
  68. package/dist/utils/Grpc.js +64 -0
  69. package/dist/utils/Grpc.js.map +1 -0
  70. package/dist/utils/Validate.d.ts +21 -0
  71. package/dist/{milvus/utils → utils}/Validate.js +28 -6
  72. package/dist/utils/Validate.js.map +1 -0
  73. package/dist/utils/index.d.ts +5 -7
  74. package/dist/utils/index.js +17 -52
  75. package/dist/utils/index.js.map +1 -1
  76. package/dist/utils/test.d.ts +14 -0
  77. package/dist/utils/test.js +68 -0
  78. package/dist/utils/test.js.map +1 -0
  79. package/package.json +7 -12
  80. package/dist/milvus/Client.d.ts +0 -12
  81. package/dist/milvus/Client.js +0 -28
  82. package/dist/milvus/Client.js.map +0 -1
  83. package/dist/milvus/types/Search.d.ts +0 -81
  84. package/dist/milvus/types/Search.js.map +0 -1
  85. package/dist/milvus/utils/Blob.js.map +0 -1
  86. package/dist/milvus/utils/Format.js.map +0 -1
  87. package/dist/milvus/utils/Validate.d.ts +0 -9
  88. package/dist/milvus/utils/Validate.js.map +0 -1
  89. package/dist/milvus/utils/index.d.ts +0 -3
  90. package/dist/milvus/utils/index.js +0 -10
  91. package/dist/milvus/utils/index.js.map +0 -1
  92. /package/dist/{milvus/utils → utils}/Blob.d.ts +0 -0
  93. /package/dist/{milvus/utils → utils}/Blob.js +0 -0
@@ -29,7 +29,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
29
29
  function verb(n) { return function (v) { return step([n, v]); }; }
30
30
  function step(op) {
31
31
  if (f) throw new TypeError("Generator is already executing.");
32
- while (_) try {
32
+ while (g && (g = 0, op[0] && (_ = 0)), _) try {
33
33
  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;
34
34
  if (y = 0, t) op = [op[0] & 2, t.value];
35
35
  switch (op[0]) {
@@ -53,10 +53,8 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
53
53
  Object.defineProperty(exports, "__esModule", { value: true });
54
54
  exports.User = void 0;
55
55
  var utils_1 = require("../utils");
56
- var Client_1 = require("./Client");
57
- var ErrorReason_1 = require("./const/ErrorReason");
58
- var Common_1 = require("./types/Common");
59
- var Format_1 = require("./utils/Format");
56
+ var Resource_1 = require("./Resource");
57
+ var _1 = require(".");
60
58
  var User = /** @class */ (function (_super) {
61
59
  __extends(User, _super);
62
60
  function User() {
@@ -66,22 +64,22 @@ var User = /** @class */ (function (_super) {
66
64
  * Create user in milvus
67
65
  *
68
66
  * @param data
69
- * | Property | Type | Description |
70
- * | :-------------- | :---- | :---- |
67
+ * | Property | Type | Description |
68
+ * | :-- | :-- | :-- |
71
69
  * | username | String | username |
72
70
  * | password | String | user password |
71
+ * | 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 |
73
72
  *
74
- *
75
- * @return
73
+ * @returns
76
74
  * | Property | Description |
77
- * | :-------------| :-------- |
75
+ * | :-- | :-- |
78
76
  * | error_code | Error code number |
79
77
  * | reason | Error cause|
80
78
  *
81
79
  * #### Example
82
80
  *
83
81
  * ```
84
- * milvusClient.userManager.createUser({
82
+ * milvusClient.createUser({
85
83
  * username: NAME,
86
84
  * password: PASSWORD,
87
85
  * });
@@ -94,13 +92,13 @@ var User = /** @class */ (function (_super) {
94
92
  switch (_a.label) {
95
93
  case 0:
96
94
  if (data.username === undefined || data.password === undefined) {
97
- throw new Error(ErrorReason_1.ERROR_REASONS.USERNAME_PWD_ARE_REQUIRED);
95
+ throw new Error(_1.ERROR_REASONS.USERNAME_PWD_ARE_REQUIRED);
98
96
  }
99
- encryptedPassword = (0, Format_1.stringToBase64)(data.password);
100
- return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'CreateCredential', {
97
+ encryptedPassword = (0, utils_1.stringToBase64)(data.password);
98
+ return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'CreateCredential', {
101
99
  username: data.username,
102
100
  password: encryptedPassword,
103
- })];
101
+ }, data === null || data === void 0 ? void 0 : data.timeout)];
104
102
  case 1:
105
103
  promise = _a.sent();
106
104
  return [2 /*return*/, promise];
@@ -113,23 +111,24 @@ var User = /** @class */ (function (_super) {
113
111
  *
114
112
  * @param data
115
113
  * | Property | Type | Description |
116
- * | :-------------- | :---- | :------ |
114
+ * | :-- | :-- | :-- |
117
115
  * | username | String | username |
118
116
  * | password | String | user password |
117
+ * | 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 |
119
118
  *
120
- *
121
- * @return
119
+ * @returns
122
120
  * | Property | Description |
123
- * | :-------------| :-------- |
121
+ * | :-- | :-- |
124
122
  * | error_code | Error code number |
125
123
  * | reason | Error cause|
126
124
  *
127
125
  * #### Example
128
126
  *
129
127
  * ```
130
- * milvusClient.userManager.createUser({
128
+ * milvusClient.updateUser({
131
129
  * username: NAME,
132
- * password: PASSWORD,
130
+ * newPassword: PASSWORD,
131
+ * oldPassword: PASSWORD,
133
132
  * });
134
133
  * ```
135
134
  */
@@ -142,15 +141,15 @@ var User = /** @class */ (function (_super) {
142
141
  if (data.username === undefined ||
143
142
  data.newPassword === undefined ||
144
143
  data.oldPassword === undefined) {
145
- throw new Error(ErrorReason_1.ERROR_REASONS.USERNAME_PWD_ARE_REQUIRED);
144
+ throw new Error(_1.ERROR_REASONS.USERNAME_PWD_ARE_REQUIRED);
146
145
  }
147
- encryptedOldPwd = (0, Format_1.stringToBase64)(data.oldPassword);
148
- encryptedNewPwd = (0, Format_1.stringToBase64)(data.newPassword);
149
- return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'UpdateCredential', {
146
+ encryptedOldPwd = (0, utils_1.stringToBase64)(data.oldPassword);
147
+ encryptedNewPwd = (0, utils_1.stringToBase64)(data.newPassword);
148
+ return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'UpdateCredential', {
150
149
  username: data.username,
151
150
  oldPassword: encryptedOldPwd,
152
151
  newPassword: encryptedNewPwd,
153
- })];
152
+ }, data === null || data === void 0 ? void 0 : data.timeout)];
154
153
  case 1:
155
154
  promise = _a.sent();
156
155
  return [2 /*return*/, promise];
@@ -163,20 +162,20 @@ var User = /** @class */ (function (_super) {
163
162
  *
164
163
  * @param data
165
164
  * | Property | Type | Description |
166
- * | :-------------- | :---- | :-- |
165
+ * | :-- | :-- | :-- |
167
166
  * | username | String | username |
167
+ * | 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 |
168
168
  *
169
- *
170
- * @return
169
+ * @returns
171
170
  * | Property | Description |
172
- * | :-------------| :-------- |
171
+ * | :-- | :-- |
173
172
  * | error_code | Error code number |
174
173
  * | reason | Error cause|
175
174
  *
176
175
  * #### Example
177
176
  *
178
177
  * ```
179
- * milvusClient.userManager.deleteUser({
178
+ * milvusClient.deleteUser({
180
179
  * username: NAME,
181
180
  * });
182
181
  * ```
@@ -188,11 +187,11 @@ var User = /** @class */ (function (_super) {
188
187
  switch (_a.label) {
189
188
  case 0:
190
189
  if (!data.username) {
191
- throw new Error(ErrorReason_1.ERROR_REASONS.USERNAME_IS_REQUIRED);
190
+ throw new Error(_1.ERROR_REASONS.USERNAME_IS_REQUIRED);
192
191
  }
193
- return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'DeleteCredential', {
192
+ return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'DeleteCredential', {
194
193
  username: data.username,
195
- }, data.timeout)];
194
+ }, data === null || data === void 0 ? void 0 : data.timeout)];
196
195
  case 1:
197
196
  promise = _a.sent();
198
197
  return [2 /*return*/, promise];
@@ -203,16 +202,21 @@ var User = /** @class */ (function (_super) {
203
202
  /**
204
203
  * List user in milvus
205
204
  *
206
- * @return
205
+ * @param data
206
+ * | Property | Type | Description |
207
+ * | :-- | :-- | :-- |
208
+ * | 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 |
209
+ *
210
+ * @returns
207
211
  * | Property | Description |
208
- * | :-------------| :-------- |
209
- * | status | { error_code: number, reason: string }|
212
+ * | :-- | :-- |
213
+ * | status | { error_code: number, reason: string } |
210
214
  * | usernames | string[] |
211
215
  *
212
216
  * #### Example
213
217
  *
214
218
  * ```
215
- * milvusClient.userManager.listUsers();
219
+ * milvusClient.listUsers();
216
220
  * ```
217
221
  */
218
222
  User.prototype.listUsers = function (data) {
@@ -220,7 +224,7 @@ var User = /** @class */ (function (_super) {
220
224
  var promise;
221
225
  return __generator(this, function (_a) {
222
226
  switch (_a.label) {
223
- case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'ListCredUsers', {}, data === null || data === void 0 ? void 0 : data.timeout)];
227
+ case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'ListCredUsers', {}, data === null || data === void 0 ? void 0 : data.timeout)];
224
228
  case 1:
225
229
  promise = _a.sent();
226
230
  return [2 /*return*/, promise];
@@ -231,16 +235,22 @@ var User = /** @class */ (function (_super) {
231
235
  /**
232
236
  * Create user role
233
237
  *
234
- * @return
238
+ * @param data
239
+ * | Property | Type | Description |
240
+ * | :-- | :-- | :-- |
241
+ * | roleName | String | role name |
242
+ * | 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 |
243
+ *
244
+ * @returns
235
245
  * | Property | Description |
236
- * | :-------------| :-------- |
237
- * | status | { error_code: number, reason: string }|
246
+ * | :-- | :-- |
247
+ * | status | { error_code: number, reason: string } |
238
248
  * | reason | '' |
239
249
  *
240
250
  * #### Example
241
251
  *
242
252
  * ```
243
- * milvusClient.userManager.createRole({roleName: 'myrole'});
253
+ * milvusClient.createRole({roleName: 'myrole'});
244
254
  * ```
245
255
  */
246
256
  User.prototype.createRole = function (data) {
@@ -248,7 +258,7 @@ var User = /** @class */ (function (_super) {
248
258
  var promise;
249
259
  return __generator(this, function (_a) {
250
260
  switch (_a.label) {
251
- case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'CreateRole', {
261
+ case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'CreateRole', {
252
262
  entity: { name: data.roleName },
253
263
  }, data === null || data === void 0 ? void 0 : data.timeout)];
254
264
  case 1:
@@ -261,16 +271,22 @@ var User = /** @class */ (function (_super) {
261
271
  /**
262
272
  * Drop user role
263
273
  *
264
- * @return
274
+ * @param data
275
+ * | Property | Type | Description |
276
+ * | :-- | :-- | :-- |
277
+ * | roleName | String | User name |
278
+ * | 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 |
279
+ *
280
+ * @returns
265
281
  * | Property | Description |
266
- * | :-------------| :-------- |
267
- * | status | { error_code: number, reason: string }|
282
+ * | :-- | :-- |
283
+ * | status | { error_code: number, reason: string } |
268
284
  * | reason | '' |
269
285
  *
270
286
  * #### Example
271
287
  *
272
288
  * ```
273
- * milvusClient.userManager.dropRole({roleName: 'myrole'});
289
+ * milvusClient.dropRole({roleName: 'myrole'});
274
290
  * ```
275
291
  */
276
292
  User.prototype.dropRole = function (data) {
@@ -278,7 +294,7 @@ var User = /** @class */ (function (_super) {
278
294
  var promise;
279
295
  return __generator(this, function (_a) {
280
296
  switch (_a.label) {
281
- case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'DropRole', {
297
+ case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'DropRole', {
282
298
  role_name: data.roleName,
283
299
  }, data === null || data === void 0 ? void 0 : data.timeout)];
284
300
  case 1:
@@ -291,16 +307,23 @@ var User = /** @class */ (function (_super) {
291
307
  /**
292
308
  * add user to role
293
309
  *
294
- * @return
310
+ * @param data
311
+ * | Property | Type | Description |
312
+ * | :-- | :-- | :-- |
313
+ * | username | String | User name |
314
+ * | roleName | String | Role name |
315
+ * | 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 |
316
+ *
317
+ * @returns
295
318
  * | Property | Description |
296
- * | :-------------| :-------- |
297
- * | status | { error_code: number, reason: string }|
319
+ * | :-- | :-- |
320
+ * | status | { error_code: number, reason: string } |
298
321
  * | reason | '' |
299
322
  *
300
323
  * #### Example
301
324
  *
302
325
  * ```
303
- * milvusClient.userManager.addUserToRole({username: 'my', roleName: 'myrole'});
326
+ * milvusClient.addUserToRole({username: 'my', roleName: 'myrole'});
304
327
  * ```
305
328
  */
306
329
  User.prototype.addUserToRole = function (data) {
@@ -308,10 +331,10 @@ var User = /** @class */ (function (_super) {
308
331
  var promise;
309
332
  return __generator(this, function (_a) {
310
333
  switch (_a.label) {
311
- case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'OperateUserRole', {
334
+ case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'OperateUserRole', {
312
335
  username: data.username,
313
336
  role_name: data.roleName,
314
- type: Common_1.OperateUserRoleType.AddUserToRole,
337
+ type: _1.OperateUserRoleType.AddUserToRole,
315
338
  }, data === null || data === void 0 ? void 0 : data.timeout)];
316
339
  case 1:
317
340
  promise = _a.sent();
@@ -323,16 +346,23 @@ var User = /** @class */ (function (_super) {
323
346
  /**
324
347
  * remove user from role
325
348
  *
326
- * @return
349
+ * @param data
350
+ * | Property | Type | Description |
351
+ * | :-- | :-- | :-- |
352
+ * | username | String | User name |
353
+ * | roleName | String | Role name |
354
+ * | 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 |
355
+ *
356
+ * @returns
327
357
  * | Property | Description |
328
- * | :-------------| :-------- |
329
- * | status | { error_code: number, reason: string }|
358
+ * | :-- | :-- |
359
+ * | status | { error_code: number, reason: string } |
330
360
  * | reason | '' |
331
361
  *
332
362
  * #### Example
333
363
  *
334
364
  * ```
335
- * milvusClient.userManager.removeUserFromRole({username: 'my', roleName: 'myrole'});
365
+ * milvusClient.removeUserFromRole({username: 'my', roleName: 'myrole'});
336
366
  * ```
337
367
  */
338
368
  User.prototype.removeUserFromRole = function (data) {
@@ -340,10 +370,10 @@ var User = /** @class */ (function (_super) {
340
370
  var promise;
341
371
  return __generator(this, function (_a) {
342
372
  switch (_a.label) {
343
- case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'OperateUserRole', {
373
+ case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'OperateUserRole', {
344
374
  username: data.username,
345
375
  role_name: data.roleName,
346
- type: Common_1.OperateUserRoleType.RemoveUserFromRole,
376
+ type: _1.OperateUserRoleType.RemoveUserFromRole,
347
377
  }, data === null || data === void 0 ? void 0 : data.timeout)];
348
378
  case 1:
349
379
  promise = _a.sent();
@@ -357,21 +387,21 @@ var User = /** @class */ (function (_super) {
357
387
  *
358
388
  * @param data
359
389
  * | Property | Type | Description |
360
- * | :------- | :----- | :------------ |
361
- * | roleName | String | role name |
390
+ * | :-- | :-- | :-- |
391
+ * | roleName | String | Role name |
362
392
  * | includeUserInfo? | boolean | should result including user info, by default: true |
363
- * | 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 |
393
+ * | 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 |
364
394
 
365
- * @return
395
+ * @returns
366
396
  * | Property | Description |
367
- * | :-------------| :-------- |
368
- * | status | { error_code: number, reason: string }|
397
+ * | :-- | :-- |
398
+ * | status | { error_code: number, reason: string } |
369
399
  * | results | { users: {name: string}[]; role: {name: string} }[] |
370
400
  *
371
401
  * #### Example
372
402
  *
373
403
  * ```
374
- * milvusClient.userManager.selectRole({roleName: 'myrole'});
404
+ * milvusClient.selectRole({roleName: 'myrole'});
375
405
  * ```
376
406
  */
377
407
  User.prototype.selectRole = function (data) {
@@ -379,7 +409,7 @@ var User = /** @class */ (function (_super) {
379
409
  var promise;
380
410
  return __generator(this, function (_a) {
381
411
  switch (_a.label) {
382
- case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'SelectRole', {
412
+ case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'SelectRole', {
383
413
  role: { name: data.roleName },
384
414
  include_user_info: data.includeUserInfo || true,
385
415
  }, data === null || data === void 0 ? void 0 : data.timeout)];
@@ -395,19 +425,19 @@ var User = /** @class */ (function (_super) {
395
425
  *
396
426
  * @param data
397
427
  * | Property | Type | Description |
398
- * | :------- | :----- | :------------ |
399
- * | 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 |
428
+ * | :-- | :-- | :-- |
429
+ * | 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 |
400
430
  *
401
- * @return
431
+ * @returns
402
432
  * | Property | Description |
403
- * | :-------------| :-------- |
404
- * | status | { error_code: number, reason: string }|
433
+ * | :-- | :-- |
434
+ * | status | { error_code: number, reason: string } |
405
435
  * | reason | '' |
406
436
  *
407
437
  * #### Example
408
438
  *
409
439
  * ```
410
- * milvusClient.userManager.listRoles();
440
+ * milvusClient.listRoles();
411
441
  * ```
412
442
  */
413
443
  User.prototype.listRoles = function (data) {
@@ -415,7 +445,7 @@ var User = /** @class */ (function (_super) {
415
445
  var promise;
416
446
  return __generator(this, function (_a) {
417
447
  switch (_a.label) {
418
- case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'SelectRole', {}, data === null || data === void 0 ? void 0 : data.timeout)];
448
+ case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'SelectRole', {}, data === null || data === void 0 ? void 0 : data.timeout)];
419
449
  case 1:
420
450
  promise = _a.sent();
421
451
  return [2 /*return*/, promise];
@@ -428,21 +458,21 @@ var User = /** @class */ (function (_super) {
428
458
  *
429
459
  * @param data
430
460
  * | Property | Type | Description |
431
- * | :------- | :----- | :------------ |
432
- * | userName | String | user name |
461
+ * | :-- | :-- | :-- |
462
+ * | userName | String | User name |
433
463
  * | includeUserInfo? | boolean | should result including user info, by default: true |
434
- * | 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 |
464
+ * | 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 |
435
465
  *
436
- * @return
466
+ * @returns
437
467
  * | Property | Description |
438
- * | :-------------| :-------- |
439
- * | status | { error_code: number, reason: string }|
468
+ * | :-- | :-- |
469
+ * | status | { error_code: number, reason: string } |
440
470
  * | results | user: {name: string}; roles: {name: string}[] |
441
471
  *
442
472
  * #### Example
443
473
  *
444
474
  * ```
445
- * milvusClient.userManager.selectUser({username: 'name'});
475
+ * milvusClient.selectUser({username: 'name'});
446
476
  * ```
447
477
  */
448
478
  User.prototype.selectUser = function (data) {
@@ -450,7 +480,7 @@ var User = /** @class */ (function (_super) {
450
480
  var promise;
451
481
  return __generator(this, function (_a) {
452
482
  switch (_a.label) {
453
- case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'SelectUser', {
483
+ case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'SelectUser', {
454
484
  user: { name: data.username },
455
485
  include_role_info: data.includeRoleInfo || true,
456
486
  }, data === null || data === void 0 ? void 0 : data.timeout)];
@@ -466,23 +496,23 @@ var User = /** @class */ (function (_super) {
466
496
  *
467
497
  * @param data
468
498
  * | Property | Type | Description |
469
- * | :------- | :----- | :------------ |
470
- * | roleName | String | role name |
499
+ * | :-- | :-- | :-- |
500
+ * | roleName | String | Role name |
471
501
  * | object | string | Type of the operational object to which the specified privilege belongs, such as Collection, Index, Partition, etc. This parameter is case-sensitive.|
472
502
  * | objectName | string | Name of the object to which the role is granted the specified prvilege. |
473
503
  * | privilegeName | string | Name of the privilege to be granted to the role. This parameter is case-sensitive. |
474
- * | 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 |
504
+ * | 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 |
475
505
  *
476
- * @return
506
+ * @returns
477
507
  * | Property | Description |
478
- * | :-------------| :-------- |
479
- * | status | { error_code: number, reason: string }|
508
+ * | :-- | :-- |
509
+ * | status | { error_code: number, reason: string } |
480
510
  * | reason | '' |
481
511
  *
482
512
  * #### Example
483
513
  *
484
514
  * ```
485
- * milvusClient.userManager.grantRolePrivilege({
515
+ * milvusClient.grantRolePrivilege({
486
516
  * roleName: 'roleName',
487
517
  * object: '*',
488
518
  * objectName: 'Collection',
@@ -495,7 +525,7 @@ var User = /** @class */ (function (_super) {
495
525
  var promise;
496
526
  return __generator(this, function (_a) {
497
527
  switch (_a.label) {
498
- case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'OperatePrivilege', {
528
+ case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'OperatePrivilege', {
499
529
  entity: {
500
530
  role: { name: data.roleName },
501
531
  object: { name: data.object },
@@ -504,7 +534,7 @@ var User = /** @class */ (function (_super) {
504
534
  privilege: { name: data.privilegeName },
505
535
  },
506
536
  },
507
- type: Common_1.OperatePrivilegeType.Grant,
537
+ type: _1.OperatePrivilegeType.Grant,
508
538
  }, data === null || data === void 0 ? void 0 : data.timeout)];
509
539
  case 1:
510
540
  promise = _a.sent();
@@ -518,23 +548,23 @@ var User = /** @class */ (function (_super) {
518
548
  *
519
549
  * @param data
520
550
  * | Property | Type | Description |
521
- * | :------- | :----- | :------------ |
522
- * | roleName | String | role name |
551
+ * | :-- | :-- | :-- |
552
+ * | roleName | String | Role name |
523
553
  * | object | string | Type of the operational object to which the specified privilege belongs, such as Collection, Index, Partition, etc. This parameter is case-sensitive.|
524
554
  * | objectName | string | Name of the object to which the role is granted the specified prvilege. |
525
555
  * | privilegeName | string | Name of the privilege to be granted to the role. This parameter is case-sensitive. |
526
- * | 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 |
556
+ * | 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 |
527
557
  *
528
- * @return
558
+ * @returns
529
559
  * | Property | Description |
530
560
  * | :------------- | :-------- |
531
- * | status | { error_code: number, reason: string }|
561
+ * | status | { error_code: number, reason: string } |
532
562
  * | reason | '' |
533
563
  *
534
564
  * #### Example
535
565
  *
536
566
  * ```
537
- * milvusClient.userManager.grantRolePrivilege({
567
+ * milvusClient.grantRolePrivilege({
538
568
  * roleName: 'roleName',
539
569
  * object: '*',
540
570
  * objectName: 'Collection',
@@ -547,7 +577,7 @@ var User = /** @class */ (function (_super) {
547
577
  var promise;
548
578
  return __generator(this, function (_a) {
549
579
  switch (_a.label) {
550
- case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'OperatePrivilege', {
580
+ case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'OperatePrivilege', {
551
581
  entity: {
552
582
  role: { name: data.roleName },
553
583
  object: { name: data.object },
@@ -556,7 +586,7 @@ var User = /** @class */ (function (_super) {
556
586
  privilege: { name: data.privilegeName },
557
587
  },
558
588
  },
559
- type: Common_1.OperatePrivilegeType.Revoke,
589
+ type: _1.OperatePrivilegeType.Revoke,
560
590
  }, data === null || data === void 0 ? void 0 : data.timeout)];
561
591
  case 1:
562
592
  promise = _a.sent();
@@ -569,26 +599,22 @@ var User = /** @class */ (function (_super) {
569
599
  * revoke all roles priviledges
570
600
  * @param data
571
601
  * | Property | Type | Description |
572
- * | :------- | :----- | :------------ |
573
- * | roleName | String | role name |
574
- * | object | string | Type of the operational object to which the specified privilege belongs, such as Collection, Index, Partition, etc. This parameter is case-sensitive.|
575
- * | objectName | string | Name of the object to which the role is granted the specified prvilege. |
576
- * | privilegeName | string | Name of the privilege to be granted to the role. This parameter is case-sensitive. |
577
- * | 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 |
602
+ * | :-- | :-- | :-- |
603
+ * | 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 |
578
604
  *
579
- * @return
605
+ * @returns
580
606
  * | Property | Description |
581
- * | :-------------| :-------- |
582
- * | status | { error_code: number, reason: string }|
583
- * | reason | '' |
607
+ * | :-- | :-- |
608
+ * | status | { error_code: number, reason: string } |
609
+ * | reason | '' |
584
610
  *
585
611
  * #### Example
586
612
  *
587
613
  * ```
588
- * milvusClient.userManager.revokeAllRolesPrivileges({});
614
+ * milvusClient.revokeAllRolesPrivileges();
589
615
  * ```
590
616
  */
591
- User.prototype.revokeAllRolesPrivileges = function (data) {
617
+ User.prototype.dropAllRoles = function (data) {
592
618
  return __awaiter(this, void 0, void 0, function () {
593
619
  var res, promises, i, r, grants, j, entity, _a, _b;
594
620
  return __generator(this, function (_c) {
@@ -612,6 +638,7 @@ var User = /** @class */ (function (_super) {
612
638
  case 4:
613
639
  if (!(j < grants.entities.length)) return [3 /*break*/, 7];
614
640
  entity = grants.entities[j];
641
+ // revoke grant
615
642
  return [4 /*yield*/, this.revokeRolePrivilege({
616
643
  roleName: entity.role.name,
617
644
  object: entity.object.name,
@@ -620,6 +647,7 @@ var User = /** @class */ (function (_super) {
620
647
  timeout: data === null || data === void 0 ? void 0 : data.timeout,
621
648
  })];
622
649
  case 5:
650
+ // revoke grant
623
651
  _c.sent();
624
652
  _c.label = 6;
625
653
  case 6:
@@ -627,12 +655,15 @@ var User = /** @class */ (function (_super) {
627
655
  return [3 /*break*/, 4];
628
656
  case 7:
629
657
  _b = (_a = promises).push;
658
+ // drop the role
630
659
  return [4 /*yield*/, this.dropRole({
631
660
  roleName: r.role.name,
632
661
  timeout: data === null || data === void 0 ? void 0 : data.timeout,
633
662
  })];
634
663
  case 8:
635
- _b.apply(_a, [_c.sent()]);
664
+ _b.apply(_a, [
665
+ // drop the role
666
+ _c.sent()]);
636
667
  _c.label = 9;
637
668
  case 9:
638
669
  i++;
@@ -646,23 +677,23 @@ var User = /** @class */ (function (_super) {
646
677
  * select a grant
647
678
  * @param data
648
679
  * | Property | Type | Description |
649
- * | :------- | :----- | :------------ |
650
- * | roleName | String | role name |
680
+ * | :-- | :-- | :-- |
681
+ * | roleName | String | Role name |
651
682
  * | object | string | Type of the operational object to which the specified privilege belongs, such as Collection, Index, Partition, etc. This parameter is case-sensitive.|
652
683
  * | objectName | string | Name of the object to which the role is granted the specified prvilege. |
653
684
  * | privilegeName | string | Name of the privilege to be granted to the role. This parameter is case-sensitive. |
654
- * | 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 |
685
+ * | 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 |
655
686
  *
656
- * @return
657
- * | Property | Description |
658
- * | :-------------| :-------- |
659
- * | status | { error_code: number, reason: string }|
660
- * | reason | '' |
687
+ * @returns
688
+ * | Property | Description |
689
+ * | :-- | :-- |
690
+ * | status | { error_code: number, reason: string } |
691
+ * | reason | '' |
661
692
  *
662
693
  * #### Example
663
694
  *
664
695
  * ```
665
- * milvusClient.userManager.selectGrant({
696
+ * milvusClient.selectGrant({
666
697
  * roleName: 'roleName',
667
698
  * object: '*',
668
699
  * objectName: 'Collection',
@@ -675,7 +706,7 @@ var User = /** @class */ (function (_super) {
675
706
  var promise;
676
707
  return __generator(this, function (_a) {
677
708
  switch (_a.label) {
678
- case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'SelectGrant', {
709
+ case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'SelectGrant', {
679
710
  entity: {
680
711
  role: { name: data.roleName },
681
712
  object: { name: data.object },
@@ -696,20 +727,20 @@ var User = /** @class */ (function (_super) {
696
727
  * list all grants for a role
697
728
  * @param data
698
729
  * | Property | Type | Description |
699
- * | :------- | :----- | :------------ |
700
- * | roleName | String | role name |
701
- * | 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 |
730
+ * | :-- | :-- | :-- |
731
+ * | roleName | String | Role name |
732
+ * | 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 |
702
733
  *
703
- * @return
734
+ * @returns
704
735
  * | Property | Description |
705
- * | :-------------| :-------- |
706
- * | status | { error_code: number, reason: string }|
736
+ * | :-- | :-- |
737
+ * | status | { error_code: number, reason: string } |
707
738
  * | reason | '' |
708
739
  *
709
740
  * #### Example
710
741
  *
711
742
  * ```
712
- * milvusClient.userManager.listGrants({
743
+ * milvusClient.listGrants({
713
744
  * roleName: 'roleName',
714
745
  * });
715
746
  * ```
@@ -719,7 +750,7 @@ var User = /** @class */ (function (_super) {
719
750
  var promise;
720
751
  return __generator(this, function (_a) {
721
752
  switch (_a.label) {
722
- case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.client, 'SelectGrant', {
753
+ case 0: return [4 /*yield*/, (0, utils_1.promisify)(this.grpcClient, 'SelectGrant', {
723
754
  entity: {
724
755
  role: { name: data.roleName },
725
756
  },
@@ -735,20 +766,20 @@ var User = /** @class */ (function (_super) {
735
766
  * check if the role is existing
736
767
  * @param data
737
768
  * | Property | Type | Description |
738
- * | :------- | :----- | :------------ |
739
- * | roleName | String | role name |
740
- * | 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 |
769
+ * | :-- | :-- | :-- |
770
+ * | roleName | String | Role name |
771
+ * | 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 |
741
772
  *
742
- * @return
773
+ * @returns
743
774
  * | Property | Description |
744
- * | :-------------| :-------- |
745
- * | status | { error_code: number, reason: string }|
775
+ * | :-- | :-- |
776
+ * | status | { error_code: number, reason: string } |
746
777
  * | reason | '' |
747
778
  *
748
779
  * #### Example
749
780
  *
750
781
  * ```
751
- * milvusClient.userManager.hasRole({
782
+ * milvusClient.hasRole({
752
783
  * roleName: 'roleName',
753
784
  * });
754
785
  * ```
@@ -770,6 +801,6 @@ var User = /** @class */ (function (_super) {
770
801
  });
771
802
  };
772
803
  return User;
773
- }(Client_1.Client));
804
+ }(Resource_1.Resource));
774
805
  exports.User = User;
775
806
  //# sourceMappingURL=User.js.map