Method 与 URL
删除指定 id(Document ID)的文档:
POST https://{实例访问 IP 地址}:{实例网络端口}/document/delete
。说明:
索引类型为 FLAT,在1.6及之后版本,支持删除操作,而1.6之前版本,则不支持删除操作。
使用示例
如下示例,删除 book-emb 集合中, id(Document ID)为0001、0002、0003,且满足
bookName in (\\"三国演义\\",\\"西游记\\")
的数据。curl -i -X POST \\-H 'Content-Type: application/json' \\-H 'Authorization: Bearer account=root&api_key=A5VOgsMpGWJhUI0WmUbY********************' \\http://10.0.X.X:80/document/delete \\-d '{"database": "db-test","collection": "book-emb","query": {"documentIds": ["0001","0002","0003"],"filter": "bookName in (\\"三国演义\\",\\"西游记\\")""limit": 2}}'
请求参数
参数名称 | 参数含义 | 子参数 | 是否必选 | 配置方法及要求 |
database | 指定需删除文档的Database 名称。 | - | 是 | |
collection | 指定需删除文档的Collection 名称。 | - | 是 | |
query | 设置查询条件,满足查询条件的文档将被删除。 | documentIds | 否 | 指定需删除的 Document 的 ID,数据元素最大值为20。 说明: 至少配置 documentIds 或 filter 参数中的一个,同时配置 documentIds 与 filter 参数,删除数据将会取二者交集。 |
| | filter | 否 | 使用创建 Collection 指定的 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>:表示要匹配的值。 示例: Filter('author="jerry"').And('page>20')。 |
| | limit | 否 | 控制删除文档的数量。若不设置该参数,最大删除16384条数据。 数据类型:整型。 取值范围:[1,16384] |
响应消息
{"code": 0,"msg": "operation success","affectedCount": 2}
参数名 | 参数含义 |
affectedCount | 删除文档数量。 |