truncateCollection()

此操作会移除 Collection 中的所有数据，但保留 Collection 的 Schema 和结构。

javascript

await milvusClient.truncateCollection(data: TruncateCollectionRequest)

📘Notes

• 不可逆操作

  截断 Collection 会永久删除所有数据。

• 保留 Schema

  Collection 的结构、字段、索引和属性都会保持不变。

请求语法

javascript

truncateCollection({
    db_name?: string,
    collection_name: string,
    timeout?: number
})

参数：

• db_name (string) -

  包含该 Collection 的 Database 名称。

• collection_name (string) -

  [必需]

  目标 Collection 的名称。

• timeout (number) -

  以毫秒为单位的 RPC 超时时间。

返回值：

Promise<ResStatus>

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

javascript

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

参数：

• code (number) -

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

• error_code (string | number) -

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

• reason (string) -

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

示例

基本用法

javascript

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

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

// Truncate collection
const res = await milvusClient.truncateCollection({
  collection_name: 'my_collection',
});

console.log(res);
// Output: { error_code: 'Success', reason: '' }

指定 Database 时

javascript

const res = await milvusClient.truncateCollection({
  db_name: 'my_database',
  collection_name: 'my_collection',
});