# Tencent CloudBase Framework Database Plugin

(opens new window) (opens new window) (opens new window) (opens new window)

云开发 CloudBase Framework 框架「Database」插件： 通过云开发 CloudBase Framework (opens new window) 框架一键配置云开发数据库集合、索引，使用高性能的 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

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

# createIndex 对象

# key 对象

# dropIndex 对象

# 更多插件

请访问 CloudBase Framework 插件列表 (opens new window) 搭配使用其他插件

# 文档资料

• 云开发官网地址： https://cloudbase.net/ (opens new window)
• 云开发静态网站开通指南：https://docs.cloudbase.net/hosting/ (opens new window)
• 云开发控制台地址： https://console.cloud.tencent.com/tcb (opens new window)