# 数据库记录管理

接口应在服务器端调用，详细说明参见服务端API。

# 接口说明

# 接口英文名

dbrecordManage

# 功能描述

该接口可用于对数据库记录进行管理，包含插入记录、删除记录、更新记录、查询记录等功能。

# 调用方式

# HTTPS 调用


POST https://api.weixin.qq.com/componenttcb/dbrecord?access_token=ACCESS_TOKEN

# 数据库插入记录

# 请求参数

属性	类型	必填	说明
access_token	string	是	第三方接口调用令牌component_access_token
action	string	是	填insert
env	string	是	云环境ID
query	string	是	数据库操作语句

# 返回值

返回的 JSON 数据包

属性	类型	说明
errcode	number	错误码
errmsg	string	错误信息
id_list	Array.<string>	插入成功的数据集合主键_id。

# 数据库删除记录

# 请求参数

属性	类型	必填	说明
access_token	string	是	第三方接口调用令牌component_access_token
action	string	是	填delete
env	string	是	云环境ID
query	string	是	数据库操作语句

# 返回值

返回的 JSON 数据包

属性	类型	说明
errcode	number	错误码
errmsg	string	错误信息
deleted	number	删除记录数量

# 数据库更新记录

# 请求参数

属性	类型	必填	说明
access_token	string	是	第三方接口调用令牌component_access_token
action	string	是	填update
env	string	是	云环境ID
query	string	是	数据库操作语句

# 返回值

返回的 JSON 数据包

属性	类型	说明
errcode	number	错误码
errmsg	string	错误信息
matched	number	更新条件匹配到的结果数
modified	number	修改的记录数，注意：使用set操作新插入的数据不计入修改数目
id	string	新插入记录的id，注意：只有使用set操作新插入数据时这个字段会有值

# 数据库查询记录

# 请求参数

属性	类型	必填	说明
access_token	string	是	第三方接口调用令牌component_access_token
action	string	是	填query
env	string	是	云环境ID
query	string	是	数据库操作语句

# 返回值

返回的 JSON 数据包

属性	类型	说明
errcode	number	错误码
errmsg	string	错误信息
pager	Object	分页信息
data	Array.<string>	记录数组

# 调用示例

示例说明: 数据库插入记录

# 请求数据示例


{
    "env":"test2-4a89da",
    "query": "db.collection(\"geo\").add({
      data: [{
        description: \"item1\",
        due: new Date(\"2019-09-09\"),
        tags: [
          \"cloud\",
          \"database\"
        ],
        location: new db.Geo.Point(113, 23),
        done: false
      },
      {
        description: \"item2\",
        due: new Date(\"2019-09-09\"),
        tags: [
          \"cloud\",
          \"database\"
        ],
        location: new db.Geo.Point(113, 23),
        done: false
      }
      ]
    })"
}

# 返回数据示例


{
    "errcode": 0,
    "errmsg": "ok",
    "id_list": [
        "be62d9c4-43ec-4dc6-8ca1-30b206eeed24",
        "0f4b8add5cdd728a003bf5c83ed99dff"
    ]
}

示例说明: 删除集合

# 请求数据示例


{
  "env":"test2-4a89da",
  "query": "db.collection(\"geo\").where({done:false}).remove()"
}

# 返回数据示例


{
    "errcode": 0,
    "errmsg": "ok",
    "deleted": 2
}

示例说明: 删除记录

# 请求数据示例


{
  "env":"test2-4a89da",
  "query": "db.collection(\"geo\").doc(\"be62d9c4-43ec-4dc6-8ca1-30b206eeed24\").remove()"
}

# 返回数据示例


{
    "errcode": 0,
    "errmsg": "ok",
    "deleted": 1
}

示例说明: 更新集合

# 请求数据示例


{
  "env":"test2-4a89da",
  "query": "db.collection(\"geo\").where({age:14}).update({data:{age: _.inc(1)}})"
}

# 返回数据示例


{
    "errcode": 0,
    "errmsg": "ok",
    "matched": 1,
    "modified": 1,
    "id": ""
}

示例说明: 更新一条记录

# 请求数据示例


{
  "env":"test2-4a89da",
  "query": "db.collection(\"geo\").doc(\"56abd6d5-9daf-4fc7-af05-eca13933f1aa\").update({data:{age: 10}})"
}

# 返回数据示例


{
    "errcode": 0,
    "errmsg": "ok",
    "matched": 1,
    "modified": 1,
    "id": ""
}

示例说明: 更新替换一条记录

# 请求数据示例


{
  "env":"test2-4a89da",
  "query": "db.collection(\"geo\").doc(\"be62d9c4-43ec-4dc6-8ca1-30b206eeed24\").set({data: {
        description: \"set\",
        done: true
      }})"
}

# 返回数据示例


{
    "errcode": 0,
    "errmsg": "ok",
    "matched": 0,
    "modified": 0,
    "id": "be62d9c4-43ec-4dc6-8ca1-30b206eeed24"
}

示例说明: 数据库查询记录

# 请求数据示例


{
  "env":"test2-4a89da",
  "query": "db.collection(\"geo\").where({done:true}).limit(10).skip(1).get()"
}

# 返回数据示例


{
    "errcode": 0,
    "errmsg": "ok",
    "pager": {
        "offset": 1,
        "limit": 10,
        "total": 2
    },
    "data": [
        "{\"_id\":\"b15498af-1a5a-40b4-a4e7-b3fc4a1df482\",\"done\":true,\"name\":\"test\"}"
    ]
}

# 错误码

错误码	错误码取值	解决方案
0	ok	ok
-1	system error	系统繁忙，此时请开发者稍候再试
-1000	system error	系统错误
40014	invalid access_token	不合法的 access_token ，请开发者认真比对 access_token 的有效性（如是否过期），或查看是否正在为恰当的公众号调用接口
40097	invalid args	参数错误
40101	missing parameter	缺少必填参数
41001	access_token missing	缺少 access_token 参数
42001	access_token expired	access_token 超时，请检查 access_token 的有效期，请参考基础支持 - 获取 access_token 中，对 access_token 的详细机制说明
43002	require POST method	需要 POST 请求
44002	empty post data	POST 的数据包为空。post请求body参数不能为空。
47001	data format error	解析 JSON/XML 内容错误;post 数据中参数缺失;检查修正后重试。
85088	no qbase privilege	该APP未开通云开发