@cloudbase/framework-plugin-database

v1.9.7

云开发 Tencent CloudBase Framework Database Plugin 插件，将项目下的后端应用一键部署云开发云托管应用环境，提供自动弹性伸缩的高性能服务。 For more information about how to use this package see README

Latest version published 10 months ago

License: Apache-2.0

NPM

GitHub

Package Health Score

59 / 100

security
Security review needed
popularity
Limited
maintenance
Sustainable
community
Sustainable

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.9.7	\|	02/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.9.6	\|	08/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.8.16	\|	09/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.9.0	\|	08/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.8.2	\|	08/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (252)

GitHub Stars: 1.94K
Forks: 189
Contributors: -

Direct Usage Popularity

The npm package @cloudbase/framework-plugin-database receives a total of 252 downloads a week. As such, we scored @cloudbase/framework-plugin-database popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package @cloudbase/framework-plugin-database, we found that it has been starred 1,939 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 0
Funding: No

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 39
Open PR: 1
Last Release: 10 months ago
Last Commit: 10 months ago

Further analysis of the maintenance status of @cloudbase/framework-plugin-database based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that @cloudbase/framework-plugin-database demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 4 years
Dependencies: 2 Direct
Versions: 124
Install Size: 29 kB
Dist-tags: 3
# of Files: 6
Maintainers: 15
TS Typings: Yes

@cloudbase/framework-plugin-database has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Tencent CloudBase Framework Database Plugin

云开发 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`

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

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

createIndex 对象

属性名称	类型	长度	是否必填	描述
name	`String`	1-64	是	索引名称
unique	`Boolean`	-	是	是否唯一索引
keys	Array.< key >	1-20	是	描述信息

key 对象

属性名称	类型	长度	是否必填	描述
name	`String`	1-64	是	字段名
direction	`String`	1-8	是	字段排序，可枚举值：-1（降序）、1（升序）、2dsphere（地理位置）

dropIndex 对象

属性名称	类型	长度	是否必填	描述
name	`String`	1-64	是	索引名称

文档资料

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

@cloudbase/framework-plugin-database dependencies

@cloudbase/framework-core change-case

@cloudbase/framework-plugin-database development dependencies

jest typescript

FAQs

What is @cloudbase/framework-plugin-database?

云开发 Tencent CloudBase Framework Database Plugin 插件，将项目下的后端应用一键部署云开发云托管应用环境，提供自动弹性伸缩的高性能服务。. Visit Snyk Advisor to see a full health score report for @cloudbase/framework-plugin-database, including popularity, security, maintenance & community analysis.

Is @cloudbase/framework-plugin-database popular?

The npm package @cloudbase/framework-plugin-database receives a total of 252 weekly downloads. As such, @cloudbase/framework-plugin-database popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @cloudbase/framework-plugin-database well maintained?

We found indications that @cloudbase/framework-plugin-database maintenance is sustainable demonstrating some project activity. We saw a total of 0 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @cloudbase/framework-plugin-database safe to use?

While scanning the latest version of @cloudbase/framework-plugin-database, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 12 November-2024, at 22:04 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP