@zilliz/milvus2-sdk-node 2.2.2 → 2.2.4

package/dist/milvus/Client.d.ts

@@ -1,12 +1,4 @@
 export declare class Client {
     client: any;
     constructor(client: any);
-    /**
-     * @ignore
-     */
-    checkCollectionName(data: any): void;
-    /**
-     * @ignore
-     */
-    checkCollectionAndPartitionName(data: any): void;
 }

package/dist/milvus/Client.js

@@ -1,27 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Client = void 0;
-var ErrorReason_1 = require("./const/ErrorReason");
 var Client = /** @class */ (function () {
     function Client(client) {
         this.client = client;
     }
-    /**
-     * @ignore
-     */
-    Client.prototype.checkCollectionName = function (data) {
-        if (!data || !data.collection_name) {
-            throw new Error(ErrorReason_1.ERROR_REASONS.COLLECTION_NAME_IS_REQUIRED);
-        }
-    };
-    /**
-     * @ignore
-     */
-    Client.prototype.checkCollectionAndPartitionName = function (data) {
-        if (!data || !data.collection_name || !data.partition_name) {
-            throw new Error(ErrorReason_1.ERROR_REASONS.COLLECTION_PARTITION_NAME_ARE_REQUIRED);
-        }
-    };
     return Client;
 }());
 exports.Client = Client;

package/dist/milvus/Client.js.map

@@ -1 +1 @@
-{"version":3,"file":"Client.js","sourceRoot":"","sources":["../../milvus/Client.ts"],"names":[],"mappings":";;;AAAA,mDAAoD;AAEpD;IAGE,gBAAY,MAAW;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,oCAAmB,GAAnB,UAAoB,IAAS;QAC3B,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;YAClC,MAAM,IAAI,KAAK,CAAC,2BAAa,CAAC,2BAA2B,CAAC,CAAC;SAC5D;IACH,CAAC;IACD;;OAEG;IACH,gDAA+B,GAA/B,UAAgC,IAAS;QACvC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,eAAe,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;YAC1D,MAAM,IAAI,KAAK,CAAC,2BAAa,CAAC,sCAAsC,CAAC,CAAC;SACvE;IACH,CAAC;IACH,aAAC;AAAD,CAAC,AAvBD,IAuBC;AAvBY,wBAAM"}
+{"version":3,"file":"Client.js","sourceRoot":"","sources":["../../milvus/Client.ts"],"names":[],"mappings":";;;AAAA;IAGE,gBAAY,MAAW;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IACH,aAAC;AAAD,CAAC,AAND,IAMC;AANY,wBAAM"}

package/dist/milvus/Collection.d.ts

@@ -1,8 +1,7 @@
-import { CreateCollectionReq, DescribeCollectionReq, DropCollectionReq, GetCollectionStatisticsReq, LoadCollectionReq, ReleaseLoadCollectionReq, ShowCollectionsReq, HasCollectionReq, CreateAliasReq, DropAliasReq, AlterAliasReq, CompactReq, GetCompactionStateReq, GetCompactionPlansReq, GetReplicaReq } from './types/Collection';
-import { BoolResponse, CompactionResponse, DescribeCollectionResponse, GetCompactionPlansResponse, GetCompactionStateResponse, ResStatus, ShowCollectionsResponse, StatisticsResponse, ReplicasResponse } from './types/Response';
 import { Client } from './Client';
+import { CreateCollectionReq, DescribeCollectionReq, DropCollectionReq, GetCollectionStatisticsReq, LoadCollectionReq, ReleaseLoadCollectionReq, ShowCollectionsReq, HasCollectionReq, CreateAliasReq, DropAliasReq, AlterAliasReq, CompactReq, GetCompactionStateReq, GetCompactionPlansReq, GetReplicaReq, RenameCollectionReq, BoolResponse, ResStatus, CompactionResponse, DescribeCollectionResponse, GetCompactionPlansResponse, GetCompactionStateResponse, ShowCollectionsResponse, StatisticsResponse, ReplicasResponse } from './types';
 /**
- * See all [collection operation examples](https://github.com/milvus-io/milvus-sdk-node/blob/main/example/Collection.ts).
+ * @see [collection operation examples](https://github.com/milvus-io/milvus-sdk-node/blob/main/example/Collection.ts)
  */
 export declare class Collection extends Client {
     private readonly _protoRoot;
@@ -11,17 +10,17 @@ export declare class Collection extends Client {
      * Create a collection in Milvus.
      *
      * @param data
-     *  | Property                | Type   |           Description              |
-     *  | :---------------------- | :----  | :-------------------------------  |
-     *  | collection_name        | String |        Collection name       |
-     *  | description             | String |        Collection description       |
-     *  | consistency_level       | String |        "Strong"(Milvus default) | "Session" | "Bounded"| "Eventually" | "Customized";      |
-     *  | fields        | <a href="https://github.com/milvus-io/milvus-sdk-node/blob/main/milvus/types/Collection.ts#L8" target="_blank">FieldType</a> |     Field data      |
-     *  | 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       |
-     *
-     * @return
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | collection_name | String | Collection name |
+     *  | description | String | Collection description |
+     *  | consistency_level | String | "Strong"(Milvus default) | "Session" | "Bounded"| "Eventually" | "Customized"; |
+     *  | fields | <a href="https://github.com/milvus-io/milvus-sdk-node/blob/main/milvus/types/Collection.ts#L8" target="_blank">FieldType</a> | Field data |
+     *  | 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      | Description |
-     *  | :-------------| :--------  |
+     *  | :-- | :-- |
      *  | error_code    | Error code number      |
      *  | reason        | Error cause          |
      *
@@ -55,16 +54,16 @@ export declare class Collection extends Client {
      * Check if a collection exists.
      *
      * @param data
-     *  | Property              | Type   |           Description              |
-     *  | :---------------------- | :----  | :-------------------------------  |
-     *  | collection_name        | String |       Collection 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       |
-     *
-     * @return
-     *  | Property    |           Description              |
-     *  | :-------------| :-------------------------------  |
-     *  | status        |  { error_code: number, reason: string }|
-     *  | value         |        `true` or `false`                 |
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | collection_name | String | Collection 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 | Description |
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
+     *  | value | `true` or `false` |
     
      *
      * #### Example
@@ -80,17 +79,18 @@ export declare class Collection extends Client {
      * List all collections or get collection loading status.
      *
      * @param data
-     *  | Property           | Type   |           Description              |
-     *  | :----------------- | :----  | :-------------------------------  |
-     *  | type(optional)        | enum |       All -> 0, Loaded -> 1       |
-     *  | collection_names(optional)        | String[] |       If `type = Loaded`, Milvus will return `collection_names inMemory_percentages`     |
-     *  | 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       |
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | type(optional) | enum | All -> 0, Loaded -> 1 |
+     *  | collection_names(optional) | String[] | If `type = Loaded`, Milvus will return `collection_names inMemory_percentages` |
+     *  | 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 |
+  
      *
-     * @return
-     *  | Property    |           Description              |
-     *  | :-------------| :-------------------------------  |
-     *  | status        |  { error_code: number, reason: string } |
-     *  | data         |  Contains collection name, ID , timestamp (UTC created time), and loadedPercentage (100 means loaded)      |
+     * @returns
+     * | Property | Description |
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
+     *  | data |  Contains collection name, ID , timestamp (UTC created time), and loadedPercentage (100 means loaded) |
      *
      *
      * #### Example
@@ -104,17 +104,17 @@ export declare class Collection extends Client {
      * Show the details of a collection, e.g. name, schema.
      *
      * @param data
-     *  | Property           | Type   |           Description              |
-     *  | :----------------- | :----  | :-------------------------------  |
-     *  | collection_name    | String |        Collection 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       |
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | collection_name | String | Collection 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       |
      *
-     * @return
-     *  | Property    |           Description              |
-     *  | :-------------| :-------------------------------  |
-     *  | status        |  { error_code: number, reason: string }|
-     *  | schema        |        Information of all fields in this collection                |
-     *  | collectionID  |        Collection ID                |
+     * @returns
+     * | Property | Description |
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
+     *  | schema | Information of all fields in this collection |
+     *  | collectionID  | Collection ID |
      *
      *
      * #### Example
@@ -130,17 +130,17 @@ export declare class Collection extends Client {
      * Show the statistics information of a collection.
      *
      * @param data
-     *  | Property           | Type   |           Description              |
-     *  | :----------------- | :----  | :-------------------------------  |
-     *  | collection_name    | String |       Collection 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       |
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | collection_name | String | Collection 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       |
      *
-     * @return
-     *  | Property    |           Description              |
-     *  | :-------------| :-------------------------------  |
-     *  | status        |  { error_code: number, reason: string }|
-     *  | stats        |        [{key: string, value: string}]                |
-     *  | data  |        Transform **stats** to { row_count: 0 }               |
+     * @returns
+     * | Property | Description |
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
+     *  | stats | [{key: string, value: string}] |
+     *  | data | Transform **stats** to { row_count: 0 } |
      *
      *
      * #### Example
@@ -157,17 +157,18 @@ export declare class Collection extends Client {
      * It's async function, but we can use showCollections to check loading status.
      *
      * @param data
-     *  | Property           | Type   |           Description              |
-     *  | :----------------- | :----  | :-------------------------------  |
-     *  | collection_name    | String |       Collection name       |
-     *  | replica_number?    | number |       Collection 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       |
-     *
-     * @return
-     *  | Property      | Description |
-     *  | :-------------| :--------  |
-     *  | error_code    | Error code number      |
-     *  | reason        | Error cause|   *
+     *  | Property | Type | Description |
+     *  | :--- | :-- | :-- |
+     *  | collection_name    | String | Collection name |
+     *  | replica_number? | number | replica number |
+     *  | resource_groups? | String[] | resource group names |
+     *  | 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 | Description |
+     *  | :-- | :-- |
+     *  | error_code | Error code number |
+     *  | reason | Error cause |
      *
      * #### Example
      *
@@ -183,16 +184,18 @@ export declare class Collection extends Client {
      * Help to ensure this collection is loaded.
      *
      * @param data
-     *  | Property           | Type   |           Description              |
-     *  | :----------------- | :----  | :-------------------------------  |
-     *  | collection_name    | String |       Collection 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       |
-     *
-     * @return
-     *  | Property      | Description |
-     *  | :-------------| :--------  |
-     *  | error_code    | Error code number      |
-     *  | reason        | Error cause|   *
+     *  | Property | Type  | Description |
+     *  | :--- | :-- | :-- |
+     *  | collection_name | String | Collection name |
+     *  | replica_number？ | number | replica number |
+     *  | resource_groups？ | String[] | resource group |
+     *  | 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 | Description |
+     *  | :-- | :-- |
+     *  | error_code | Error code number |
+     *  | reason | Error cause |
      *
      * #### Example
      *
@@ -208,16 +211,16 @@ export declare class Collection extends Client {
      * Note that you cannot search while the corresponding collection is unloaded.
      *
      * @param data
-     *  | Property           | Type   |           Description              |
-     *  | :----------------- | :----  | :-------------------------------  |
-     *  | collection_name    | String |       Collection 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       |
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | collection_name | String | Collection 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       |
      *
-     * @return
-     *  | Property      | Description |
-     *  | :-------------| :--------  |
-     *  | error_code    | Error code number      |
-     *  | reason        | Error cause |   *
+     * @returns
+     *  | Property | Description |
+     *  | :-- | :-- |
+     *  | error_code | Error code number |
+     *  | reason | Error cause |
      *
      * #### Example
      *
@@ -228,20 +231,46 @@ export declare class Collection extends Client {
      * ```
      */
     releaseCollection(data: ReleaseLoadCollectionReq): Promise<ResStatus>;
+    /**
+     * Rename a collection
+     *
+     * @param data
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | collection_name | String | old collection name |
+     *  | new_collection_name | String | new collection 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 | Description |
+     *  | :-- | :-- |
+     *  | error_code | Error code number |
+     *  | reason | Error cause |
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).collectionManager.renameCollection({
+     *    collection_name: 'my_collection',
+     *    new_collection_name: 'my_new_collection'
+     *  });
+     * ```
+     */
+    renameCollection(data: RenameCollectionReq): Promise<ResStatus>;
     /**
      * Drop a collection. Note that this drops all data in the collection.
      *
      * @param data
-     *  | Property           | Type   |           Description              |
-     *  | :----------------- | :----  | :-------------------------------  |
-     *  | collection_name        | String |       Collection 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       |
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | collection_name | String | Collection 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. |
      *
-     * @return
-     *  | Property      | Description |
-     *  | :-------------| :--------  |
-     *  | error_code    | Error code number      |
-     *  | reason        | Error cause|   *
+     * @returns
+     *  | Property | Description |
+     *  | :-- | :-- |
+     *  | error_code | Error code number |
+     *  | reason | Error cause |
      *
      * #### Example
      *
@@ -253,35 +282,100 @@ export declare class Collection extends Client {
      */
     dropCollection(data: DropCollectionReq): Promise<ResStatus>;
     /**
-     * @ignore
      * Create collection alias, then you can use alias instead of collection_name when you do vector search
+     *
      * @param data
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | alias | String | alias name |
+     *  | collection_name | String | Collection 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 | Description |
+     *  | :-- | :-- |
+     *  | error_code | Error code number |
+     *  | reason | Error cause |
+     *
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).collectionManager.createAlias({
+     *    alias: 'my_collection_alis',
+     *    collection_name: 'my_collection',
+     *  });
+     * ```
      */
     createAlias(data: CreateAliasReq): Promise<ResStatus>;
     /**
-     * @ignore
+     * Drop a collection alias
+     *
      * @param data
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | alias | String | alias name |
+     *  | collection_name | String | Collection 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 | Description |
+     *  | :-- | :-- |
+     *  | error_code | Error code number |
+     *  | reason | Error cause |
+     *
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).collectionManager.dropAlias({
+     *    alias: 'my_collection_alis',
+     *    collection_name: 'my_collection',
+     *  });
+     * ```
      */
     dropAlias(data: DropAliasReq): Promise<ResStatus>;
     /**
-     * @ignore
+     * alter a collection alias
+     *
      * @param data
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | alias | String | alias name |
+     *  | collection_name | String | Collection 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 | Description |
+     *  | :-- | :-- |
+     *  | error_code | Error code number |
+     *  | reason | Error cause |
+     *
+     *
+     * #### Example
+     *
+     * ```
+     *  new milvusClient(MILUVS_ADDRESS).collectionManager.alterAlais({
+     *    alias: 'my_collection_alis',
+     *    collection_name: 'my_collection',
+     *  });
+     * ```
      */
     alterAlias(data: AlterAliasReq): Promise<ResStatus>;
     /**
      * Do compaction for the collection.
      *
      * @param data
-     *  | Property           | Type   |           Description              |
-     *  | :----------------- | :----  | :-------------------------------  |
-     *  | collection_name    | String |       The collection name to compact       |
-     *  | 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       |
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | collection_name | String | The collection name to compact |
+     *  | 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 |
      *
-     * @return
-     *  | Property      | Description |
-     *  | :-------------| :--------  |
-     *  | status        |  { error_code: number, reason: string }|
-     *  | compactionID  | compaction ID |
+     * @returns
+     *  | Property | Description |
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
+     *  | compactionID | compaction ID |
      *
      * #### Example
      *
@@ -296,16 +390,16 @@ export declare class Collection extends Client {
      * Get compaction states of a targeted compaction id
      *
      * @param data
-     *  | Property           | Type   |           Description              |
-     *  | :----------------- | :----  | :-------------------------------  |
-     *  | compactionID       | number or string |       the id returned by compact       |
-     *  | 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       |
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | compactionID | number or string | the id returned by compact |
+     *  | 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       |
      *
-     * @return
-     *  | Property      | Description |
-     *  | :-------------| :--------  |
-     *  | status        |  { error_code: number, reason: string }|
-     *  | state         | the state of the compaction |
+     * @returns
+     *  | Property | Description |
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
+     *  | state | the state of the compaction |
      *
      * #### Example
      *
@@ -320,16 +414,16 @@ export declare class Collection extends Client {
      * Get compaction states of a targeted compaction id
      *
      * @param data
-     *  | Property           | Type   |           Description              |
-     *  | :----------------- | :----  | :-------------------------------  |
-     *  | compactionID       | number or string |       the id returned by compact       |
-     *  | 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       |
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | compactionID | number or string | the id returned by compact |
+     *  | 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 |
      *
-     * @return
-     *  | Property      | Description |
-     *  | :-------------| :--------  |
-     *  | status        |  { error_code: number, reason: string }|
-     *  | state         | the state of the compaction |
+     * @returns
+     *  | Property | Description |
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
+     *  | state | the state of the compaction |
      *
      * #### Example
      *
@@ -344,15 +438,15 @@ export declare class Collection extends Client {
      * Get replicas
      *
      * @param data
-     *  | Property           | Type   |           Description              |
-     *  | :----------------- | :----  | :-------------------------------  |
-     *  | collectionID       | number or string |       the id returned by compact       |
-     *  | 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       |
-     *
-     * @return
-     *  | Property      | Description |
-     *  | :-------------| :--------  |
-     *  | status        |  { error_code: number, reason: string }|
+     *  | Property | Type | Description |
+     *  | :-- | :-- | :-- |
+     *  | collectionID | number or string | the id returned by compact |
+     *  | 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 | Description |
+     *  | :-- | :-- |
+     *  | status | { error_code: number, reason: string } |
      *  | ReplicaInfo[] | replica info array |
      *
      * #### Example