数据操作

操作某张工作表中数据,支持写入、更新、行删除与条件删除。

特别注意

  • 数据操作结果是写入缓存,不会直接在BDP中生效,即在平台中不会看到数据变化,需要调用工作表的提交与更新,分别将数据写入工作表及其相关的合表。
  • 数据操作同样不支持并发,如不能并发向一张工作表写入数据,请顺序执行;

插入数据

向目标工作表的缓存文件中写入待插入的新增数据。

  • 插入内容须为新增数据,更新数据请使用data_update接口;
  • 写入数据须与对应字段一致,包括字段类型和数量;
  • 数据的结构代表与工作表字段的对应关系,可以使用字段名或字段ID,字段ID可通过字段查看获得;
  • 出于性能考虑,建议一次insert多条数据(body部分data参数为数组)。至于具体多少条合适,请视数据本身单条字节数来决定,原则上单次总字节数上限不能允许超过100M;
https://open.bdp.cn/api/data/insert

请求方式:POST

请求参数说明:

QueryString:

参数名称 参数类型 是否必填 默认值 参数描述 最大长度
access_token string 必填 开发者中心获取token,用来作为用户的身份认证 未限制
tb_id string 必填 工作表唯一标识 未限制
fields Array 必填 字段名列表,没有传入的字段将被置空;特别注意:传参方式为QueryString且参数类型为Array的参数需要先转换为json字符串再拼接到url 未限制

Body说明: 限制:100M

数据类型 是否必填 默认值 参数描述 最大长度
Array[Array] 必填 数据结构为二维数组 未限制

请求示例:

curl --request POST  --url 'https://open.bdp.cn/api/data/insert?access_token=19de5e0297bfd55097733dfbc87ad79e&tb_id=tb_cc8bea1e64fb4794976eafd1d6546512&
fields=%5B%22id%22%2C%22name%22%2C%22date%22%5D' --data '[["1", "marry", "2016-01-12 12:00:22"]]'

错误代码说明:

状态码 说明
6 缺少fields name或fields id
6 工作表结构不全
11 "body"中数据JSON格式不正确
402 内部错误

请求成功时返回说明:

{
    "status": 0,
    "errstr": "",
    "result": "success"
}

更新数据

向目标工作表的缓存文件中写入被更新的数据。

  • 写入数据须与对应字段一致,包括字段类型和数量;
  • 更新数据须提供全部字段,缺少字段会默认置为空,更新根据主键替换旧数据;
  • 数据的结构代表与工作表字段的对应关系,可以使用字段名或字段ID,字段ID可通过字段查看获得;

请求URL:

https://open.bdp.cn/api/data/update

请求方式:POST

请求参数说明:

QueryString:

参数名称 参数类型 是否必填 默认值 参数描述 最大长度
access_token string 必填 开发者中心获取token,用来作为用户的身份认证 未限制
tb_id string 必填 工作表唯一标识 未限制
fields Array 必填 字段名列表,没有传入的字段将被置空;特别注意:传参方式为QueryString且参数类型为Array的参数需要先转换为json字符串再拼接到url 未限制

Body说明: 限制:100M

数据类型 是否必填 默认值 参数描述 最大长度
Array[Array] 必填 数据结构为二维数组 未限制

请求示例:

curl --request POST --url 'https://open.bdp.cn/api/data/update?access_token=19de5e0297bfd55097733dfbc87ad79e&
tb_id=tb_cc8bea1e64fb4794976eafd1d6546512&fields=%5B%22id%22%2C%22name%22%2C%22date%22%5D' --data '[["1", "marry", "2016-01-12 12:00:22"]]'

请求成功时返回说明:

{
    "status": 0,
    "errstr": "",
    "result": "success"
}

错误代码说明:

状态码 说明
6 缺少fields name或fields id
6 工作表结构不全
11 "body"中数据JSON格式不正确
402 内部错误

直接删除

根据主键向目标工作表的缓存文件中写入待删除的数据,支持批量删除。该接口性能高于条件删除,根据主键值删除数据时建议使用该接口。

  • 工作表中有主键时根据主键字段删除数据,如无主键将匹配整行数据,整行一致的数据将被删除;
  • 工作表中有主键时可以仅提供主键字段的字段结构与对应值,如果表中主键提供不全删除操作不生效将被忽略。
  • 写入数据须与对应字段一致,包括字段类型和数量;
  • 数据的结构代表与工作表字段的对应关系,可以使用字段名或字段ID,字段ID可通过字段查看获得;
https://open.bdp.cn/api/data/delete

请求方式:POST

请求参数说明:

QueryString:

参数名称 参数类型 是否必填 默认值 参数描述 最大长度
access_token string 必填 开发者中心获取token,用来作为用户的身份认证 未限制
tb_id string 必填 工作表唯一标识 未限制
fields Array 必填 字段名列表,没有传入的字段将被置空;特别注意:传参方式为QueryString且参数类型为Array的参数需要先转换为json字符串再拼接到url 未限制

Body说明: 限制:100M

数据类型 是否必填 默认值 参数描述 最大长度
Array[Array] 必填 数据结构为二维数组 未限制

请求示例:

curl --request POST --url 'https://open.bdp.cn/api/data/delete?access_token=19de5e0297bfd55097733dfbc87ad79e&t
b_id=tb_cc8bea1e64fb4794976eafd1d6546512&fields=%5B%22id%22%2C%22name%22%2C%22date%22%5D' --data '[["1", "marry", "2016-01-12 12:00:22"]]'

请求成功时返回说明:

{
    "status": 0,
    "errstr": "",
    "result": "success"
}

错误代码说明:

状态码 说明
6 缺少fields name或fields id
6 工作表结构不全
11 "body"中数据JSON格式不正确
402 内部错误

条件删除

根据条件删除工作表中数据。删除操作将匹配所有符合条件的数据后进行删除,性能不如直接删除,如是根据主键值删除时建议采用直接删除。支持SQL;

请求URL:

https://open.bdp.cn/api/data/bulkdelete

请求方式:POST

请求参数说明:

QueryString:

参数名称 参数类型 是否必填 默认值 参数描述 最大长度
access_token string 必填 开发者中心获取token,用来作为用户的身份认证 未限制
tb_id string 必填 工作表唯一标识 未限制
where string 必填 删除数据的where条件 未限制

注意: 字段名需要加反撇号"`",值需要加单引号"'", 示例: where=`id`>'5'

请求示例:

curl --request GET   --url 'https://open.bdp.cn/api/data/bulkdelete?access_token=19de5e0297bfd55097733dfbc87ad79e&tb_id=tb_cc8bea1e64fb4794976eafd1d6546512&where=%60id%60%3D'\''1'\'''

请求成功时返回说明:

{
    "status": 0,
    "errstr": "",
    "result": "success"
}

错误代码说明:

状态码 说明
4 无操作权限
6 过滤条件“where”中字段不存在
6 过滤条件“where”中语法错误
6 不能删除分享表
409 删除数据过程中异常

results matching ""

    No results matching ""