云开发接口#
- class wechatpy.client.api.WeChatCloud(client=None)[源代码]#
-
- db_export(env, file_path, file_type, query)[源代码]#
数据库导出
- 参数
env – 云开发环境 ID
file_path – 导出文件路径(导入文件需先上传到同环境的存储中,可使用开发者工具或 HTTP API的上传文件 API上传)
file_type – 导出文件类型,文件格式参考数据库导入指引中的文件格式部分,值为数字,1 为 JSON,2 为 CSV
query – 导出条件
- 返回
导出任务 ID,可使用数据库迁移进度查询 API 查询导出结果,获取文件下载链接
- db_get_collection(env, offset=0, limit=10)[源代码]#
获取特定云环境下集合信息
- 参数
env – 云开发环境 ID
offset – 偏移量,默认为 0
limit – 获取数量限制, 默认为 10
- db_import(env, collection, file_path, file_type, conflict_mode, stop_on_error=True)[源代码]#
数据库导入
- 参数
env – 云开发环境 ID
collection – 导入 collection 名称
file_path – 导入文件路径(导入文件需先上传到同环境的存储中,可使用开发者工具或 HTTP API的上传文件 API上传)
file_type – 导入文件类型,文件格式参考数据库导入指引中的文件格式部分,值为数字,1 为 JSON,2 为 CSV
stop_on_error – 是否在遇到错误时停止导入,默认为 True
conflict_mode – 冲突处理模式, 值为数字,1 为 INSERT,2 为 UPSERT
- 返回
导入任务 ID,可使用数据库迁移进度查询 API 查询导入进度及结果
- db_update_index(env, collection, create_indexes=None, drop_indexes=None)[源代码]#
变更数据库索引
- 参数
env – 云开发环境 ID
collection – 导出 collection 名称
- invoke_cloud_function(env, name, data=None)[源代码]#
触发云函数
- 参数
env – 云开发环境 ID
name – 云函数名称
data – 云函数的传入参数,具体结构由开发者定义
- upload_file(env, path)[源代码]#
获取文件上传链接
详情请参考 https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/storage/uploadFile.html
- 参数
env – 云开发环境 ID