接口定义
delete() 接口用于删除指定 id(Document ID)的文档,且支持设置 Filter 表达式,删除满足 Filter 表达式的数据。
public AffectRes delete(String database, String collection, DeleteParam param)
使用示例
说明:
索引类型为 FLAT,在1.6及之后版本,支持删除操作,而1.6之前版本,则不支持删除操作。
// deleteDeleteParam deleteParam = DeleteParam.newBuilder().withDocumentIds(Arrays.asList("0001", "0003")).withFilter("bookName=\\"三国演义\\"").withLimit(1).build();AffectRes deleteAffectRes = client.delete("db-test", "book-vector", deleteParam);System.out.println(deleteAffectRes.toString());
入参描述
参数名 | 子参数 | 是否必选 | 参数含义 | 配置方法 |
database | - | 是 | 指定删除数据的数据库名。 | Database 命名要求如下: 只能使用英文字母,数字,下划线_、中划线-,并以英文字母开头。 长度要求:[1,128]。 |
collection | - | 是 | 指定删除数据的集合名。 | Collection 命名要求如下: 只能使用英文字母,数字,下划线_、中划线-,并以英文字母开头。 长度要求:[1,128]。 |
deleteParam | DocumentIds | 否 | 表示要删除的 Document 的 ID。 | ID 长度限制为[1,128]。 批量删除,数据元素最大值为20。 |
| Filter | 否 | 设置 Filter 表达式。 | 使用创建 CollectionView 指定的 Filter 索引的字段设置查询过滤表达式。Filter 表达式格式为 <field_name><operator><value>,多个表达式之间支持 and(与)、or(或)、not(非)关系。具体信息,请参见 Filter 条件表达式。其中: <field_name>:表示要过滤的字段名。 <operator>:表示要使用的运算符。 string :匹配单个字符串值(=)、排除单个字符串值(!=)、匹配任意一个字符串值(in)、排除所有字符串值(not in)。其对应的 Value 必须使用英文双引号括起来。 uint64:大于(>)、大于等于(>=)、等于(=)、小于(<)、小于等于(<=)、不等于(!=)。例如:expired_time > 1623388524。 array:数组类型,包含数组元素之一(include)、排除数组元素之一(exclude)、全包含数组元素(include all)。例如,name include (\\"Bob\\", \\"Jack\\")。 json:json 类型的 Filter 表达式语法和 json 字段的键值类型保持一致。若访问 Json 对象中的键,使用点(.)符号连接。例如:Json 类型的字段 bookInfo ,其键 bookName 的 Filter 表达式如下所示。更多信息,请参见 Json 类型表达式。
<value>:表示要匹配的值。 示例: new Filter("author=\\"jerry\\"").and("page>20") |
| limit | 否 | 控制删除文档的数量。 | 若不设置该参数,最大删除16384条数据。 数据类型:整型。 取值范围:[1,16384] |
出参描述
res: AffectRes{affectedCount=1, code=0, msg='operation success'}
参数名 | 参数含义 |
affectedCount | 删除的文档数量。如果该参数返回的值为0,说明删除无效。 |