批量删除数据 | potato cloud开放文档

# 批量删除数据

# 简要描述

按条件批量删除数据库数据（独立接口 /api/deleteList）
where 写法与查询多条数据库数据一致（条件数组 + reg）
where 必填，且至少一个有效条件；禁止空条件全表删除
limit 可选，默认 / 上限 500
返回实际删除行数
需会员，且表需开放写权限
与删除数据（/api/deleteOne）不同：deleteOne 的 where 为等值对象

# 请求URL

/api/deleteList/{tableName}

# 请求头

参数名	必选	类型	说明
Content-Type	是	string	此参数必传，当请求数据非json时此参数传对应格式如（multipartform-data，application/x-www-form-urlencoded，等）是json请传application/json
askKey	是	string	此参数必传,验证app的令牌
sign	否	string	此参数如果在app设置开启了验签是必传
time	否	string	当开启验签时，此参数为必传
apiUserToken	否	string	用户令牌
nonce	否	string	随机字符串(当开启V3验签此参数必传，且6分钟内不允许重复)

# 请求方式

post

# 路由参数

参数名	必选	类型	说明
{tableName}	是	string	表名称

# 参数

参数名	必选	类型	说明
where	是	array	条件对象数组，至少一个有效条件
limit	否	int	删除上限，默认 500，最大 500；`<=0` 或非法格式会失败

# where 单项

参数名	必选	类型	说明
reg	否	string	算子，缺省 `eq`
column	是	string	字段名
value	是	string/array	比较值；`in` / `nin` 可用数组

reg 支持：eq / lt / le / lte / gt / gte / ne / in / nin / like_contains / like_prefix / like_suffix。未知算子会报错，不会静默变成全表删除。

# 请求示例

{
  "where": [
    {
      "reg": "eq",
      "column": "status",
      "value": "0"
    },
    {
      "reg": "lt",
      "column": "id",
      "value": "100"
    }
  ],
  "limit": 100
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# 返回示例

{
  "code": "200",
  "message": "",
  "status": true,
  "data": 3,
  "pc": null,
  "time": null,
  "sign": null
}

1
2
3
4
5
6
7
8
9

# 返回参数说明

参数名	类型	说明
code	string	状态码200成功,403权限异常或登录超时,500请求异常
status	int	状态0删除1使用
data	number	实际删除行数
nonce	string	随机字符串(当开启V3验签必返回次参数，且6分钟内不会重复)
sign	string	此参数如果在app设置开启了验签是必返
reqSign	string	请求签名
time	long	当开启验签时，此参数为必返回

# 备注

云函数对应方法：potato.deleteList，见云函数批量删除数据
更多返回错误代码请查看错误代码参考

← 删除数据云函数总览 →