删除 Document 数据

最近更新时间:2024-10-21 11:24:02

我的收藏

接口定义

delete()接口用于删除指定 id(Document ID)的文档,且支持设置 Filter 表达式,删除满足 Filter 表达式的数据。
Update(ctx context.Context, databaseName string, collectionName string, param UpdateDocumentParams) (result *UpdateDocumentResult, err error)

接口约束

索引类型为 FLAT,不支持删除。

使用示例

如下示例,删除 id 为 0001、0003,并满足 bookName 条件表达式的数据。
var (
ctx = context.Background()
database = "go-sdk-test-db"
collectionName = "go-sdk-test-coll"
)
result, err := client.Delete(ctx, database, collectionName, tcvectordb.DeleteDocumentParams{
DocumentIds: []string{"0001", "0003"},
Filter: tcvectordb.NewFilter(`bookName="西游记"`),
})
log.Printf("delete affect count: %d", result.AffectedCount)

入参描述

DeleteDocumentParams 该参数的含义如下表。
参数名
是否必选
参数含义
配置方法
databaseName
指定删除的数据库名。
Database 命名要求如下:
只能使用英文字母,数字,下划线_、中划线-,并以英文字母开头。
长度要求:[1,128]。
collectionName
指定删除数据的集合。
Collection 命名要求如下:
只能使用英文字母,数字,下划线_、中划线-,并以英文字母开头。
长度要求:[1,128]。
DocumentIds
表示要删除的 Document 的 ID。
ID 长度限制为[1,128]。
批量删除,数据元素最大值为20。
Filter
设置 Filter 表达式。
使用创建 Collection 指定的 Filter 索引的字段设置查询过滤表达式。Filter 表达式格式为 <field_name><operator><value>,多个表达式之间支持 and(与)、or(或)、not(非)关系。具体信息,请参见 混合检索。其中:
<field_name>:表示要过滤的字段名。
<operator>:表示要使用的运算符。
string :匹配单个字符串值(=)、排除单个字符串值(!=)、匹配任意一个字符串值(in)、排除所有字符串值(not in)。其对应的 Value 必须使用英文双引号括起来。
uint64:大于(>)、大于等于(>=)、等于(=)、小于(<)、小于等于(<=)。例如:expired_time > 1623388524。
array:数组类型,包含数组元素之一(include)、排除数组元素之一(exclude)、全包含数组元素(include all)。例如,name include (\\"Bob\\", \\"Jack\\")。
<value>:表示要匹配的值。
示例:Filter('author="jerry"').And('page>20')。

出参描述

delete affect count: &{AffectedCount:1}
参数名
参数含义
AffectedCount
影响行数,即为删除的文档数量。