Go to file
2023-11-23 14:57:51 +08:00
collection 添加默认索引 2023-11-23 14:57:51 +08:00
database add uni-cms uni-im database 2023-04-12 15:35:23 +08:00
.editorconfig chore: format code, add editorconfig 2021-12-24 15:20:40 +08:00
.gitignore 移除老版本的opendb-adress-系列数据表 2021-01-04 16:45:40 +08:00
CONTRIBUTING.md update CONTRIBUTING.md. 2021-03-02 14:36:38 +08:00
LICENSE add LICENSE. 2020-07-15 16:30:59 +08:00
opendb-log.md rename uni-* to opendb-* 2020-08-26 10:50:27 +08:00
opendb-mall.md 添加opendb-mall-sku的readme 2020-11-24 16:00:21 +08:00
opendb-news.md rename uni-* to opendb-* 2020-08-26 10:50:27 +08:00
README.md update README.md. 2022-07-07 05:18:23 +00:00
uni-id-score.md update uni-id-score.md. 2022-08-11 04:26:20 +00:00
uni-id.md 重构名字 2020-07-16 17:35:47 +08:00
uni-stat.md update uni-stat docs 2022-05-12 20:13:07 +08:00

openDB

数据库设计,是数字经济的基础,是重要的软基建。

openDB是一套开放的数据表设计规范包括了表名、字段等schema定义以及初始数据。

以用户表为例它约定了一个标准用户表的表名和字段定义并且基于nosql的特性可以由开发者自行扩展字段。

openDBuniCloud的重要软基建支撑uniCloud数字生态的发展。

需求背景

  • 很多js工程师不善于数据库设计希望有成熟的数据库模板避免走弯路
  • 有利于产业分工。业务开发、统计分析、智能推荐、数据转换等都是不同的专业角色,大多数开发者仅善于业务开发,需要专业的数据服务商为其提供服务,如果数据库标准统一,各个角色就可以在插件市场各自提供插件。
    • 比如有专业数据服务商基于openDB中电商规范提供“猜你喜欢”插件就可以被轻松的引入到开发者的应用中
    • 比如有专业的数据导入导出插件可以方便的从ecshop等系统中迁移历史数据
    • 比如有专业的cms后台厂商基于openDB中新闻规范提供更好的新闻编辑工具。
  • 统一的数据库标准,有利于开发者择优切换插件。有利于插件生态的繁荣,并最终通过吸引更多用户做大蛋糕来反哺插件作者。
    • 比如有多个新闻应用模板均基于openDB中的新闻规范那么开发者可以方便的切换到做的更好的插件上。
  • 数据孤岛问题。当多个应用之间的数据库规范相同他们之间的跨应用数据交换就变的更容易。未来uniCloud会提供更方便的跨应用数据交换机制。
  • 统一的初始数据。比如地区表等数据在openDB中有初始化数据开发者们共享一个相同数据源即可。

uni-id的账户统一,是openDB的成功实践。基于uni-id规范有电商插件、有IM插件、有PC管理插件开发者可以方便的把这些插件整合到自己的同一应用中。

openDB中的已有规范

目前openDB已经支持几十张表。可以在https://gitee.com/dcloud/opendb/tree/master/collection查看。

部分常用表单独提供文档如下:

  1. 用户管理uni-id
  2. 文章&评论opendb-news
  3. 电商系统opendb-mall
  4. 新闻系统opendb-news
  5. 日志管理opendb-log

预置数据

openDB不仅支持定义常用的数据表字段,还可以预置初始化数据。

比如,opendb-city-china是opendb中定义好的中国城市字典表,它的定义分为两个部分:

  • collection.json定义数据表名称、所含字段、每个字段的类型以及读写权限规则等
  • data.json定义初始化内容

你通过uniCloud web控制台创建openDB表时,uniCloud会自动校验该opendb表定义中是否包含data.json,若包含,则在创建表定义后,自动导入data.json

如果你的 HBuilderX 项目中,uniCloud/database目录下定义的数据表中含有opendb表定义则对该opendb表执行上传DB Schema操作时uniCloud服务端会判断该opendb表是否已存在

  • 若该opendb表已存在则仅更新 DB Schema
  • 若该opendb表不存在则先创建该表然后校验该opendb表定义中是否包含data.json,若包含data.json,则自动导入data.json

数据表升级

openDB数据表在后续的更新迭代中,可能会涉及到schema预置数据的变更。自HBuilderX 3.5.1之后opendb表支持检查更新。

opendb-city-china为例,当我们要修改或补充城市时,为了兼容已部署的数据表,应提供差量数据,这时我们需要做的是:

  • 更新 opendb-city-china/package.json中的version字段为升级后的版本号;
  • 新增 opendb-city-china/collection.update-原始版本号-升级版本号.jql JQL数据库管理器文件内容为差量数据的JQL语句

比如行政区域的撤销或设立需要数据升级并且定义升级后的版本号为0.0.2这时需要将差量数据以JQL语句的形式写入文件opendb-city-china/collection.update-0.0.1-0.0.2.jql中,并更新opendb-city-china/package.jsonversion字段。

如何引入到自己的服务空间

uniCloud web控制台,新建表时,可直接选择所有openDB的表。

首先选分类,每个分类下又有若干表,表结构和预置数据可直接预览。支持多个表一起创建。

openDB的表,不应修改表名,修改后就无法与其他插件连同了。

欢迎参与

openDB是一个持续发展的、由开发者共建的规范。DCloud欢迎各个业务领域的专业开发者提供规范。

开发者通过提pr的方式openDB添加规范或者给已有规范的表添加字段或者添加初始化数据。gitee支持轻量pr尤其适合共同编辑规范。

  • 您将在这个具有重大意义的项目中的贡献者名单中留下自己的名字
  • 您提的pr成为规范将帮助您享受整个产业链的支持

其他注意:

  • 为了向下兼容,openDB只增加表和字段,不删改。