HarmonyOS Developer DevEco Studio使用指南-开发云数据库
您可以在云侧工程下开发云数据库资源,包括创建对象类型、在对象类型中添加数据条目、部署云数据库。
创建对象类型
对象类型(即ObjectType)用于定义存储对象的集合,不同的对象类型对应的不同数据结构。每创建一个对象类型,云数据库会在每个存储区实例化一个与之结构相对应的对象类型,用于存储对应的数据。
您可在云数据库工程中创建对象类型。
- 右击“clouddb > objecttype”目录,选择“New > Cloud DB Object Type”。
- 输入“Object Type Name”后,点击“OK”。
“clouddb > objecttype”目录下生成并打开新建的对象类型JSON文件。
- 为该对象类型配置字段、索引、以及角色与权限。
- 在“fields”中为对象类型配置字段信息。
参数 | 说明 |
fieldName | 字段名称。 字段的名称长度必须大于等于1个字符,小于等于30个字符,只能包含以下3种类型,并且至少包含“字母”类型:
|
fieldType | 字段的数据类型。 当前支持的数据类型:String、Boolean、Byte、Short、Integer、Long、Float、Double、ByteArray、Text、Date、IntAutoIncrement和LongAutoIncrement。 |
belongPrimaryKey | 设置该字段是否为对象类型的主键。
|
notNull | 设置字段值是否为非空。
|
isNeedEncrypt | 设置字段是否需要加密,开启全程加密数据管理功能。选择加密后,该字段对应的数据会加密存储在存储区中。
|
- 在“indexes”中为对象类型配置索引和索引详情。
参数 | 说明 |
indexName | 索引名称。 索引的名称长度必须大于等于1个字符,小于等于30个字符,只能包含以下3种类型,并且至少包含“字母”类型:
|
indexList | 索引包含的字段。 支持设置组合索引,由多个字段组合成为索引,一个组合索引包含的字段不超过5个。 |
- 在“permissions”中设置各角色是否具有该对象类型的Read、Upsert(包含新增和修改)和Delete权限。
角色 | 权限 |
World | 所有用户,包含认证和非认证用户。默认且最多仅可以拥有Read权限。 |
Authenticated | 经过AppGallery Connect登录认证的用户,包含隐式登录的匿名用户。 |
Creator | 经过认证的数据创建用户,每条记录都有其对应的数据创建人。 |
Administrator | 应用开发者。 |
创建数据条目
创建完对象类型后,您可为对象类型添加数据条目(即DataEntry),来预置刷库数据。
支持手动创建和自动生成数据条目文件。
手动创建数据条目文件
- 右击“clouddb > dataentry”目录,选择“New > Cloud DB Data Entry”。
- 在“Object Type”栏选择需添加数据条目的对象类型,在“Data Entry Name”栏定义数据条目名,完成后点击“OK”。
“clouddb > dataentry”目录下生成并打开新建的数据条目JSON文件,该文件中已为您预置好所选对象类型名称(如下图“objecttype1”)与字段名(如下图“id”、“bookName”、“author”、“price”、“publishTime”、“shadowFlag”)。
- 配置存储区和字段的值(即数据)。
- “cloudDBZoneName”:配置数据条目所在的存储区名称,如下图“cloudDBZone1”。
- “objects”:配置当前对象类型中所有字段的值。一个对象(object)即为一条数据,您可以通过新建一个对象(object)来为字段赋新值,也可以修改某个对象(object)下字段的值(主键或加密字段的值不支持修改)。
自动生成数据条目文件
- 右击对象类型JSON文件,选择“Generate Data Entry”。以“objecttype1.json”文件为例,对象类型“objecttype1”包含了id、bookName、author、price、publishTime、shadowFlag六个字段。
- 在弹出的“Create Cloud DB Data Entry”框内,为即将生成的数据条目定义名称,如“dataentry1”。
- “clouddb > dataentry”目录下自动为该对象类型生成数据条目JSON文件,该文件中已为您预置好所选对象类型名称(如下图“objecttype1”)与字段名(如下图“id”、“bookName”、“author”、“price”、“publishTime”、“shadowFlag”)。
- 配置存储区和字段的值(即数据)。
- “cloudDBZoneName”:配置数据条目所在的存储区名称,如下图“cloudDBZone1”。
- “objects”:配置当前对象类型中所有字段的值。一个对象(object)即为一条数据,您可以通过新建一个对象(object)来为字段赋新值,也可以修改某个对象(object)下字段的值(主键或加密字段的值不支持修改)。
部署云数据库
云数据库资源全部开发完成后,您可以将云数据库统一部署到AGC控制台。
- 右击“clouddb”目录,选择“Deploy Cloud DB”。
- “Event Log”区域可查看云数据库打包与部署状态日志。
请您耐心等待,直至出现“Deploy succeed”日志,表示云数据库已成功部署。
- 登录AppGallery Connect,进入当前项目的云数据库服务菜单,可分别在“对象类型”、“存储区”与“数据”页签查看到您刚刚部署的云数据库资源。
说明
部署对象类型或数据条目JSON文件,实际是部署JSON文件内包含的对象类型或数据条目。因此,您在AGC控制台查看到的将是一个个对象类型或者一条条数据,而非JSON文件。
您可以在AGC控制台继续编辑以上部署的云数据库资源,具体操作请参考管理Cloud DB。