loadCollectionSync()

此操作会将特定 Collection 的数据加载到内存中。这是一个同步函数，用于帮助确保指定的 Collection 已被加载。

javascript

loadCollectionSync: ((data) => Promise<ResStatus>) = ...

请求语法

javascript

await milvusClient.loadCollectionSync({ 
    db_name: string,
    collection_name: string,
    refresh?: boolean,
    replica_number?: number,
    resource_groups?: string[],
    timeout?: number
})

参数：

• db_name (string) -

  持有目标 Collection 的 Database 名称。

• collection_name (string) -

  [必需]

  Collection 名称。

• refresh (boolean) -

  是否刷新已加载 Collection 的加载状态。

• replica_number (number) -

  要加载的 Collection 的副本数量。

• resource_groups (string[]) -

  要加载的 Collection 中资源组的数量。

• timeout (number) -

  此操作的超时时长。

  将此项设置为 None 表示当返回任意响应或发生错误时，此操作将超时。

返回 Promise<ResStatus>

此方法返回一个 promise，该 promise 会解析为 ResStatus 对象。

javascript

{
    code: number,
    error_code: string | number,
    reason: string
}

参数：

• code (number) -

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

• error_code (string | number) -

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

• reason (string) -

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

示例

java

const milvusClient = new MilvusClient({
    address: 'YOUR_CLUSTER_ENDPOINT',
    token: 'YOUR_CLUSTER_TOKEN',
});
const resStatus = await milvusClient.loadCollectionSync({ collection_name: 'my_collection' });