向量数据库 truncate-SDK 参考-文档中心-腾讯云

功能介绍
/collection/truncate 接口用于清空 Collection 中所有的数据与索引，仅保留 Collection 配置信息，例如索引类型及参数、分片等设置，减少用户的操作成本。
接口约束
警告：
执行 truncate 操作将会永久删除指定 Collection 下的所有数据。在操作之前，务必谨慎考虑。
请求示例
注意：
如下示例可直接复制，在 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/collection/truncate \\
 -d '{
    "database": "db-test",
    "collection": "book-vector"
}'
请求参数
参数名
是否必选
参数含义
配置方法

database
是
指定 Collection 所在的 Database 名称。
使用 /database/list 获取集群中的数据库列表，复制需删除数据的集合所属的数据库名。
collection
是
所需清空数据的 Collection 名称。
使用/collection/list 获取指定数据库名下的 Collection 列表，复制需清空数据的集合。
响应消息
状态码
HTTP 响应消息体是服务器返回给客户端的数据，通常包含了请求的结果或者所请求的资源。/collection/truncate接口返回的状态码以及相关信息，如下表所示。
状态码
含义
响应消息
200
删除集合执行成功
{
  "code": 0,
  "msg": "operation success",
  "affectedCount": 1
}

400
删除集合执行失败
{
  "code": 1,
  "msg": "operation failed, reason....",
  "affectedCount": 0
}
返回参数
参数名
参数含义
affectedCount
清空的集合数量

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

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

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

truncate

本页目录：

功能介绍

接口约束

请求示例

请求参数

响应消息

状态码

返回参数