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

refreshExternalCollection()

この操作は external collection のデータ更新をトリガーします。外部データソースが更新され、Milvus にデータを再読み込みさせたい場合に使用します。

typescript
await milvusClient.refreshExternalCollection(data: RefreshExternalCollectionReq)

Request Syntax​

typescript
await milvusClient.refreshExternalCollection({
    collection_name: string,
    external_source?: string,
    external_spec?: string,
    db_name?: string,
    timeout?: number,
    client_request_id?: string,
})

PARAMETERS:

  • collection_name (string) -
    [REQUIRED]
    更新する external collection の名前。

  • external_source (string) -
    オプションの新しい外部ソースパス。指定した場合、collection はこの新しいソースから更新されます。

  • external_spec (string) -
    オプションの新しい external spec 設定。指定した場合、collection はこの新しい spec を使用します。

  • db_name (string) -
    データベースの名前。オプションです。

  • timeout (number) -
    RPC に許可する任意の時間（ミリ秒）。undefined に設定した場合、client はサーバーが応答するかエラーが発生するまで待機し続けます。デフォルトは undefined です。

  • client_request_id (string) -
    リクエスト追跡用のトレース ID。オプションです。

RETURNS Promise<RefreshExternalCollectionResponse>

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

typescript
{
    job_id: string,
    status:  ResStatus
}

PARAMETERS:

  • job_id (string) -
    非同期更新ジョブの識別子。この値を getRefreshExternalCollectionProgress() に渡して、完了までポーリングします。

  • ResStatus
    ResStatus オブジェクト。

    • code (number) -

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

    • error_code (string | number) -

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

    • reason (string) -

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

Example​

javascript
import { MilvusClient } from '@zilliz/milvus2-sdk-node';

const client = new MilvusClient({
    address: 'YOUR_CLUSTER_ENDPOINT',
    token: 'YOUR_CLUSTER_TOKEN',
});

const res = await client.refreshExternalCollection({
    collection_name: 'my_external_collection',
    external_source: 's3://bucket/path',
});
Ctrl I