微信小程序开发文档 第75页
databaseAggregate 本接口应在服务器端调用,详细说明参见服务端API。 数据库聚合 请求地址 POST https://api.weixin.qq.com/tcb/databaseaggregate?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 env string 是 云环境ID Query string 是 数据库操作语句 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errcode number 错误码 errmsg string 错误信息 data Array.<string> 记录数组 errcode 的合法值 值 说明 最低版本 0 请求成功 -1 系统错误 -1000 系统错误 40014 AccessToken 不合法 40097 请求参数错误 40101 缺少必填参数 41001 缺少AccessToken 42001 AccessToken过期 43002 HTTP METHOD 错误 44002 POST BODY 为空 47001 POST BODY 格式错误 85088 该APP未开通云开发 其他错误码 云开发错误码 请求数据示例 { "env":"test2-4a89da", "query": "db.collection(\"test_collection\").aggregate().match({tags:\"cloud\"}).limit(10).end()" } 返回数据示例 { "errcode": 0, "errmsg": "ok", "data": [ "{\"_id\":\"f77e039f-f1cf-4aa8-bd59-16cbaa91e6ea\",\"location\":{\"type\":\"Point\",\"coordinates\":[{\"$numberDouble\":\"113.0\"},{\"$numberDouble\":\"23.0\"}]},\"done\":false,\"description\":\"learn cloud database\",\"due\":\"2019-09-09\",\"tags\":[\"cloud\",\"database\"]}", "{\"_id\":\"6bb88938-49ea-42b6-a6f5-ce408970cfc6\",\"due\":\"2019-09-09\",\"tags\":[\"cloud\",\"database\"],\"location\":{\"type\":\"Point\",\"coordinates\":[{\"$numberDouble\":\"113.0\"},{\"$numberDouble\":\"23.0\"}]},\"done\":false,\"description\":\"学习 cloud database\"}", "{\"_id\":\"51f4f67e-a6a1-4c3e-a50f-827380b8da86\",\"description\":\"学习 cloud database\",\"due\":\"2019-09-09\",\"tags\":[\"cloud\",\"database\"],\"location\":{\"coordinates\":[{\"$numberDouble\":\"113.0\"},{\"$numberDouble\":\"23.0\"}],\"type\":\"Point\"},\"done\":false}", "{\"_id\":\"ee1d69da-b7ec-4e7a-bc1f-2fae31da4ce0\",\"tags\":[\"cloud\",\"database\"],\"location\":{\"type\":\"Point\",\"coordinates\":[{\"$numberDouble\":\"113.0\"},{\"$numberDouble\":\"23.0\"}]},\"done\":false,\"description\":\"学习 cloud database\",\"due\":\"2019-09-09\"}" ] } 数据库操作语句说明 数据库操作语句语法与数据库 API相同, 聚合操作参考聚合文档
databaseQuery 本接口应在服务器端调用,详细说明参见服务端API。 数据库查询记录 请求地址 POST https://api.weixin.qq.com/tcb/databasequery?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 env string 是 云环境ID query string 是 数据库操作语句 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errcode number 错误码 errmsg string 错误信息 pager Object 分页信息 data Array.<string> 记录数组 errcode 的合法值 值 说明 最低版本 0 请求成功 -1 系统错误 -1000 系统错误 40014 AccessToken 不合法 40097 请求参数错误 40101 缺少必填参数 41001 缺少AccessToken 42001 AccessToken过期 43002 HTTP METHOD 错误 44002 POST BODY 为空 47001 POST BODY 格式错误 85088 该APP未开通云开发 其他错误码 云开发错误码 pager 的结构 属性 类型 说明 Offset number 偏移 Limit number 单次查询限制 Total number 符合查询条件的记录总数 Tips query中应使用limit()限制单次拉取的数量,默认10条。 请求数据示例 { "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":...
databaseDelete 本接口应在服务器端调用,详细说明参见服务端API。 数据库删除记录 请求地址 POST https://api.weixin.qq.com/tcb/databasedelete?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 env string 是 云环境ID query string 是 数据库操作语句 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errcode number 错误码 errmsg string 错误信息 deleted number 删除记录数量 errcode 的合法值 值 说明 最低版本 0 请求成功 -1 系统错误 -1000 系统错误 40014 AccessToken 不合法 40097 请求参数错误 40101 缺少必填参数 41001 缺少AccessToken 42001 AccessToken过期 43002 HTTP METHOD 错误 44002 POST BODY 为空 47001 POST BODY 格式错误 85088 该APP未开通云开发 其他错误码 云开发错误码 请求数据示例1: 操作集合 { "env":"test2-4a89da", "query": "db.collection(\"geo\").where({done:false}).remove()" } 返回数据示例1: 操作集合 { "errcode": 0, "errmsg": "ok", "deleted": 2 } 请求数据示例2: 操作记录 { "env":"test2-4a89da", "query": "db.collection(\"geo\").doc(\"be62d9c4-43ec-4dc6-8ca1-30b206eeed24\").remove()" } 返回数据示例2: 操作记录 { "errcode": 0, "errmsg": "ok", "deleted": 1 } 数据库操作语句说明 数据库操作语句语法与数据库 API相同
databaseAdd 本接口应在服务器端调用,详细说明参见服务端API。 数据库插入记录 请求地址 POST https://api.weixin.qq.com/tcb/databaseadd?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 env string 是 云环境ID query string 是 数据库操作语句 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errcode number 错误码 errmsg string 错误信息 id_list Array.<string> 插入成功的数据集合主键_id。 errcode 的合法值 值 说明 最低版本 0 请求成功 -1 系统错误 -1000 系统错误 40014 AccessToken 不合法 40097 请求参数错误 40101 缺少必填参数 41001 缺少AccessToken 42001 AccessToken过期 43002 HTTP METHOD 错误 44002 POST BODY 为空 47001 POST BODY 格式错误 85088 该APP未开通云开发 其他错误码 云开发错误码 请求数据示例 { "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...
databaseCollectionGet 本接口应在服务器端调用,详细说明参见服务端API。 获取特定云环境下集合信息 请求地址 POST https://api.weixin.qq.com/tcb/databasecollectionget?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 env string 是 云环境ID limit number 10 否 获取数量限制 offset number 0 否 偏移量 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errcode number 错误码 errmsg string 错误信息 pager Object 分页信息 collections Array.<Object> 集合信息 errcode 的合法值 值 说明 最低版本 0 请求成功 -1 系统错误 -1000 系统错误 40014 AccessToken 不合法 40097 请求参数错误 40101 缺少必填参数 41001 缺少AccessToken 42001 AccessToken过期 43002 HTTP METHOD 错误 44002 POST BODY 为空 47001 POST BODY 格式错误 85088 该APP未开通云开发 其他错误码 云开发错误码 pager 的结构 属性 类型 说明 Offset number 偏移 Limit number 单次查询限制 Total number 符合查询条件的记录总数 collections 的结构 属性 类型 说明 name string 集合名 count number 表中文档数量 size number 表的大小(即表中文档总大小),单位:字节 index_count number 索引数量 index_size...
databaseCollectionDelete 本接口应在服务器端调用,详细说明参见服务端API。 删除集合 请求地址 POST https://api.weixin.qq.com/tcb/databasecollectiondelete?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 env string 是 云环境ID collection_name string 是 集合名称 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errcode number 错误码 errmsg string 错误信息 errcode 的合法值 值 说明 最低版本 0 请求成功 -1 系统错误 -1000 系统错误 40014 AccessToken 不合法 40097 请求参数错误 40101 缺少必填参数 41001 缺少AccessToken 42001 AccessToken过期 43002 HTTP METHOD 错误 44002 POST BODY 为空 47001 POST BODY 格式错误 85088 该APP未开通云开发 其他错误码 云开发错误码 请求数据示例 { "env":"test2-4a89da", "collection_name": "test_delete_collection" } 返回数据示例 { "errcode": 0, "errmsg": "ok", }
databaseCollectionAdd 本接口应在服务器端调用,详细说明参见服务端API。 新增集合 请求地址 POST https://api.weixin.qq.com/tcb/databasecollectionadd?access_token=ACCESS_TOKEN 请求参数 属性 类型 默认值 必填 说明 access_token string 是 接口调用凭证 env string 是 云环境ID collection_name string 是 集合名称 返回值 Object 返回的 JSON 数据包 属性 类型 说明 errcode number 错误码 errmsg string 错误信息 errcode 的合法值 值 说明 最低版本 0 请求成功 -1 系统错误 -1000 系统错误 40014 AccessToken 不合法 40097 请求参数错误 40101 缺少必填参数 41001 缺少AccessToken 42001 AccessToken过期 43002 HTTP METHOD 错误 44002 POST BODY 为空 47001 POST BODY 格式错误 85088 该APP未开通云开发 其他错误码 云开发错误码 请求数据示例 { "env":"test2-4a89da", "collection_name": "test_add_collection" } 返回数据示例 { "errcode": 0, "errmsg": "ok", }
小程序插件中使用云开发 从基础库 2.4.1 开始,在小程序插件中可以使用云开发,插件中使用云开发时,使用的是插件方的云资源而非宿主的云资源,在使用方式上与在小程序中使用无异。
重要概念 在此提供云开发的一些重要概念解释,掌握这些概念对理解云开发和其开发模式非常重要: 1.资源环境 一个环境对应一整套独立的云开发资源,包括数据库、存储空间、云函数等资源。各个环境是相互独立的,用户开通云开发后即创建了一个环境,默认可拥有最多两个环境。在实际开发中,建议每一个正式环境都搭配一个测试环境,所有功能先在测试环境测试完毕后再上到正式环境。以初始可创建的两个环境为例,建议一个创建为 test 测试环境,一个创建为 release 正式环境。 为了方便开发者调试,从开发者工具 1.02.1905302 及基础库 2.7.1 起,在 wx.cloud.init 后会在调试器中输出 SDK 中所使用的默认环境: 同时,在 Network 面板中会输出各个云开发操作的请求详情,其中包括该调用所请求的环境 ID: 2.配额说明 资源配额 以下为云开发各类资源配额指标,由腾讯云 TCB 提供存储和计算服务。 用户可通过下载最新的微信开发者工具使用该功能。 资源配额可分为三类:资源均衡型、CDN 资源消耗型、云函数资源消耗型、数据库资源消耗型。 资源均衡型 分类 参数 基础版 1 基础版 2 专业版 1 专业版 2 专业版 3 旗舰版 1 旗舰版 2 旗舰版 3 企业版 1 存储 容量 5GB 10GB 50GB 100GB 300GB 500GB 700GB 1000GB 1300GB 下载操作次数 150万/月 200万/月 750万/月 1500万/月 2500万/月 3750万/月 4500万/月 5000万/月 6000万/月 上传操作次数 60万/月 100万/月 300万/月 600万/月 1000万/月 1500万/月 2000万/月 2500万/月 3000万/月 CDN回源流量1 5GB/月 10GB/月 50GB/月 150GB/月 300GB/月 500GB/月 600GB/月 800GB/月 1000GB/月 CDN CDN流量 5GB/月 25GB/月 50GB/月 150GB/月 300GB/月 500GB/月 1000GB/月 2000GB/月 4000GB/月 云函数 资源使用量GBs3 4万/月 20万/月 40万/月 150万/月 300万/月 400万/月 1500万/月 3000万/月 4000万/月 外网出流量 1GB/月 3GB/月 5GB/月 10GB/月 20GB/月 25GB/月 100GB/月 200GB/月 400GB/月 数据库 容量 2GB...
可以按如下步骤快速开始使用云开发。 新建云开发模板 开通云开发 体验小程序 查看控制台 1. 新建云开发模板 也可以省略此步骤,直接在已有项目上开通和使用云开发。 新建项目选择一个空目录,填入 AppID(使用云开发能力必须填写 AppID),勾选创建 “云开发 QuickStart 项目”,点击创建即可得到一个展示云开发基础能力的示例小程序。该小程序与普通 QuickStart 小程序有以下不同需注意: 无游客模式、也不可以使用 测试号 project.config.json 中增加了字段 cloudfunctionRoot 用于指定存放云函数的目录 cloudfunctionRoot 指定的目录有特殊的图标 云开发能力从基础库 2.2.3 开始支持(覆盖率 97.3%,查看兼容性问题) 从基础库 2.4.1 开始,在小程序插件中可以使用云开发,插件中使用云开发时,使用的是插件方的云资源而非宿主的云资源,在使用方式上与在小程序中使用无异。 2. 开通云开发、创建环境 创建了第一个云开发小程序后,在使用云开发能力之前需要先开通云开发。在开发者工具工具栏左侧,点击 “云开发” 按钮即可打开云控制台、根据提示开通云开发、创建云环境。默认配额下可以创建两个环境,各个环境相互隔离,每个环境都包含独立的数据库实例、存储空间、云函数配置等资源。每个环境都有唯一的环境 ID 标识,初始创建的环境自动成为默认环境。 注:AppID 首次开通云环境后,需等待大约 10 分钟方可正常使用云 API,在此期间官方后台服务正在做准备服务,如尝试在小程序中调用云 API 则会报 cloud init error:{ errMsg: “invalid scope” } 的错误 3. 体验小程序 开通创建环境后,即可以开始在模拟器上操作小程序体验云开发提供的部分基础能力演示。 4. 查看控制台 云开发控制台是管理云开发资源的地方,控制台提供以下能力: 运营分析:查看云开发监控、配额使用量、用户访问情况 数据库:管理数据库,可查看、增加、更新、查找、删除数据、管理索引、管理数据库访问权限等 存储管理:查看和管理存储空间 云函数:查看云函数列表、配置、日志 5. 销毁环境 如需销毁环境,开发者可通过工单联系我们。具体工单提交方式请参考文档《小程序·云开发工单》。