批量删除文档

POST 
/collections/:collectionName/documents/remove

根据查询条件批量删除文档。使用 POST 方法是因为需要在请求体中传递复杂的查询条件。 query 不能为空对象（防止误删所有数据）。非管理员会自动注入 _openid 条件。

Request

Path Parameters

collectionName stringrequired

集合名称

application/json

Body

required

query objectrequired

查询条件（EJSON 对象，不能为空）

multi boolean

是否批量删除

transactionId string

事务 ID

Responses

200

删除成功

application/json

Schema

Schema

deleted integer

删除的文档数量

Example (from schema)

{
  "deleted": 0
}

Example

{
  "deleted": 1
}

400

请求参数错误

application/json

Schema

Schema

code string

错误码

message string

错误信息

request_id string

请求唯一 ID

Example (from schema)

{
  "code": "INVALID_PARAM",
  "message": "param.query can't be empty",
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Loading...