向量数据库
用户之声——提建议·赢好礼> HOT
文档中心 > 向量数据库 > SDK 参考 > HTTP API > CollectionView > truncate

truncate

最近更新时间：2024-05-20 17:21:21

我的收藏

本页目录：

功能介绍

/ai/collectionView/truncate 接口用于清空 CollectionView 中所有的数据与索引，仅保留 CollectionView 配置信息，例如索引类型及参数等设置，减少用户的操作成本。

接口约束

警告：
执行 truncate 操作将会永久删除指定 CollectionView 下的所有数据。在操作之前，务必谨慎考虑。

请求示例

注意：
如下示例可直接复制，在 CVM 运行之前，您需在文本编辑器将 api_key=A5VOgsMpGWJhUI0WmUbY******************** 与 10.0.X.X 依据实际情况进行替换。 
curl -i -X POST \\
  -H 'Content-Type: application/json' \\
  -H 'Authorization: Bearer account=root&api_key=A5VOgsMpGWJhUI0WmUbY********************' \\
  http://10.0.X.X:80/ai/collectionView/truncate \\
 -d '{
    "database": "db-test-ai",
    "collectionView": "coll-ai-files"
}'

请求参数

参数名
是否必选
参数含义
配置方法
database
是
指定 CollectionView 所在的 Database 名称。
使用 /database/list 获取集群中的数据库列表，复制需删除数据的集合所属的数据库名。
collectionView
是
所需清空数据的 CollectionView 名称。
使用/ai/collectionView/list 获取指定数据库名下的 CollectionView 列表，复制需清空集合视图。

响应消息

状态码

状态码
含义
响应消息
200
删除集合执行成功
{
  "code": 0,
  "msg": "operation success",
  "affectedCount": 1
}
400
删除集合执行失败
{
  "code": 1,
  "msg": "operation failed, reason....",
  "affectedCount": 0
}

返回参数

参数名
参数含义
affectedCount
清空的集合数量
中国站