refreshExternalCollection()

此操作会触发外部 Collection 的数据刷新。当外部数据源已更新且您希望 Milvus 重新加载数据时，请使用此操作。

typescript

await milvusClient.refreshExternalCollection(data: RefreshExternalCollectionReq)

请求语法

typescript

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

参数：

• collection_name (string) -
  [必需]
  要刷新的外部 Collection 名称。

• external_source (string) -
  可选的新外部数据源路径。如果提供，Collection 将从该新数据源刷新。

• external_spec (string) -
  可选的新 external spec 配置。如果提供，Collection 将使用此新 spec。

• db_name (string) -
  Database 的名称。可选。

• timeout (number) -
  允许 RPC 执行的可选时长，单位为毫秒。如果将其设置为 undefined，客户端会持续等待，直到服务器响应或发生错误。默认值为 undefined。

• client_request_id (string) -
  用于请求跟踪的追踪 ID。可选。

返回值 Promise<RefreshExternalCollectionResponse>

此方法返回一个 promise，解析为 RefreshExternalCollectionResponse 对象。

typescript

{
    job_id: string,
    status:  ResStatus
}

参数：

• job_id (string) -
  异步刷新任务的标识符。将此值传递给 getRefreshExternalCollectionProgress() 以轮询完成状态。

• ResStatus
  一个 ResStatus 对象。

  • code (number) -

    表示操作结果的代码。如果此操作成功，其值为 0。

  • error_code (string | number) -

    表示已发生错误的错误代码。如果此操作成功，其值为 Success。

  • reason (string) -

    表示所报告错误原因的说明。如果此操作成功，则为空字符串。

示例

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',
});