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

listIndexes()

この操作は、特定の collection の index を一覧表示します

javascript
await milvusClient.listIndexes(data)

Request Syntax

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

PARAMETERS:

  • db_name (string) -

    対象の collection を保持するデータベースの名前。

  • collection_name (string) -

    [REQUIRED]

    既存の collection の名前。

  • field_name (string) -

    collection 内の既存フィールドの名前。

  • index_name (string) -

    説明対象の index の名前。

  • timeout (number)

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

RETURNS Promise<ListIndexResponse>

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

typescript
{
indexes: string[],
status: ResStatus
}

PARAMETERS:

  • indexes (string[]) -
    要求された collection に定義されている index 名の一覧。

  • ResStatus
    ResStatus オブジェクト。

    • code (number) -

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

    • error_code (string | number) -

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

    • reason (string) -

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

Ctrl I