功能介绍
delete() 接口用于删除指定 id（Document ID）的文档。
def delete(self,database_name: str,collection_name: str,document_ids: List[str] = None,filter: Union[Filter, str] = None,timeout: Optional[float] = None)
使用实例
说明：
索引类型为 FLAT，不支持删除。
import tcvectordbfrom tcvectordb.model.document import Document, Filter# delete# 删除指定 id（Document ID），并满足 Filter 表达式的文档。res = client.delete(database_name='db-test',collection_name='book-vector',document_ids=['0001', '0002', '0003'],filter='bookName in ("三国演义","西游记")'),print(res, flush=True)
入参描述
参数名 | 是否必选 | 参数含义 | 配置方法 |
database_name | 是 | 指定删除的数据库名。 | Database 命名要求如下： 只能使用英文字母，数字，下划线_、中划线-，并以英文字母开头。 长度要求：[1,128]。 |
collection_name | 是 | 指定删除的集合名 | Collection 命名要求如下： 只能使用英文字母，数字，下划线_、中划线-，并以英文字母开头。 长度要求：[1,128]。 |
document_ids | 否 | 表示要删除的 Document 的 ID。 | ID 长度限制为[1,128]。 批量删除，数据元素最大值为20。 |
filter | 否 | 使用创建 Collection 指定的 Filter 索引的字段设置查询过滤表达式 | Filter 的表达式格式为 '<field_name><operator><value>'，多个表达式之间支持 and（与）、or（或）、not（非）关系。具体信息，请参见 Filter 条件表达式。其中 <field_name>：表示要过滤的字段名。 <operator>：表示要使用的运算符。 string ：匹配单个字符串值（=）、匹配任意一个字符串值（in）、排除所有字符串值（not in）。其对应的 Value 必须使用英文双引号括起来。 unit64：大于（>）、大于等于（>=）、等于（=）、小于（<）、小于等于（<=）。例如：expired_time > 1623388524。 array：数组类型，包含数组元素之一（include）、排除数组元素之一（exclude）、全包含数组元素（include all）。例如，name include (\\"Bob\\", \\"Jack\\")。 <value>：表示要匹配的值。 示例： Filter('author="jerry"').And('page>20')。 |
timeout | 否 | 请求超时时间。 | 单位：秒。 默认值：VectorDBClient() 接口配置的 timeout 时长。 取值范围：大于等于0。 |
出参描述
{'code': 0,'msg': 'Operation success','affectedCount': 2}
参数名 | 参数含义 |
affectedCount | 影响行数，即为删除数据的条数。 |
