关系型数据库开发指导


关系型数据库开发指导

场景介绍

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

接口说明

数据库的创建和删除

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

表1 数据库创建和删除API

接口名 描述
getRdbStore(config: StoreConfig, version: number, callback: AsyncCallback<RdbStore>): void 获得一个相关的RdbStore,操作关系型数据库,用户可以根据自己的需求配置RdbStore的参数,然后通过RdbStore调用相关接口可以执行相关的数据操作,结果以callback形式返回。
- config:与此RDB存储相关的数据库配置。
- version:数据库版本。
- callback:指定callback回调函数。返回一个RdbStore。
getRdbStore(config: StoreConfig, version: number): Promise<RdbStore> 获得一个相关的RdbStore,操作关系型数据库,用户可以根据自己的需求配置RdbStore的参数,然后通过RdbStore调用相关接口可以执行相关的数据操作,结果以Promise形式返回。
- config:与此RDB存储相关的数据库配置。
- version:数据库版本。
deleteRdbStore(name: string, callback: AsyncCallback<void>): void 删除数据库,结果以callback形式返回。
- name:数据库名称。
- callback:指定callback回调函数。
deleteRdbStore(name: string): Promise<void> 使用指定的数据库文件配置删除数据库,结果以Promise形式返回。
- name:数据库名称。

数据库的增删改查

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

  • 新增

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

    表2 数据库插入API

    类名 接口名 描述
    RdbStore insert(name: string, values: ValuesBucket, callback: AsyncCallback<number>):void 向目标表中插入一行数据,结果以callback形式返回。
    - name:指定的目标表名。
    - values:表示要插入到表中的数据行。
    - callback:指定callback回调函数。如果操作成功,返回行ID;否则返回-1。
    RdbStore insert(name: string, values: ValuesBucket): Promise<number> 向目标表中插入一行数据,结果以Promise形式返回。
    - name:指定的目标表名。
    - values:表示要插入到表中的数据行。
  • 更新

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

    表3 数据库更新API

    类名 接口名 描述
    RdbStore update(values: ValuesBucket, rdbPredicates: RdbPredicates, callback: AsyncCallback<number>):void 根据RdbPredicates的指定实例对象更新数据库中的数据,结果以callback形式返回。
    - values:以ValuesBucket存储的要更新的数据。
    - rdbPredicates:表示RdbPredicates的实例对象指定的更新条件。
    - callback:指定的callback回调方法。返回受影响的行数。
    RdbStore update(values: ValuesBucket, rdbPredicates: RdbPredicates): Promise 根据RdbPredicates的指定实例对象更新数据库中的数据,结果以Promise形式返回。
    - values:以ValuesBucket存储的要更新的数据。
    - rdbPredicates:表示RdbPredicates的实例对象指定的更新条件。
  • 删除

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

    表4 数据库删除API

    类名 接口名 描述
    RdbStore delete(rdbPredicates: RdbPredicates, callback: AsyncCallback<number>):void 根据rdbPredicates的指定实例对象从数据库中删除数据,结果以callback形式返回。
    - rdbPredicates:RdbPredicates的实例对象指定的删除条件。
    - callback:指定callback回调函数。返回受影响的行数。
    RdbStore delete(rdbPredicates: RdbPredicates): Promise 根据rdbPredicates的指定实例对象从数据库中删除数据,结果以Promise形式返回。
    - rdbPredicates:RdbPredicates的实例对象指定的删除条件。
  • 查询

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

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

    表5 数据库查询API

    类名 接口名 描述
    RdbStore query(rdbPredicates: RdbPredicates, columns: Array, callback: AsyncCallback<ResultSet>): void 根据指定条件查询数据库中的数据,结果以callback形式返回。
    - rdbPredicates:表示RdbPredicates的实例对象指定的查询条件。
    - columns:表示要查询的列。如果值为空,则查询应用于所有列。
    - callback:指定callback回调函数。如果操作成功,则返回ResultSet对象。
    RdbStore query(rdbPredicates: RdbPredicates, columns: Array): Promise<ResultSet> 根据指定条件查询数据库中的数据,结果以Promise形式返回。
    - rdbPredicates:表示RdbPredicates的实例对象指定的查询条件。
    - columns:表示要查询的列。如果值为空,则查询应用于所有列。
    RdbStore querySql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallback<ResultSet>):void 根据指定SQL语句查询数据库中的数据,结果以callback形式返回。
    - sql:指定要查询的SQL语句。
    - bindArgs:SQL语句中参数的值。
    - callback:指定callback回调函数。如果操作成功,则返回ResultSet对象。
    RdbStore querySql(sql: string, bindArgs?: Array<ValueType>):Promise<ResultSet> 根据指定SQL语句查询数据库中的数据,结果以Promise形式返回。
    - sql:指定要查询的SQL语句。
    - bindArgs:SQL语句中参数的值。

数据库谓词的使用

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

表6 数据库谓词API

类名 接口名 描述
RdbPredicates inDevices(devices: Array): RdbPredicates 同步分布式数据库时指定组网内的远程设备。
- devices:组网内指定的远程设备ID。
- RdbPredicates:返回与指定字段匹配的谓词。
RdbPredicates inAllDevices(): RdbPredicates 同步分布式数据库时连接到组网内的所有远程设备。
- RdbPredicates:返回与指定字段匹配的谓词。
RdbPredicates equalTo(field: string, value: ValueType): RdbPredicates 配置谓词以匹配数据字段为ValueType且值等于指定值的字段。
- field:数据库表中的列名。
- value:指示要与谓词匹配的值。
- RdbPredicates:返回与指定字段匹配的谓词。
RdbPredicates notEqualTo(field: string, value: ValueType): RdbPredicates 配置谓词以匹配数据字段为ValueType且值不等于指定值的字段。
- field:数据库表中的列名。
- value:指示要与谓词匹配的值。
- RdbPredicates:返回与指定字段匹配的谓词。
RdbPredicates beginWrap(): RdbPredicates 向谓词添加左括号。
- RdbPredicates:返回带有左括号的谓词。
RdbPredicates endWrap(): RdbPredicates 向谓词添加右括号。
- RdbPredicates:返回带有右括号的谓词。
RdbPredicates or(): RdbPredicates 将或条件添加到谓词中。
- RdbPredicates:返回带有或条件的谓词。
RdbPredicates and(): RdbPredicates 向谓词添加和条件。
- RdbPredicates:返回带有和条件的谓词。
RdbPredicates contains(field: string, value: string): RdbPredicats 配置谓词以匹配数据字段为String且value包含指定值的字段。
- field:数据库表中的列名。
- value:指示要与谓词匹配的值。
- RdbPredicates:返回带有包含条件的谓词。
RdbPredicates beginsWith(field: string, value: string): RdbPredicates 配置谓词以匹配数据字段为String且值以指定字符串开头的字段。
- field:数据库表中的列名。
- value:指示要与谓词匹配的值。
- RdbPredicates:返回与指定字段匹配的谓词。
RdbPredicates endsWith(field: string, value: string): RdbPredicates 配置谓词以匹配数据字段为String且值以指定字符串结尾的字段。
- field:数据库表中的列名。
- value:指示要与谓词匹配的值。
- RdbPredicates:返回与指定字段匹配的谓词。
RdbPredicates isNull(field: string): RdbPredicates 配置谓词以匹配值为null的字段。
- field:数据库表中的列名。
- RdbPredicates:返回与指定字段匹配的谓词。
RdbPredicates isNotNull(field: string): RdbPredicates 配置谓词以匹配值不为null的指定字段。
- field:数据库表中的列名。
- RdbPredicates:返回与指定字段匹配的谓词。
RdbPredicates like(field: string, value: string): RdbPredicates 配置谓词以匹配数据字段为String且值类似于指定字符串的字段。
- field:数据库表中的列名。
- value:指示要与谓词匹配的值。
- RdbPredicates:返回与指定字段匹配的谓词。
RdbPredicates glob(field: string, value: string): RdbPredicates 配置RdbPredicates匹配数据字段为String的指定字段。
- field:数据库表中的列名。
- value:指示要与谓词匹配的值。
- RdbPredicates:返回与指定字段匹配的谓词。
RdbPredicates between(field: string, low: ValueType, high: ValueType): RdbPredicates 将谓词配置为匹配数据字段为ValueType且value在给定范围内的指定字段。
- field:数据库表中的列名。
- low:指示与谓词匹配的最小值。
- high:指示与谓词匹配的最大值。
- RdbPredicates:返回与指定字段匹配的谓词。
RdbPredicates notBetween(field: string, low: ValueType, high: ValueType): RdbPredicates 配置RdbPredicates以匹配数据字段为ValueType且value超出给定范围的指定字段。
- field:数据库表中的列名。
- low:指示与谓词匹配的最小值。
- high:指示与谓词匹配的最大值。
- RdbPredicates:返回与指定字段匹配的谓词。
RdbPredicates greaterThan(field: string, value: ValueType): RdbPredicatesgr 配置谓词以匹配数据字段为ValueType且值大于指定值的字段。
- field:数据库表中的列名。
- value:指示要与谓词匹配的值。
- RdbPredicates:返回与指定字段匹配的谓词。
RdbPredicates lessThan(field: string, value: ValueType): RdbPredicates 配置谓词以匹配数据字段为valueType且value小于指定值的字段。
- field:数据库表中的列名。
- value:指示要与谓词匹配的值。
- RdbPredicates:返回与指定字段匹配的谓词。
RdbPredicates greaterThanOrEqualTo(field: string, value: ValueType): RdbPredicates 配置谓词以匹配数据字段为ValueType且value大于或等于指定值的字段。
- field:数据库表中的列名。
- value:指示要与谓词匹配的值。
- RdbPredicates:返回与指定字段匹配的谓词。
RdbPredicates lessThanOrEqualTo(field: string, value: ValueType): RdbPredicates 配置谓词以匹配数据字段为ValueType且value小于或等于指定值的字段。
- field:数据库表中的列名。
- value:指示要与谓词匹配的值。
- RdbPredicates:返回与指定字段匹配的谓词。
RdbPredicates orderByAsc(field: string): RdbPredicates 配置谓词以匹配其值按升序排序的列。
- field:数据库表中的列名。
- RdbPredicates:返回与指定字段匹配的谓词。
RdbPredicates orderByDesc(field: string): RdbPredicates 配置谓词以匹配其值按降序排序的列。
- field:数据库表中的列名。
- RdbPredicates:返回与指定字段匹配的谓词。
RdbPredicates distinct(): RdbPredicates 配置谓词以过滤重复记录并仅保留其中一个。
- RdbPredicates:返回可用于过滤重复记录的谓词。
RdbPredicates limitAs(value: number): RdbPredicates 设置最大数据记录数的谓词。
- value:最大数据记录数。
- RdbPredicates:返回可用于设置最大数据记录数的谓词。
RdbPredicates offsetAs(rowOffset: number): RdbPredicates 配置RdbPredicates以指定返回结果的起始位置。
- rowOffset:返回结果的起始位置,取值为正整数。
- RdbPredicates:返回具有指定返回结果起始位置的谓词。
RdbPredicates groupBy(fields: Array<string>): RdbPredicates 配置RdbPredicates按指定列分组查询结果。
- fields:指定分组依赖的列名。
- RdbPredicates:返回分组查询列的谓词。
RdbPredicates indexedBy(indexName: string): RdbPredicates 配置RdbPredicates以指定索引列。
- indexName:索引列的名称。
- RdbPredicates:返回具有指定索引列的RdbPredicates。
RdbPredicates in(field: string, value: Array<ValueType>): RdbPredicates 配置RdbPredicates以匹配数据字段为ValueType数组且值在给定范围内的指定字段。
- field:数据库表中的列名。
- value:以ValueType型数组形式指定的要匹配的值。
- RdbPredicates:返回与指定字段匹配的谓词。
RdbPredicates notIn(field: string, value: Array<ValueType>): RdbPredicates 将RdbPredicates配置为匹配数据字段为ValueType且值超出给定范围的指定字段。
- field:数据库表中的列名。
- value:以ValueType型数组形式指定的要匹配的值。
- RdbPredicates:返回与指定字段匹配的谓词。

查询结果集的使用

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

icon-notice.gif 须知: 结果集使用完后,请一定要调用close方法显式关闭。

表7 结果集API

类名 接口名 描述
ResultSet goTo(offset:number): boolean 从结果集当前位置移动指定偏移量。
ResultSet goToRow(position: number): boolean 将结果集移动到指定位置。
ResultSet goToNextRow(): boolean 将结果集向后移动一行。
ResultSet goToPreviousRow(): boolean 将结果集向前移动一行。
ResultSet getColumnIndex(columnName: string): number 根据指定的列名获取列索引。
ResultSet getColumnName(columnIndex: number): string 根据指定的列索引获取列名。
ResultSet goToFirstRow(): boolean 判断结果集当前位置是否在第一行。
ResultSet goToLastRow(): boolean 判断结果集当前位置是否在最后一行。
ResultSet getString(columnIndex: number): string 获取当前行指定列的值,以String类型返回。
ResultSet getBlob(columnIndex: number): Uint8Array 获取当前行指定列的值,以字节数组形式返回。
ResultSet getDouble(columnIndex: number): number 获取当前行指定列的值,以double型返回。
ResultSet isColumnNull(columnIndex: number): boolean 检查当前行中指定列的值是否为null。
ResultSet close(): void 关闭结果集。

设置分布式列表

设置分布式列表

表8 设置分布式列表

类名 接口名 描述
RdbStore setDistributedTables(tables: Array, callback: AsyncCallback): void; 设置分布式列表,结果以callback形式返回。
- tables:要设置的分布式列表表名。
- callback:指定callback回调函数。
RdbStore setDistributedTables(tables: Array): Promise; 设置分布式列表,结果以Promise形式返回。
- tables:要设置的分布式列表表名。

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

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

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

类名 接口名 描述
RdbStore obtainDistributedTableName(device: string, table: string, callback: AsyncCallback): void; 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时,需要使用分布式表名, 结果以callbck形式返回。
- device:远程设备。
- table:本地表名。
- callback:指定的callback回调函数,如果操作成功,返回远程设备的分布式表名。
RdbStore obtainDistributedTableName(device: string, table: string): Promise; 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时,需要使用分布式表名,结果以Promise形式返回。
- device:远程设备。
- table:本地表名。

在设备之间同步数据

表10 在设备之间同步数据

类名 接口名 描述
RdbStore sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback<Array<[string, number]>>): void; 在设备之间同步数据,结果以callback形式返回。
- mode:指同步模式。SYNC_MODE_PUSH 表示数据从本地设备推送到远程设备;SYNC_MODE_PULL 表示数据从远程设备拉至本地设备。
- predicates:约束同步数据和设备。
- callback:指定的callback回调函数,string:设备ID;number:每个设备同步状态,0表示成功,其他值表示失败。
RdbStore sync(mode: SyncMode, predicates: RdbPredicates): Promise<Array<[string, number]>>; 在设备之间同步数据,结果以Promise形式返回。
- mode:指同步模式。SYNC_MODE_PUSH 表示数据从本地设备推送到远程设备;SYNC_MODE_PULL 表示数据从远程设备拉至本地设备。
- predicates:约束同步数据和设备。

注册数据库的观察者

表11 注册数据库的观察者

类名 接口名 描述
RdbStore on(event: 'dataChange', type: SubscribeType, observer: Callback<Array>): void; 注册数据库的观察者。当分布式数据库中的数据发生更改时,将调用回调。
- type:指在{@code SubscribeType}中定义的订阅类型;SUBSCRIBE_TYPE_REMOTE 订阅远程数据更改。
- observer:指分布式数据库中数据更改事件的观察者。

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

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

类名 接口名 描述
RdbStore off(event:'dataChange', type: SubscribeType, observer: Callback<Array>): void; 从数据库中删除指定类型的指定观察者,结果以callbck形式返回。。
- type:指在{@code SubscribeType}中定义的订阅类型;SUBSCRIBE_TYPE_REMOTE 订阅远程数据更改。
- observer:指已注册的数据更改观察者。

开发步骤

  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(SQL_CREATE_TABLE)
        console.info('create table done.')
    })
    
    1
    2
    3
    4
    5
    6
    7
    8
  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)
    
    1
    2
    3
  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()
    })
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
  4. 设置分布式同步表。

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

    示例代码如下:

    let promise = rdbStore.setDistributedTables(["test"])
    promise.then(() => {
        console.info("setDistributedTables success.")
    }).catch((err) => {
        console.info("setDistributedTables failed.")
    })
    
    1
    2
    3
    4
    5
    6
  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')
    })
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
  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')
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
  7. 跨设备查询。

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

    示例代码如下:

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

相关实例

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