关系型数据库开发指导

场景介绍

关系型数据库是在SQLite基础上实现的本地数据操作机制，提供给用户无需编写原生SQL语句就能进行数据增删改查的方法，同时也支持原生SQL语句操作。

接口说明

以下是关系型数据库的常用接口说明，大部分为异步接口。异步接口均有callback和Promise两种返回形式，下表均以Promise形式为例，更多接口及使用方式请见关系型数据库。

数据库的创建和删除

关系型数据库提供了数据库创建方式，以及对应的删除接口，涉及的API如下所示。

表1 数据库创建和删除API

数据库的增删改查

关系型数据库提供对本地数据增删改查操作的能力，相关API如下所示。

• 新增

  关系型数据库提供了插入数据的接口，通过ValuesBucket输入要存储的数据，通过返回值判断是否插入成功，插入成功时返回最新插入数据所在的行号，失败时则返回-1。

  表2 数据库插入API

• 更新

  调用更新接口，传入要更新的数据，并通过RdbPredicates指定更新条件。该接口的返回值表示更新操作影响的行数。如果更新失败，则返回0。

  表3 数据库更新API

• 删除

  调用删除接口，通过RdbPredicates指定删除条件。该接口的返回值表示删除的数据行数，可根据此值判断是否删除成功。如果删除失败，则返回0。

  表4 数据库删除API

• 查询

  关系型数据库提供了两种查询数据的方式：

  • 直接调用查询接口。使用该接口，会将包含查询条件的谓词自动拼接成完整的SQL语句进行查询操作，无需用户传入原生的SQL语句。
  • 执行原生的SQL语句进行查询操作。

  表5 数据库查询API

数据库谓词的使用

关系型数据库提供了用于设置数据库操作条件的谓词RdbPredicates，该类确定RDB中条件表达式的值是true还是false。

以下列举几个常用谓词，更多谓词的使用请见关系型数据库谓词。

表6 数据库谓词API

查询结果集的使用

关系型数据库提供了查询返回的结果集ResultSet，其指向查询结果中的一行数据，供用户对查询结果进行遍历和访问。

更多结果集的接口使用，请见结果集。

须知： 结果集使用完后，请一定要调用close方法显式关闭。

表7 结果集API

设置分布式列表

设置分布式列表

表8 设置分布式列表

根据本地表名获取指定远程设备的分布式表名

用户根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名。

表9 根据本地表名获取指定远程设备的分布式表名

在设备之间同步数据

表10 在设备之间同步数据

注册数据库的观察者

表11 注册数据库的观察者

从数据库中删除指定类型的指定观察者

表12 从数据库中删除指定类型的指定观察者

开发步骤

1. 创建数据库。

   1. 配置数据库相关信息，包括数据库的名称、存储模式、是否为只读模式等。
   2. 初始化数据库表结构和相关数据。
   3. 创建数据库。

   示例代码如下：

   import data_rdb from '@ohos.data.rdb'
   
   const CREATE_TABLE_TEST = "CREATE TABLE IF NOT EXISTS test (" + "id INTEGER PRIMARY KEY AUTOINCREMENT, " + "name TEXT NOT NULL, " + "age INTEGER, " + "salary REAL, " + "blobType BLOB)";
   const STORE_CONFIG = {name: "rdbstore.db"}
   data_rdb.getRdbStore(STORE_CONFIG, 1, function (err, rdbStore) {
       rdbStore.executeSql(CREATE_TABLE_TEST )
       console.info('create table done.')
   })
   

2. 插入数据。

   1. 构造要插入的数据，以ValuesBucket形式存储。
   2. 调用关系型数据库提供的插入接口。

   示例代码如下：

   var u8 = new Uint8Array([1, 2, 3])
   const valueBucket = {"name": "Tom", "age": 18, "salary": 100.5, "blobType": u8}
   let insertPromise = rdbStore.insert("test", valueBucket)
   

3. 查询数据。

   1. 构造用于查询的谓词对象，设置查询条件。
   2. 调用查询接口查询数据。
   3. 调用结果集接口，返回查询结果。

   示例代码如下：

   let predicates = new data_rdb.RdbPredicates("test");
   predicates.equalTo("name", "Tom")
   let promisequery = rdbStore.query(predicates)
       promisequery.then((resultSet) => {
       resultSet.goToFirstRow()
       const id = resultSet.getLong(resultSet.getColumnIndex("id"))
       const name = resultSet.getString(resultSet.getColumnIndex("name"))
       const age = resultSet.getLong(resultSet.getColumnIndex("age"))
       const salary = resultSet.getDouble(resultSet.getColumnIndex("salary"))
       const blobType = resultSet.getBlob(resultSet.getColumnIndex("blobType"))
       resultSet.close()
   })
   

4. 设置分布式同步表。

   1. 数据库调用接口设置分布式同步列表。
   2. 判断是否设置成功。

   示例代码如下：

   let promise = rdbStore.setDistributedTables(["test"])
   promise.then(() => {
       console.info("setDistributedTables success.")
   }).catch((err) => {
       console.info("setDistributedTables failed.")
   })
   

5. 分布式数据同步。

   1. 构造用于同步分布式表的谓词对象，指定组网内的远程设备。
   2. 调用同步数据的接口 。
   3. 判断是否数据同步成功。

   示例代码如下：

   let predicate = new data_rdb.RdbPredicates('test')
   predicate.inDevices(['12345678abcde'])
   let promise = rdbStore.sync(rdb.SyncMode.SYNC_MODE_PUSH, predicate)
   promise.then((result) => {
       console.log('sync done.')
       for (let i = 0; i < result.length; i++) {
           console.log('device=' + result[i][0] + ' status=' + result[i][1])
       }
   }).catch((err) => {
       console.log('sync failed')
   })
   

6. 分布式数据订阅。

   1. 调用分布式数据订阅接口，注册数据库的观察者。
   2. 当分布式数据库中的数据发生更改时，将调用回调。

   示例代码如下：

   function storeObserver(devices) {
       for (let i = 0; i < devices.length; i++) {
           console.log('device=' + device[i] + ' data changed')
       }
   }
   try {
       rdbStore.on('dataChange', rdb.SubscribeType.SUBSCRIBE_TYPE_REMOTE, storeObserver)
   } catch (err) {
       console.log('register observer failed')
   }
   

7. 跨设备查询。

   1. 根据本地表名获取指定远程设备的分布式表名。
   2. 调用结果集接口，返回查询结果。

   示例代码如下：

   let tableName = rdbStore.obtainDistributedTableName(deviceId, "test");
   let resultSet = rdbStore.querySql("SELECT * FROM " + tableName)
   

相关实例

针对关系型数据库开发，有以下相关实例可供参考：

• Rdb：关系型数据库（eTS）（API8）
• DistributedRdb：分布式关系型数据库（eTS）（API8）（Full SDK）
• 关系型数据库（JS）（API8）