清空 Collection 数据

最近更新时间:2024-09-30 16:34:52

我的收藏

接口定义

TruncateCollection() 用于清空 Collection 中所有的数据与索引,仅保留 Collection 配置信息,例如索引类型及参数、分片等设置,减少用户的操作成本。
TruncateCollection(ctx context.Context, name string) (result *tcvectordb.TruncateCollectionResult, err error)

使用示例

警告:
执行 truncate 操作将会永久删除指定 Collection 下的所有数据。在操作之前,务必谨慎考虑。
如下示例,清空集合 go-sdk-test-coll 的数据。
var (
ctx = context.Background()
database = "go-sdk-test-db"
collectionName = "go-sdk-test-coll"
)

db := client.Database(database)
result, _ := db.TruncateCollection(ctx, collectionName)
log.Printf("truncate collection result: %+v", result)

入参描述

参数
是否必选
参数含义
配置方法及要求
collectionName
指定需清空数据的 Collection 名。
使用 ListCollection() 获取指定数据库名下的 Collection 列表,复制需清空数据的集合名。

出参描述

truncate collection result: &{AffectedCount:1}
参数名
参数含义
affectedCount
影响行数,即为清空数据的集合数量。