云开发接口

class wechatpy.client.api.WeChatCloud(client=None)[源代码]
db_add(env, query)[源代码]

数据库插入记录

详情请参考 https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseAdd.html

参数:
  • env – 云开发环境 ID
  • query – 数据库操作语句
返回:

返回插入成功的数据集合主键 _id 列表

db_add_collection(env, collection)[源代码]

新增集合

详情请参考 https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCollectionAdd.html

参数:
  • env – 云开发环境 ID
  • collection – 集合名称
db_aggregate(env, query)[源代码]

数据库聚合

详情请参考 https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseAggregate.html

参数:
  • env – 云开发环境 ID
  • query – 数据库操作语句
返回:

返回记录列表

db_count(env, query)[源代码]

统计集合记录数或统计查询语句对应的结果记录数

详情请参考 https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCount.html

参数:
  • env – 云开发环境 ID
  • query – 数据库操作语句
返回:

返回记录数量

db_delete(env, query)[源代码]

数据库删除记录

详情请参考 https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseDelete.html

参数:
  • env – 云开发环境 ID
  • query – 数据库操作语句
返回:

返回删除记录数量

db_delete_collection(env, collection)[源代码]

删除集合

详情请参考 https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCollectionDelete.html

参数:
  • env – 云开发环境 ID
  • collection – 集合名称
db_export(env, file_path, file_type, query)[源代码]

数据库导出

详情请参考 https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseMigrateExport.html

参数:
  • env – 云开发环境 ID
  • file_path – 导出文件路径(导入文件需先上传到同环境的存储中,可使用开发者工具或 HTTP API的上传文件 API上传)
  • file_type – 导出文件类型,文件格式参考数据库导入指引中的文件格式部分,值为数字,1 为 JSON,2 为 CSV
  • query – 导出条件
返回:

导出任务 ID,可使用数据库迁移进度查询 API 查询导出结果,获取文件下载链接

db_get_collection(env, offset=0, limit=10)[源代码]

获取特定云环境下集合信息

详情请参考 https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCollectionGet.html

参数:
  • env – 云开发环境 ID
  • offset – 偏移量,默认为 0
  • limit – 获取数量限制, 默认为 10
db_import(env, collection, file_path, file_type, conflict_mode, stop_on_error=True)[源代码]

数据库导入

详情请参考 https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseMigrateImport.html

参数:
  • 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_query(env, query)[源代码]

数据库查询记录

详情请参考 https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseQuery.html

参数:
  • env – 云开发环境 ID
  • query – 数据库操作语句
返回:

返回的 JSON 数据包

db_query_migrate_info(env, job_id)[源代码]

数据库迁移状态查询

详情请参考 https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseMigrateQueryInfo.html

参数:
  • env – 云开发环境 ID
  • job_id – 任务 ID
db_update(env, query)[源代码]

数据更新记录

详情请参考 https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseUpdate.html

参数:
  • env – 云开发环境 ID
  • query – 数据库操作语句
返回:

返回的 JSON 数据包

db_update_index(env, collection, create_indexes=None, drop_indexes=None)[源代码]

变更数据库索引

详情请参考 https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/updateIndex.html

参数:
  • env – 云开发环境 ID
  • collection – 导出 collection 名称
delete_files(env, fileid_list)[源代码]

删除文件

详情请参考 https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/storage/batchDeleteFile.html

参数:
  • env – 云开发环境 ID
  • fileid_list – 文件 ID 列表
返回:

被删除的文件列表

download_files(env, file_list)[源代码]

获取文件下载链接

详情请参考 https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/storage/batchDownloadFile.html

参数:
  • env – 云开发环境 ID
  • file_list – 文件列表
返回:

返回文件列表

get_qcloud_token(lifespan=7200)[源代码]

获取腾讯云 API 调用凭证

详情请参考 https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/utils/getQcloudToken.html

invoke_cloud_function(env, name, data=None)[源代码]

触发云函数

详情请参考 https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/functions/invokeCloudFunction.html

参数:
  • env – 云开发环境 ID
  • name – 云函数名称
  • data – 云函数的传入参数,具体结构由开发者定义
upload_file(env, path)[源代码]

获取文件上传链接

详情请参考 https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/storage/uploadFile.html

参数:env – 云开发环境 ID