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

listCollections()

この操作は、既存のすべての collection を一覧表示します。

javascript
milvusClient.listCollections();

Request Syntax​

javascript
listCollections({
    collection_name: string
    type: ShowCollectionsType,
    timeout?: number
})

PARAMETERS:

  • collection_name (string) -

    [REQUIRED]

    既存の collection の名前。

  • type (ShowCollectionsType)

    この操作のスコープです。指定可能な値は All または Loaded です。

  • timeout (number) -

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

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

RETURNS Promise<ShowCollectionsResponse>

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

typescript
{
    data: CollectionData[],
    created_timestamps: string[],
    created_utc_timestamps: string[],
    status:  ResStatus
}

PARAMETERS:

  • data (CollectionData[]) -
    collection データオブジェクトの一覧です。各エントリには、collection 名、ID、タイムスタンプ、およびロード率が含まれます。

  • created_timestamps (string[]) -
    各 collection が作成された時刻を示すハイブリッドタイムスタンプの一覧です。

  • created_utc_timestamps (string[]) -
    各 collection が作成された時刻を示す UTC タイムスタンプの一覧です。

  • ResStatus
    ResStatus オブジェクトです。

    • code (number) -

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

    • error_code (string | number) -

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

    • reason (string) -

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

Example​

java
const milvusClient = new MilvusClient({
    address: 'YOUR_CLUSTER_ENDPOINT',
    token: 'YOUR_CLUSTER_TOKEN',
});
const res = await milvusClient.listCollections({ collection_name: 'my_collection' });
Ctrl I