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 ```js 58 import relationalStore from '@ohos.data.relationalStore'; // 导入模块 59 import UIAbility from '@ohos.app.ability.UIAbility'; 60 61 class EntryAbility extends UIAbility { 62 onWindowStageCreate(windowStage) { 63 const STORE_CONFIG = { 64 name: 'RdbTest.db', // 数据库文件名 65 securityLevel: relationalStore.SecurityLevel.S1 // 数据库安全级别 66 }; 67 68 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语句 69 70 relationalStore.getRdbStore(this.context, STORE_CONFIG, (err, store) => { 71 if (err) { 72 console.error(`Failed to get RdbStore. Code:${err.code}, message:${err.message}`); 73 return; 74 } 75 console.info(`Succeeded in getting RdbStore.`); 76 store.executeSql(SQL_CREATE_TABLE); // 创建数据表 77 78 // 这里执行数据库的增、删、改、查等操作 79 80 }); 81 } 82 } 83 ``` 84 85 FA模型示例： 86 87 88 ```js 89 import relationalStore from '@ohos.data.relationalStore'; // 导入模块 90 import featureAbility from '@ohos.ability.featureAbility'; 91 92 // 获取context 93 let context = featureAbility.getContext(); 94 95 const STORE_CONFIG = { 96 name: 'RdbTest.db', // 数据库文件名 97 securityLevel: relationalStore.SecurityLevel.S1 // 数据库安全级别 98 }; 99 100 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语句 101 102 relationalStore.getRdbStore(context, STORE_CONFIG, (err, store) => { 103 if (err) { 104 console.error(`Failed to get RdbStore. Code:${err.code}, message:${err.message}`); 105 return; 106 } 107 console.info(`Succeeded in getting RdbStore.`); 108 store.executeSql(SQL_CREATE_TABLE); // 创建数据表 109 110 // 这里执行数据库的增、删、改、查等操作 111 112 }); 113 ``` 114 115 > **说明：** 116 > 117 > - 应用创建的数据库与其上下文（Context）有关，即使使用同样的数据库名称，但不同的应用上下文，会产生多个数据库，例如每个UIAbility都有各自的上下文。 118 > 119 > - 当应用首次获取数据库（调用getRdbStore）后，在应用沙箱内会产生对应的数据库文件。使用数据库的过程中，数据库文件相同的目录下，可以会产生以-wal和-shm结尾的临时文件，此时开发者希望移到数据库文件到其它地方使用可查看，需要同时移动这些临时文件。当应用被卸载完成后，其在设备上产生的数据库文件及临时文件也会被移除。 120 1212. 获取到RdbStore后，调用insert()接口插入数据。示例代码如下所示： 122 123 ```js 124 const valueBucket = { 125 'NAME': 'Lisa', 126 'AGE': 18, 127 'SALARY': 100.5, 128 'CODES': new Uint8Array([1, 2, 3, 4, 5]) 129 }; 130 store.insert('EMPLOYEE', valueBucket, (err, rowId) => { 131 if (err) { 132 console.error(`Failed to insert data. Code:${err.code}, message:${err.message}`); 133 return; 134 } 135 console.info(`Succeeded in inserting data. rowId:${rowId}`); 136 }) 137 ``` 138 139 > **说明：** 140 > 141 > 关系型数据库没有显式的flush操作实现持久化，数据插入即保存在持久化文件。 142 1433. 根据谓词指定的实例对象，对数据进行修改或删除。 144 145 调用update()方法修改数据，调用delete()方法删除数据。示例代码如下所示： 146 147 ```js 148 // 修改数据 149 const valueBucket = { 150 'NAME': 'Rose', 151 'AGE': 22, 152 'SALARY': 200.5, 153 'CODES': new Uint8Array([1, 2, 3, 4, 5]) 154 }; 155 let predicates = new relationalStore.RdbPredicates('EMPLOYEE'); // 创建表'EMPLOYEE'的predicates 156 predicates.equalTo('NAME', 'Lisa'); // 匹配表'EMPLOYEE'中'NAME'为'Lisa'的字段 157 store.update(valueBucket, predicates, (err, rows) => { 158 if (err) { 159 console.error(`Failed to update data. Code:${err.code}, message:${err.message}`); 160 return; 161 } 162 console.info(`Succeeded in updating data. row count: ${rows}`); 163 }) 164 165 // 删除数据 166 let predicates = new relationalStore.RdbPredicates('EMPLOYEE'); 167 predicates.equalTo('NAME', 'Lisa'); 168 store.delete(predicates, (err, rows) => { 169 if (err) { 170 console.error(`Failed to delete data. Code:${err.code}, message:${err.message}`); 171 return; 172 } 173 console.info(`Delete rows: ${rows}`); 174 }) 175 ``` 176 1774. 根据谓词指定的查询条件查找数据。 178 179 调用query()方法查找数据，返回一个ResultSet结果集。示例代码如下所示： 180 181 ```js 182 let predicates = new relationalStore.RdbPredicates('EMPLOYEE'); 183 predicates.equalTo('NAME', 'Rose'); 184 store.query(predicates, ['ID', 'NAME', 'AGE', 'SALARY', 'CODES'], (err, resultSet) => { 185 if (err) { 186 console.error(`Failed to query data. Code:${err.code}, message:${err.message}`); 187 return; 188 } 189 console.info(`ResultSet column names: ${resultSet.columnNames}`); 190 console.info(`ResultSet column count: ${resultSet.columnCount}`); 191 }) 192 ``` 193 194 > **说明：** 195 > 196 > 当应用完成查询数据操作，不再使用结果集（ResultSet）时，请及时调用close方法关闭结果集，释放系统为其分配的内存。 197 1985. 删除数据库。 199 200 调用deleteRdbStore()方法，删除数据库及数据库相关文件。示例代码如下： 201 202 Stage模型示例： 203 204 205 ```js 206 import UIAbility from '@ohos.app.ability.UIAbility'; 207 208 class EntryAbility extends UIAbility { 209 onWindowStageCreate(windowStage) { 210 relationalStore.deleteRdbStore(this.context, 'RdbTest.db', (err) => { 211 if (err) { 212 console.error(`Failed to delete RdbStore. Code:${err.code}, message:${err.message}`); 213 return; 214 } 215 console.info('Succeeded in deleting RdbStore.'); 216 }); 217 } 218 } 219 ``` 220 221 FA模型示例： 222 223 224 ```js 225 import featureAbility from '@ohos.ability.featureAbility'; 226 227 // 获取context 228 let context = featureAbility.getContext(); 229 230 relationalStore.deleteRdbStore(context, 'RdbTest.db', (err) => { 231 if (err) { 232 console.error(`Failed to delete RdbStore. Code:${err.code}, message:${err.message}`); 233 return; 234 } 235 console.info('Succeeded in deleting RdbStore.'); 236 }); 237 ``` 238
