1# 通过关系型数据库实现数据持久化 2 3 4## 场景介绍 5 6关系型数据库基于SQLite组件，适用于存储包含复杂关系数据的场景，比如一个班级的学生信息，需要包括姓名、学号、各科成绩等，又或者公司的雇员信息，需要包括姓名、工号、职位等，由于数据之间有较强的对应关系，复杂程度比键值型数据更高，此时需要使用关系型数据库来持久化保存数据。 7 8大数据量场景下查询数据可能会导致耗时长甚至应用卡死，如有相关操作可参考文档[批量数据写数据库场景](../arkts-utils/batch-database-operations-guide.md)，且有建议如下： 9- 单次查询数据量不超过5000条。 10- 在[TaskPool](../reference/apis-arkts/js-apis-taskpool.md)中查询。 11- 拼接SQL语句尽量简洁。 12- 合理地分批次查询。 13 14## 基本概念 15 16- **谓词**：数据库中用来代表数据实体的性质、特征或者数据实体之间关系的词项，主要用来定义数据库的操作条件。 17 18- **结果集**：指用户查询之后的结果集合，可以对数据进行访问。结果集提供了灵活的数据访问方式，可以更方便地拿到用户想要的数据。 19 20 21## 运作机制 22 23关系型数据库对应用提供通用的操作接口，底层使用SQLite作为持久化存储引擎，支持SQLite具有的数据库特性，包括但不限于事务、索引、视图、触发器、外键、参数化查询和预编译SQL语句。 24 25**图1** 关系型数据库运作机制 26 27 28 29 30## 约束限制 31 32- 系统默认日志方式是WAL（Write Ahead Log）模式，系统默认落盘方式是FULL模式。 33 34- 数据库中有4个读连接和1个写连接，线程获取到空闲读连接时，即可进行读取操作。当没有空闲读连接且有空闲写连接时，会将写连接当做读连接来使用。 35 36- 为保证数据的准确性，数据库同一时间只能支持一个写操作。 37 38- 当应用被卸载完成后，设备上的相关数据库文件及临时文件会被自动清除。 39 40- ArkTS侧支持的基本数据类型：number、string、二进制类型数据、boolean。 41 42- 为保证插入并读取数据成功，建议一条数据不要超过2M。超出该大小，插入成功，读取失败。 43 44## 接口说明 45 46以下是关系型数据库持久化功能的相关接口，大部分为异步接口。异步接口均有callback和Promise两种返回形式，下表均以callback形式为例，更多接口及使用方式请见[关系型数据库](../reference/apis-arkdata/js-apis-data-relationalStore.md)。 47 48| 接口名称 | 描述 | 49| -------- | -------- | 50| getRdbStore(context: Context, config: StoreConfig, callback: AsyncCallback<RdbStore>): void | 获得一个RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作。 | 51| executeSql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallback<void>):void | 执行包含指定参数但不返回值的SQL语句。 | 52| insert(table: string, values: ValuesBucket, callback: AsyncCallback<number>):void | 向目标表中插入一行数据。 | 53| update(values: ValuesBucket, predicates: RdbPredicates, callback: AsyncCallback<number>):void | 根据predicates的指定实例对象更新数据库中的数据。 | 54| delete(predicates: RdbPredicates, callback: AsyncCallback<number>):void | 根据predicates的指定实例对象从数据库中删除数据。 | 55| query(predicates: RdbPredicates, columns: Array<string>, callback: AsyncCallback<ResultSet>):void | 根据指定条件查询数据库中的数据。 | 56| deleteRdbStore(context: Context, name: string, callback: AsyncCallback<void>): void | 删除数据库。 | 57| isTokenizerSupported(tokenizer: Tokenizer): boolean | 判断当前平台是否支持传入的分词器。 | 58 59## 开发步骤 60因Stage模型、FA模型的差异，个别示例代码提供了在两种模型下的对应示例；示例代码未区分模型或没有对应注释说明时默认在两种模型下均适用。 61 62关系型数据库操作或者存储过程中，有可能会因为各种原因发生非预期的数据库异常情况（抛出14800011），此时需要对数据库进行重建并恢复数据，以保障正常的应用开发，具体可见[关系型数据库异常重建](data-backup-and-restore.md#关系型数据库异常重建)。 63 641. 使用关系型数据库实现数据持久化，需要获取一个RdbStore，其中包括建库、建表、升降级等操作。示例代码如下所示： 65 66 Stage模型示例： 67 68 ```ts 69 import { relationalStore } from '@kit.ArkData'; // 导入模块 70 import { UIAbility } from '@kit.AbilityKit'; 71 import { BusinessError } from '@kit.BasicServicesKit'; 72 import { window } from '@kit.ArkUI'; 73 74 // 此处示例在Ability中实现，使用者也可以在其他合理场景中使用 75 class EntryAbility extends UIAbility { 76 onWindowStageCreate(windowStage: window.WindowStage) { 77 // 若希望使用分词器，可调用isStorageTypeSupported检查希望使用的分词器是否支持当前平台。 78 let tokenType = relationalStore.Tokenizer.ICU_TOKENIZER; 79 let tokenTypeSupported = relationalStore.isTokenizerSupported(tokenType); 80 if (!tokenTypeSupported) { 81 console.error(`ICU_TOKENIZER is not supported on this platform.`); 82 } 83 const STORE_CONFIG: relationalStore.StoreConfig = { 84 name: 'RdbTest.db', // 数据库文件名 85 securityLevel: relationalStore.SecurityLevel.S3, // 数据库安全级别 86 encrypt: false, // 可选参数，指定数据库是否加密，默认不加密 87 customDir: 'customDir/subCustomDir', // 可选参数，数据库自定义路径。数据库将在如下的目录结构中被创建：context.databaseDir + '/rdb/' + customDir，其中context.databaseDir是应用沙箱对应的路径，'/rdb/'表示创建的是关系型数据库，customDir表示自定义的路径。当此参数不填时，默认在本应用沙箱目录下创建RdbStore实例。 88 isReadOnly: false, // 可选参数，指定数据库是否以只读方式打开。该参数默认为false，表示数据库可读可写。该参数为true时，只允许从数据库读取数据，不允许对数据库进行写操作，否则会返回错误码801。 89 tokenizer: tokenType // 可选参数，指定用户在全文搜索场景(FTS)下使用哪种分词器。当此参数不填时，则在FTS下仅支持英文分词，不支持其他语言分词。 90 }; 91 92 // 判断数据库版本，如果不匹配则需进行升降级操作 93 // 假设当前数据库版本为3，表结构：EMPLOYEE (NAME, AGE, SALARY, CODES, IDENTITY) 94 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, IDENTITY UNLIMITED INT)'; // 建表Sql语句, IDENTITY为bigint类型，sql中指定类型为UNLIMITED INT 95 96 relationalStore.getRdbStore(this.context, STORE_CONFIG, (err, store) => { 97 if (err) { 98 console.error(`Failed to get RdbStore. Code:${err.code}, message:${err.message}`); 99 return; 100 } 101 console.info('Succeeded in getting RdbStore.'); 102 103 // 当数据库创建时，数据库默认版本为0 104 if (store.version === 0) { 105 store.executeSql(SQL_CREATE_TABLE) // 创建数据表，以便后续调用insert接口插入数据 106 .then(() => { 107 // 设置数据库的版本，入参为大于0的整数 108 store.version = 3; 109 }) 110 .catch((err: BusinessError) => { 111 console.error(`Failed to executeSql. Code:${err.code}, message:${err.message}`); 112 }); 113 } 114 115 // 如果数据库版本不为0且和当前数据库版本不匹配，需要进行升降级操作 116 // 当数据库存在并假定版本为1时，例应用从某一版本升级到当前版本，数据库需要从1版本升级到2版本 117 if (store.version === 1) { 118 // version = 1：表结构：EMPLOYEE (NAME, SALARY, CODES, ADDRESS) => version = 2：表结构：EMPLOYEE (NAME, AGE, SALARY, CODES, ADDRESS) 119 store.executeSql('ALTER TABLE EMPLOYEE ADD COLUMN AGE INTEGER') 120 .then(() => { 121 store.version = 2; 122 }).catch((err: BusinessError) => { 123 console.error(`Failed to executeSql. Code:${err.code}, message:${err.message}`); 124 }); 125 } 126 127 // 当数据库存在并假定版本为2时，例应用从某一版本升级到当前版本，数据库需要从2版本升级到3版本 128 if (store.version === 2) { 129 // version = 2：表结构：EMPLOYEE (NAME, AGE, SALARY, CODES, ADDRESS) => version = 3：表结构：EMPLOYEE (NAME, AGE, SALARY, CODES) 130 store.executeSql('ALTER TABLE EMPLOYEE DROP COLUMN ADDRESS') 131 .then(() => { 132 store.version = 3; 133 }).catch((err: BusinessError) => { 134 console.error(`Failed to executeSql. Code:${err.code}, message:${err.message}`); 135 }); 136 } 137 // 请确保获取到RdbStore实例，完成数据表创建后，再进行数据库的增、删、改、查等操作 138 }); 139 } 140 } 141 ``` 142 143 FA模型示例： 144 145 ```ts 146 import { relationalStore } from '@kit.ArkData'; // 导入模块 147 import { featureAbility } from '@kit.AbilityKit'; 148 import { BusinessError } from '@kit.BasicServicesKit'; 149 150 let context = featureAbility.getContext(); 151 152 const STORE_CONFIG: relationalStore.StoreConfig = { 153 name: 'RdbTest.db', // 数据库文件名 154 securityLevel: relationalStore.SecurityLevel.S3 // 数据库安全级别 155 }; 156 157 // 假设当前数据库版本为3，表结构：EMPLOYEE (NAME, AGE, SALARY, CODES, IDENTITY) 158 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, IDENTITY UNLIMITED INT)'; // 建表Sql语句，IDENTITY为bigint类型，sql中指定类型为UNLIMITED INT 159 160 relationalStore.getRdbStore(context, STORE_CONFIG, (err, store) => { 161 if (err) { 162 console.error(`Failed to get RdbStore. Code:${err.code}, message:${err.message}`); 163 return; 164 } 165 console.info('Succeeded in getting RdbStore.'); 166 167 // 当数据库创建时，数据库默认版本为0 168 if (store.version === 0) { 169 store.executeSql(SQL_CREATE_TABLE) // 创建数据表，以便后续调用insert接口插入数据 170 .then(() => { 171 // 设置数据库的版本，入参为大于0的整数 172 store.version = 3; 173 }) 174 .catch((err: BusinessError) => { 175 console.error(`Failed to executeSql. Code:${err.code}, message:${err.message}`); 176 }); 177 } 178 179 // 如果数据库版本不为0且和当前数据库版本不匹配，需要进行升降级操作 180 // 当数据库存在并假定版本为1时，例应用从某一版本升级到当前版本，数据库需要从1版本升级到2版本 181 if (store.version === 1) { 182 // version = 1：表结构：EMPLOYEE (NAME, SALARY, CODES, ADDRESS) => version = 2：表结构：EMPLOYEE (NAME, AGE, SALARY, CODES, ADDRESS) 183 store.executeSql('ALTER TABLE EMPLOYEE ADD COLUMN AGE INTEGER') 184 .then(() => { 185 store.version = 2; 186 }).catch((err: BusinessError) => { 187 console.error(`Failed to executeSql. Code:${err.code}, message:${err.message}`); 188 }); 189 } 190 191 // 当数据库存在并假定版本为2时，例应用从某一版本升级到当前版本，数据库需要从2版本升级到3版本 192 if (store.version === 2) { 193 // version = 2：表结构：EMPLOYEE (NAME, AGE, SALARY, CODES, ADDRESS) => version = 3：表结构：EMPLOYEE (NAME, AGE, SALARY, CODES) 194 store.executeSql('ALTER TABLE EMPLOYEE DROP COLUMN ADDRESS') 195 .then(() => { 196 store.version = 3; 197 }).catch((err: BusinessError) => { 198 console.error(`Failed to executeSql. Code:${err.code}, message:${err.message}`); 199 }); 200 } 201 // 请确保获取到RdbStore实例，完成数据表创建后，再进行数据库的增、删、改、查等操作 202 }); 203 204 ``` 205 206 > **说明：** 207 > 208 > - 应用创建的数据库与其上下文（Context）有关，即使使用同样的数据库名称，但不同的应用上下文，会产生多个数据库，例如每个UIAbility都有各自的上下文。 209 > 210 > - 当应用首次获取数据库（调用getRdbStore）后，在应用沙箱内会产生对应的数据库文件。使用数据库的过程中，在与数据库文件相同的目录下可能会产生以-wal和-shm结尾的临时文件。此时若开发者希望移动数据库文件到其它地方使用查看，则需要同时移动这些临时文件，当应用被卸载完成后，其在设备上产生的数据库文件及临时文件也会被移除。 211 > 212 > - 错误码的详细介绍请参见[通用错误码](../reference/errorcode-universal.md)和[关系型数据库错误码](../reference/apis-arkdata/errorcode-data-rdb.md)。 213 2142. 获取到RdbStore，完成数据表创建后，调用insert()接口插入数据。示例代码如下所示： 215 216 ```ts 217 let store: relationalStore.RdbStore | undefined = undefined; 218 219 let value1 = 'Lisa'; 220 let value2 = 18; 221 let value3 = 100.5; 222 let value4 = new Uint8Array([1, 2, 3, 4, 5]); 223 let value5 = BigInt('15822401018187971961171'); 224 // 以下三种方式可用 225 const valueBucket1: relationalStore.ValuesBucket = { 226 'NAME': value1, 227 'AGE': value2, 228 'SALARY': value3, 229 'CODES': value4, 230 'IDENTITY': value5, 231 }; 232 const valueBucket2: relationalStore.ValuesBucket = { 233 NAME: value1, 234 AGE: value2, 235 SALARY: value3, 236 CODES: value4, 237 IDENTITY: value5, 238 }; 239 const valueBucket3: relationalStore.ValuesBucket = { 240 "NAME": value1, 241 "AGE": value2, 242 "SALARY": value3, 243 "CODES": value4, 244 "IDENTITY": value5, 245 }; 246 247 if (store !== undefined) { 248 (store as relationalStore.RdbStore).insert('EMPLOYEE', valueBucket1, (err: BusinessError, rowId: number) => { 249 if (err) { 250 console.error(`Failed to insert data. Code:${err.code}, message:${err.message}`); 251 return; 252 } 253 console.info(`Succeeded in inserting data. rowId:${rowId}`); 254 }) 255 } 256 ``` 257 258 > **说明：** 259 > 260 > 关系型数据库没有显式的flush操作实现持久化，数据插入即保存在持久化文件。 261 2623. 根据谓词指定的实例对象，对数据进行修改或删除。 263 264 调用update()方法修改数据，调用delete()方法删除数据。示例代码如下所示： 265 266 ```ts 267 let value6 = 'Rose'; 268 let value7 = 22; 269 let value8 = 200.5; 270 let value9 = new Uint8Array([1, 2, 3, 4, 5]); 271 let value10 = BigInt('15822401018187971967863'); 272 // 以下三种方式可用 273 const valueBucket4: relationalStore.ValuesBucket = { 274 'NAME': value6, 275 'AGE': value7, 276 'SALARY': value8, 277 'CODES': value9, 278 'IDENTITY': value10, 279 }; 280 const valueBucket5: relationalStore.ValuesBucket = { 281 NAME: value6, 282 AGE: value7, 283 SALARY: value8, 284 CODES: value9, 285 IDENTITY: value10, 286 }; 287 const valueBucket6: relationalStore.ValuesBucket = { 288 "NAME": value6, 289 "AGE": value7, 290 "SALARY": value8, 291 "CODES": value9, 292 "IDENTITY": value10, 293 }; 294 295 // 修改数据 296 let predicates1 = new relationalStore.RdbPredicates('EMPLOYEE'); // 创建表'EMPLOYEE'的predicates 297 predicates1.equalTo('NAME', 'Lisa'); // 匹配表'EMPLOYEE'中'NAME'为'Lisa'的字段 298 if (store !== undefined) { 299 (store as relationalStore.RdbStore).update(valueBucket4, predicates1, (err: BusinessError, rows: number) => { 300 if (err) { 301 console.error(`Failed to update data. Code:${err.code}, message:${err.message}`); 302 return; 303 } 304 console.info(`Succeeded in updating data. row count: ${rows}`); 305 }) 306 } 307 308 // 删除数据 309 predicates1 = new relationalStore.RdbPredicates('EMPLOYEE'); 310 predicates1.equalTo('NAME', 'Lisa'); 311 if (store !== undefined) { 312 (store as relationalStore.RdbStore).delete(predicates1, (err: BusinessError, rows: number) => { 313 if (err) { 314 console.error(`Failed to delete data. Code:${err.code}, message:${err.message}`); 315 return; 316 } 317 console.info(`Delete rows: ${rows}`); 318 }) 319 } 320 ``` 321 3224. 根据谓词指定的查询条件查找数据。 323 324 调用query()方法查找数据，返回一个ResultSet结果集。示例代码如下所示： 325 326 ```ts 327 let predicates2 = new relationalStore.RdbPredicates('EMPLOYEE'); 328 predicates2.equalTo('NAME', 'Rose'); 329 if (store !== undefined) { 330 (store as relationalStore.RdbStore).query(predicates2, ['ID', 'NAME', 'AGE', 'SALARY', 'IDENTITY'], (err: BusinessError, resultSet) => { 331 if (err) { 332 console.error(`Failed to query data. Code:${err.code}, message:${err.message}`); 333 return; 334 } 335 console.info(`ResultSet column names: ${resultSet.columnNames}, column count: ${resultSet.columnCount}`); 336 // resultSet是一个数据集合的游标，默认指向第-1个记录，有效的数据从0开始。 337 while (resultSet.goToNextRow()) { 338 const id = resultSet.getLong(resultSet.getColumnIndex('ID')); 339 const name = resultSet.getString(resultSet.getColumnIndex('NAME')); 340 const age = resultSet.getLong(resultSet.getColumnIndex('AGE')); 341 const salary = resultSet.getDouble(resultSet.getColumnIndex('SALARY')); 342 const identity = resultSet.getValue(resultSet.getColumnIndex('IDENTITY')); 343 console.info(`id=${id}, name=${name}, age=${age}, salary=${salary}, identity=${identity}`); 344 } 345 // 释放数据集的内存 346 resultSet.close(); 347 }) 348 } 349 ``` 350 351 > **说明：** 352 > 353 > 当应用完成查询数据操作，不再使用结果集（ResultSet）时，请及时调用close方法关闭结果集，释放系统为其分配的内存。 354 355 当前RDB还支持进行FTS全文检索，可以根据中文或者英文进行文本检索，针对中文分词器支持ICU分词器。 356 357 以中文关键字检索为例： 358 359 ```ts 360 let store: relationalStore.RdbStore | undefined = undefined; 361 if (store !== undefined) { 362 // 创建全文检索表 363 const SQL_CREATE_TABLE = "CREATE VIRTUAL TABLE example USING fts4(name, content, tokenize=icu zh_CN)"; 364 (store as relationalStore.RdbStore).executeSql(SQL_CREATE_TABLE, (err: BusinessError) => { 365 if (err) { 366 console.error(`Failed to creating fts table.`); 367 return; 368 } 369 console.info(`Succeeded in creating fts table.`); 370 }) 371 } 372 if(store != undefined) { 373 (store as relationalStore.RdbStore).querySql("SELECT name FROM example WHERE example MATCH '测试'", (err, resultSet) => { 374 if (err) { 375 console.error(`Query failed.`); 376 return; 377 } 378 while (resultSet.goToNextRow()) { 379 const name = resultSet.getString(resultSet.getColumnIndex("name")); 380 console.info(`name=${name}`); 381 } 382 resultSet.close(); 383 }) 384 } 385 ``` 386 3875. 在同路径下备份数据库。关系型数据库支持两种手动备份和自动备份（仅系统应用可用）两种方式，具体可见[关系型数据库备份](data-backup-and-restore.md#关系型数据库备份)。 388 389 此处以手动备份为例： 390 391 ```ts 392 if (store !== undefined) { 393 // "Backup.db"为备份数据库文件名，默认在RdbStore同路径下备份。也可指定路径：customDir + "backup.db" 394 (store as relationalStore.RdbStore).backup("Backup.db", (err: BusinessError) => { 395 if (err) { 396 console.error(`Failed to backup RdbStore. Code:${err.code}, message:${err.message}`); 397 return; 398 } 399 console.info(`Succeeded in backing up RdbStore.`); 400 }) 401 } 402 ``` 403 4046. 从备份数据库中恢复数据。关系型数据库支持两种方式：恢复手动备份数据和恢复自动备份数据（仅系统应用可用），具体可见[关系型数据库数据恢复](data-backup-and-restore.md#关系型数据库数据恢复)。 405 406 此处以调用[restore](../reference/apis-arkdata/js-apis-data-relationalStore.md#restore)接口恢复手动备份数据为例： 407 408 ```ts 409 if (store !== undefined) { 410 (store as relationalStore.RdbStore).restore("Backup.db", (err: BusinessError) => { 411 if (err) { 412 console.error(`Failed to restore RdbStore. Code:${err.code}, message:${err.message}`); 413 return; 414 } 415 console.info(`Succeeded in restoring RdbStore.`); 416 }) 417 } 418 ``` 419 4207. 删除数据库。 421 422 调用deleteRdbStore()方法，删除数据库及数据库相关文件。示例代码如下： 423 424 Stage模型示例： 425 426 ```ts 427 relationalStore.deleteRdbStore(this.context, 'RdbTest.db', (err: BusinessError) => { 428 if (err) { 429 console.error(`Failed to delete RdbStore. Code:${err.code}, message:${err.message}`); 430 return; 431 } 432 console.info('Succeeded in deleting RdbStore.'); 433 }); 434 ``` 435 436 FA模型示例： 437 438 ```ts 439 relationalStore.deleteRdbStore(context, 'RdbTest.db', (err: BusinessError) => { 440 if (err) { 441 console.error(`Failed to delete RdbStore. Code:${err.code}, message:${err.message}`); 442 return; 443 } 444 console.info('Succeeded in deleting RdbStore.'); 445 }); 446 ``` 447 448## 相关实例 449 450针对关系型数据库的开发，有以下相关实例可供参考： 451 452- [`Rdb`：关系型数据库（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/Data/Rdb) 453
