メインコンテンツまでスキップ

getCompactionState()

この操作は、特定の collection で収集された統計情報を一覧表示します。

javascript
await milvusClient.getCompactionState(data)

Request Syntax​

javascript
await milvusClient.getCompactionState({ 
    compactionID: string | number,
    timeout?: number 
})

パラメータ:

  • compactionID (string | number) -

    [必須]

    compact() の呼び出しによって返される compaction ジョブの ID。

  • timeout (number) -

    この操作のタイムアウト時間。

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

戻り値 Promise<GetCompactionStateResponse>

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

typescript
{
    state: CompactionState,
    executingPlanNo: string,
    timeoutPlanNo: string,
    completedPlanNo: string,
    failedPlanNo: string,
    status:  ResStatus
}

パラメータ:

  • state (CompactionState) -
    compaction の集約状態。指定可能な値は UndefiedState、Executing、Completed です。

  • executingPlanNo (string) -
    まだ実行中のプラン数。

  • timeoutPlanNo (string) -
    タイムアウトしたプラン数。

  • completedPlanNo (string) -
    正常に完了したプラン数。

  • failedPlanNo (string) -
    失敗したプラン数。

  • ResStatus
    ResStatus オブジェクト。

    • code (number) -

      操作結果を示すコード。この操作が成功した場合は 0 のままです。

    • error_code (string | number) -

      発生したエラーを示すエラーコード。この操作が成功した場合は Success のままです。

    • reason (string) -

      報告されたエラーの理由を示す理由。この操作が成功した場合は空文字列のままです。

Example​

javascript
const milvusClient = new MilvusClient({
    address: 'YOUR_CLUSTER_ENDPOINT',
    token: 'YOUR_CLUSTER_TOKEN',
});
const resStatus = await milvusClient.getCompactionState({
    compactionID: 'your_compaction_id',
});
Ctrl I