getIndexBuildProgress()

この操作は、指定された index のビルド進捗を取得します。

javascript
await milvusClient.getIndexBuildProgress(data)

Request Syntax

javascript
await milvusClient.getIndexBuildProgress({
      db_name?: string,
      collection_name: string,
      field_name: string,
      index_name: string,
      timeout?: number
});

PARAMETERS:

db_name (string) -

ターゲット collection を保持するデータベースの名前。
collection_name (string) -

[REQUIRED]

既存の collection の名前。
index_name (string) -

[REQUIRED]

ターゲット index の名前。このパラメータと field_name は相互排他的です。
field_name (string) -

[REQUIRED]

ターゲット field の名前。このパラメータと index_name は相互排他的です。このパラメータを使用する場合は、指定した field に対して index が構築されていることを確認してください。
timeout (number) -

この操作のタイムアウト時間です。これを None に設定すると、レスポンスが返るか何らかのエラーが発生した時点で、この操作はタイムアウトします。

RETURNS Promise<GetIndexBuildProgressResponse>

このメソッドは、GetIndexBuildProgressResponse オブジェクトに解決される promise を返します。

typescript
{
    indexed_rows: number,
    total_rows: number,
    status:  ResStatus
}

PARAMETERS:

indexed_rows (number) -
これまでに index 化された行数。
total_rows (number) -
index が対象とする総行数。indexed_rows が total_rows と等しくなると、ビルドは完了です。
ResStatus
ResStatus オブジェクト。
- code (number) -
  
  操作結果を示すコードです。この操作が成功した場合は 0 のままです。
- error_code (string | number) -
  
  発生したエラーを示すエラーコードです。この操作が成功した場合は Success のままです。
- reason (string) -
  
  報告されたエラーの理由を示します。この操作が成功した場合は空文字列のままです。

Example

java
const milvusClient = new MilvusClient(MILUVS_ADDRESS);
const getIndexBuildProgressReq = {
  collection_name: 'my_collection',
  index_name: 'my_index',
};
const res = await milvusClient.getIndexBuildProgress(getIndexBuildProgressReq);
console.log(res);

Request Syntax​

Example​

Request Syntax

Example