1# 通过关系型数据库实现数据持久化 2 3 4## 场景介绍 5 6关系型数据库基于SQLite组件，适用于存储包含复杂关系数据的场景，比如一个班级的学生信息，需要包括姓名、学号、各科成绩等，又或者公司的雇员信息，需要包括姓名、工号、职位等，由于数据之间有较强的对应关系，复杂程度比键值型数据更高，此时需要使用关系型数据库来持久化保存数据。 7 8 9## 基本概念 10 11- **谓词**：数据库中用来代表数据实体的性质、特征或者数据实体之间关系的词项，主要用来定义数据库的操作条件。 12 13- **结果集**：指用户查询之后的结果集合，可以对数据进行访问。结果集提供了灵活的数据访问方式，可以更方便地拿到用户想要的数据。 14 15 16## 运作机制 17 18关系型数据库对应用提供通用的操作接口，底层使用SQLite作为持久化存储引擎，支持SQLite具有的数据库特性，包括但不限于事务、索引、视图、触发器、外键、参数化查询和预编译SQL语句。 19 20**图1** 关系型数据库运作机制 21 22 23 24 25## 约束限制 26 27- 系统默认日志方式是WAL（Write Ahead Log）模式，系统默认落盘方式是FULL模式。 28 29- 数据库中连接池的最大数量是4个，用以管理用户的读操作。 30 31- 为保证数据的准确性，数据库同一时间只能支持一个写操作。 32 33- 当应用被卸载完成后，设备上的相关数据库文件及临时文件会被自动清除。 34 35 36## 接口说明 37 38以下是关系型数据库持久化功能的相关接口，大部分为异步接口。异步接口均有callback和Promise两种返回形式，下表均以callback形式为例，更多接口及使用方式请见[关系型数据库](../reference/apis/js-apis-data-relationalStore.md)。 39 40| 接口名称 | 描述 | 41| -------- | -------- | 42| getRdbStore(context: Context, config: StoreConfig, callback: AsyncCallback<RdbStore>): void | 获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作。 | 43| executeSql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallback<void>):void | 执行包含指定参数但不返回值的SQL语句。 | 44| insert(table: string, values: ValuesBucket, callback: AsyncCallback<number>):void | 向目标表中插入一行数据。 | 45| update(values: ValuesBucket, predicates: RdbPredicates, callback: AsyncCallback<number>):void | 根据RdbPredicates的指定实例对象更新数据库中的数据。 | 46| delete(predicates: RdbPredicates, callback: AsyncCallback<number>):void | 根据RdbPredicates的指定实例对象从数据库中删除数据。 | 47| query(predicates: RdbPredicates, columns: Array<string>, callback: AsyncCallback<ResultSet>):void | 根据指定条件查询数据库中的数据。 | 48| deleteRdbStore(context: Context, name: string, callback: AsyncCallback<void>): void | 删除数据库。 | 49 50 51## 开发步骤 52 531. 使用关系型数据库实现数据持久化，需要获取一个RdbStore。示例代码如下所示： 54 55 Stage模型示例： 56 57 ```ts 58 import relationalStore from '@ohos.data.relationalStore'; // 导入模块 59 import UIAbility from '@ohos.app.ability.UIAbility'; 60 import { BusinessError } from '@ohos.base'; 61 import window from '@ohos.window'; 62 63 class EntryAbility extends UIAbility { 64 onWindowStageCreate(windowStage: window.WindowStage) { 65 const STORE_CONFIG :relationalStore.StoreConfig= { 66 name: 'RdbTest.db', // 数据库文件名 67 securityLevel: relationalStore.SecurityLevel.S1, // 数据库安全级别 68 encrypt: false, // 可选参数，指定数据库是否加密，默认不加密 69 dataGroupId: "dataGroupID" // 可选参数，仅可在Stage模型下使用，表示为应用组ID，需要向应用市场获取。指定在此Id对应的沙箱路径下创建实例，当此参数不填时，默认在本应用沙箱目录下创建。 70 }; 71 72 // 假设当前数据库版本为3，表结构：EMPLOYEE (NAME, AGE, SALARY, CODES) 73 const SQL_CREATE_TABLE = 'CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)'; // 建表Sql语句 74 75 relationalStore.getRdbStore(this.context, STORE_CONFIG, (err, store) => { 76 if (err) { 77 console.error(`Failed to get RdbStore. Code:${err.code}, message:${err.message}`); 78 return; 79 } 80 console.info(`Succeeded in getting RdbStore.`); 81 82 // 当数据库创建时，数据库默认版本为0 83 if (store.version == 0) { 84 store.executeSql(SQL_CREATE_TABLE); // 创建数据表 85 // 设置数据库的版本，入参为大于0的整数 86 store.version = 3; 87 } 88 89 // 如果数据库版本不为0且和当前数据库版本不匹配，需要进行升降级操作 90 // 当数据库存在并假定版本为1时，例应用从某一版本升级到当前版本，数据库需要从1版本升级到2版本 91 if (store.version != 3 && store.version == 1) { 92 // version = 1：表结构：EMPLOYEE (NAME, SALARY, CODES, ADDRESS) => version = 2：表结构：EMPLOYEE (NAME, AGE, SALARY, CODES, ADDRESS) 93 if (store != undefined) { 94 (store as relationalStore.RdbStore).executeSql("ALTER TABLE EMPLOYEE ADD COLUMN AGE INTEGER", ); 95 store.version = 2; 96 } 97 } 98 99 // 当数据库存在并假定版本为2时，例应用从某一版本升级到当前版本，数据库需要从2版本升级到3版本 100 if (store.version != 3 && store.version == 2) { 101 // version = 2：表结构：EMPLOYEE (NAME, AGE, SALARY, CODES, ADDRESS) => version = 3：表结构：EMPLOYEE (NAME, AGE, SALARY, CODES) 102 if (store != undefined) { 103 (store as relationalStore.RdbStore).executeSql("ALTER TABLE EMPLOYEE DROP COLUMN ADDRESS TEXT", ); 104 store.version = 3; 105 } 106 } 107 108 // 请确保获取到RdbStore实例后，再进行数据库的增、删、改、查等操作 109 110 }); 111 } 112 } 113 ``` 114 115 FA模型示例： 116 117 118 ```ts 119 import relationalStore from '@ohos.data.relationalStore'; // 导入模块 120 import featureAbility from '@ohos.ability.featureAbility'; 121 122 let context = getContext(this); 123 124 const STORE_CONFIG :relationalStore.StoreConfig = { 125 name: 'RdbTest.db', // 数据库文件名 126 securityLevel: relationalStore.SecurityLevel.S1 // 数据库安全级别 127 }; 128 129 // 假设当前数据库版本为3，表结构：EMPLOYEE (NAME, AGE, SALARY, CODES) 130 const SQL_CREATE_TABLE = 'CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)'; // 建表Sql语句 131 132 relationalStore.getRdbStore(context, STORE_CONFIG, (err, store) => { 133 if (err) { 134 console.error(`Failed to get RdbStore. Code:${err.code}, message:${err.message}`); 135 return; 136 } 137 console.info(`Succeeded in getting RdbStore.`); 138 139 // 当数据库创建时，数据库默认版本为0 140 if (store.version == 0) { 141 store.executeSql(SQL_CREATE_TABLE); // 创建数据表 142 // 设置数据库的版本，入参为大于0的整数 143 store.version = 3; 144 } 145 146 // 如果数据库版本不为0且和当前数据库版本不匹配，需要进行升降级操作 147 // 当数据库存在并假定版本为1时，例应用从某一版本升级到当前版本，数据库需要从1版本升级到2版本 148 if (store.version != 3 && store.version == 1) { 149 // version = 1：表结构：EMPLOYEE (NAME, SALARY, CODES, ADDRESS) => version = 2：表结构：EMPLOYEE (NAME, AGE, SALARY, CODES, ADDRESS) 150 store.executeSql("ALTER TABLE EMPLOYEE ADD COLUMN AGE INTEGER", ); 151 store.version = 2; 152 } 153 154 // 当数据库存在并假定版本为2时，例应用从某一版本升级到当前版本，数据库需要从2版本升级到3版本 155 if (store.version != 3 && store.version == 2) { 156 // version = 2：表结构：EMPLOYEE (NAME, AGE, SALARY, CODES, ADDRESS) => version = 3：表结构：EMPLOYEE (NAME, AGE, SALARY, CODES) 157 store.executeSql("ALTER TABLE EMPLOYEE DROP COLUMN ADDRESS TEXT", ); 158 store.version = 3; 159 } 160 161 // 请确保获取到RdbStore实例后，再进行数据库的增、删、改、查等操作 162 163 }); 164 ``` 165 166 > **说明：** 167 > 168 > - 应用创建的数据库与其上下文（Context）有关，即使使用同样的数据库名称，但不同的应用上下文，会产生多个数据库，例如每个UIAbility都有各自的上下文。 169 > 170 > - 当应用首次获取数据库（调用getRdbStore）后，在应用沙箱内会产生对应的数据库文件。使用数据库的过程中，在与数据库文件相同的目录下可能会产生以-wal和-shm结尾的临时文件。此时若开发者希望移动数据库文件到其它地方使用查看，则需要同时移动这些临时文件，当应用被卸载完成后，其在设备上产生的数据库文件及临时文件也会被移除。 171 1722. 获取到RdbStore后，调用insert()接口插入数据。示例代码如下所示： 173 174 ```ts 175 import { ValuesBucket } from '@ohos.data.ValuesBucket'; 176 177 let key1 = "NAME"; 178 let key2 = "AGE"; 179 let key3 = "SALARY"; 180 let key4 = "CODES"; 181 let value1 = "Lisa"; 182 let value2 = 18; 183 let value3 = 100.5; 184 let value4 = new Uint8Array([1, 2, 3, 4, 5]); 185 const valueBucket: ValuesBucket = { 186 key1: value1, 187 key2: value2, 188 key3: value3, 189 key4: value4, 190 }; 191 192 if (store != undefined) { 193 (store as relationalStore.RdbStore).insert('EMPLOYEE', valueBucket, (err: BusinessError, rowId: number) => { 194 if (err) { 195 console.error(`Failed to insert data. Code:${err.code}, message:${err.message}`); 196 return; 197 } 198 console.info(`Succeeded in inserting data. rowId:${rowId}`); 199 }) 200 } 201 ``` 202 203 > **说明：** 204 > 205 > 关系型数据库没有显式的flush操作实现持久化，数据插入即保存在持久化文件。 206 2073. 根据谓词指定的实例对象，对数据进行修改或删除。 208 209 调用update()方法修改数据，调用delete()方法删除数据。示例代码如下所示： 210 211 ```ts 212 // 修改数据 213 let key1 = "NAME"; 214 let key2 = "AGE"; 215 let key3 = "SALARY"; 216 let key4 = "CODES"; 217 let value1 = "Lisa"; 218 let value2 = 22; 219 let value3 = 200.5; 220 let value4 = new Uint8Array([1, 2, 3, 4, 5]); 221 const valueBucket: ValuesBucket = { 222 key1: value1, 223 key2: value2, 224 key3: value3, 225 key4: value4, 226 }; 227 228 // 修改数据 229 let predicates = new relationalStore.RdbPredicates('EMPLOYEE'); // 创建表'EMPLOYEE'的predicates 230 predicates.equalTo('NAME', 'Lisa'); // 匹配表'EMPLOYEE'中'NAME'为'Lisa'的字段 231 if (store != undefined) { 232 (store as relationalStore.RdbStore).update(valueBucket, predicates, (err: BusinessError, rows: number) => { 233 if (err) { 234 console.error(`Failed to update data. Code:${err.code}, message:${err.message}`); 235 return; 236 } 237 console.info(`Succeeded in updating data. row count: ${rows}`); 238 }) 239 } 240 241 // 删除数据 242 predicates = new relationalStore.RdbPredicates('EMPLOYEE'); 243 predicates.equalTo('NAME', 'Lisa'); 244 if (store != undefined) { 245 (store as relationalStore.RdbStore).delete(predicates, (err: BusinessError, rows: number) => { 246 if (err) { 247 console.error(`Failed to delete data. Code:${err.code}, message:${err.message}`); 248 return; 249 } 250 console.info(`Delete rows: ${rows}`); 251 }) 252 } 253 ``` 254 2554. 根据谓词指定的查询条件查找数据。 256 257 调用query()方法查找数据，返回一个ResultSet结果集。示例代码如下所示： 258 259 ```ts 260 let predicates = new relationalStore.RdbPredicates('EMPLOYEE'); 261 predicates.equalTo('NAME', 'Rose'); 262 if (store != undefined) { 263 (store as relationalStore.RdbStore).query(predicates, ['ID', 'NAME', 'AGE', 'SALARY'], (err: BusinessError, resultSet) => { 264 if (err) { 265 console.error(`Failed to query data. Code:${err.code}, message:${err.message}`); 266 return; 267 } 268 console.info(`ResultSet column names: ${resultSet.columnNames}, column count: ${resultSet.columnCount}`); 269 // resultSet是一个数据集合的游标，默认指向第-1个记录，有效的数据从0开始。 270 while (resultSet.goToNextRow()) { 271 const id = resultSet.getLong(resultSet.getColumnIndex("ID")); 272 const name = resultSet.getString(resultSet.getColumnIndex("NAME")); 273 const age = resultSet.getLong(resultSet.getColumnIndex("AGE")); 274 const salary = resultSet.getDouble(resultSet.getColumnIndex("SALARY")); 275 console.info(`id=${id}, name=${name}, age=${age}, salary=${salary}`); 276 } 277 // 释放数据集的内存 278 resultSet.close(); 279 }) 280 } 281 ``` 282 283 > **说明：** 284 > 285 > 当应用完成查询数据操作，不再使用结果集（ResultSet）时，请及时调用close方法关闭结果集，释放系统为其分配的内存。 286 2875. 删除数据库。 288 289 调用deleteRdbStore()方法，删除数据库及数据库相关文件。示例代码如下： 290 291 Stage模型示例： 292 293 294 ```ts 295 import UIAbility from '@ohos.app.ability.UIAbility'; 296 297 class EntryAbility extends UIAbility { 298 onWindowStageCreate(windowStage: window.WindowStage) { 299 relationalStore.deleteRdbStore(this.context, 'RdbTest.db', (err: BusinessError) => { 300 if (err) { 301 console.error(`Failed to delete RdbStore. Code:${err.code}, message:${err.message}`); 302 return; 303 } 304 console.info('Succeeded in deleting RdbStore.'); 305 }); 306 } 307 } 308 ``` 309 310 FA模型示例： 311 312 313 ```ts 314 import featureAbility from '@ohos.ability.featureAbility'; 315 316 let context = getContext(this); 317 318 relationalStore.deleteRdbStore(context, 'RdbTest.db', (err: BusinessError) => { 319 if (err) { 320 console.error(`Failed to delete RdbStore. Code:${err.code}, message:${err.message}`); 321 return; 322 } 323 console.info('Succeeded in deleting RdbStore.'); 324 }); 325 ``` 326 327## 相关实例 328 329针对关系型数据库的开发，有以下相关实例可供参考： 330 331- [`Rdb`：关系型数据库（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/Data/Rdb)
