跳到主要内容

云数据库插件

Tencent CloudBase Framework Database Plugin

Tencent CloudBase Framework Database Plugin

Github License Npm version issue PRs Welcome star

云开发 CloudBase Framework 框架「Database」插件: 通过云开发 CloudBase Framework 框架一键配置云开发数据库集合、索引,使用高性能的 Serverless 化的 NoSQL 数据库服务。可以搭配其他插件如 Website 插件、Node 插件实现云端一体开发。

功能特性#

使用方法#

步骤一. 准备工作#

具体步骤请参照 准备云开发环境和 CloudBase CLI 命令工具

步骤二. 进入项目目录进行初始化#

如果是目前已有的后端应用项目

cloudbase

如果想全新开始一个项目,可以直接执行 init 来从模板开始一个项目

cloudbase init

步骤三. 一键部署#

cloudbase framework deploy

配置#

默认情况下不需要任何配置即可使用,以下配置参数针对有特殊需求的场景

配置示例#

cloudbase init 之后会创建云开发的配置文件 cloudbaserc.json,可在配置文件的 plugins 里修改和写入插件配置

{  "envId": "{{envId}}",  "framework": {    "plugins": {      "client": {        "use": "@cloudbase/framework-plugin-database",        "inputs": {          "collections": [            {              "collectionName": "test-collection"            }          ]        }      }    }  }}

配置参数说明#

collections#

必填,数据库集合信息,数组类型

属性名称类型长度是否必填描述
collectionNameString1-64集合名称
descriptionString1-128描述信息
createIndexesArray.1-20创建的索引
dropIndexesArray.1-20删除的索引
aclTagString1-32权限标签。包含以下取值: READONLY:所有用户可读,仅创建者和管理员可写 PRIVATE:仅创建者及管理员可读写 ADMINWRITE:所有用户可读,仅管理员可写 ADMINONLY:仅管理员可读写 CUSTOM:自定义安全规则
aclRuleJSONaclTag 为 CUSTOM 时,填写安全规则内容, 请参考安全规则编写

createIndex 对象#

属性名称类型长度是否必填描述
nameString1-64索引名称
uniqueBoolean-是否唯一索引
keysArray.< key >1-20描述信息
key 对象#
属性名称类型长度是否必填描述
nameString1-64字段名
directionString1-8字段排序,可枚举值:-1(降序)、1(升序)、2dsphere(地理位置)

dropIndex 对象#

属性名称类型长度是否必填描述
nameString1-64索引名称

更多插件#

请访问 CloudBase Framework 插件列表 搭配使用其他插件

文档资料#