HarmonyOS的关系型数据库,实现增删改查!

270 阅读5分钟

@ohos.data.relationalStore (关系型数据库)

关系型数据库(Relational Database,RDB)是一种基于关系模型来管理数据的数据库。关系型数据库基于SQLite组件提供了一套完整的对本地数据库进行管理的机制,对外提供了一系列的增、删、改、查等接口,也可以直接运行用户输入的SQL语句来满足复杂的场景需要。 不支持Sendable跨线程传递。 为保证插入并读取数据成功,建议一条数据不要超过2M。超出该大小,插入成功,读取失败。参考文档

  • RdbPredicates: 数据库中用来代表数据实体的性质、特征或者数据实体之间关系的词项主要用来定义数据库的操作条件。
  • RdbStore提供管理关系数据库(RDB)方法的接口
  • ResultSet:提供用户调用关系型数据库查询接口之后返回的结果集合

接口说明

以下是关系型数据库持久化功能的相关接口,大部分为异步接口。

异步接口均有 callback 和 Promise 两种返回形式

接口名称描述大白话
getRdbStore获得一个相关的RdbStore,操作关系型数据库,用户可以根据自己的需求配置RdbStore的参数,然后通过RdbStore调用相关接口可以执行相关的数据操作。新建文件(已存在时为打开)
executeSql执行包含指定参数但不返回值的SQL语句。建表
insert向目标表中插入一行数据。数据
update根据RdbPredicates的指定实例对象更新数据库中的数据。数据
delete根据RdbPredicates的指定实例对象从数据库中删除数据。数据
query根据指定条件查询数据库中的数据。数据
deleteRdbStore删除数据库。删除文件

实际操作步骤

  1. 准备一个对象,用来描述表的字段
interface user {
  id: number | null  // 新增时设置 id 为空值 null,用于自增 id
  name: string      // 姓名
  preference: string    // 爱好
  createDate: number // 创建日期,存时间戳
}
  1. 初始化数据库:relationalStore.getRdbStore(context: Context, config: StoreConfig)
参数名类型必填说明
contextContext应用的上下文。 FA模型的应用Context定义见Context。 Stage模型的应用Context定义见Context
configStoreConfig与此RDB存储相关的数据库配置。
//创建一个名称为test.db安全等级为S1的数据库
const store = await relationalStore.getRdbStore(getContext(), {
      name: 'test.db', // 数据库名称
      securityLevel: relationalStore.SecurityLevel.S1 // 安全等级
})
  1. 建表:executeSql(sql:string),不会写SQL的可以用AI生成一下
//根据第一步准备的对象
let createSQL = 'CREATE TABLE IF NOT EXISTS user ( //如果不存在user表的话则创建
        id INTEGER PRIMARY KEY AUTOINCREMENT, //主键id类型为integer(number),自增
        name TEXT NOT NULL,  //类型为TEXT(string),不能为空
        preference TEXT NOT NULL,  //类型为TEXT(string),不能为空
        createDate INTEGER NOT NULL //类型为integer(number),不能为空
      )'
// 执行创建语句,用于创建数据库的表
store.executeSql(createSQL)
  1. 新增数据: insert(table: string, values: ValuesBucket, callback: AsyncCallback):void

向目标表中插入一行数据,使用callback异步回调。由于共享内存大小限制为2Mb,因此单条数据的大小需小于2Mb,否则会查询失败。

参数名类型必填说明
tablestring指定的目标表名。
valuesValuesBucket表示要插入到表中的数据行。
callbackAsyncCallback指定callback回调函数。如果操作成功,返回行ID;否则返回-1。
let user: user = {
 id: null,
 name: 'insert',
 preference: '遥遥领先',
 createDate: Date.now()
}
async insert(item: user) {
   const store = await relationalStore.getRdbStore(getContext(), {
         name: 'test.db', // 数据库名称
         securityLevel: relationalStore.SecurityLevel.S1 // 安全等级
   })
     return store.insert('user', item)
}
  1. 准备谓词 RdbPredicates,查询、修改、删除需要。
  • RdbPredicates:表示关系型数据库(RDB)的谓词,主要用来定义数据库的操作条件。
  • RdbPredicates 为构造函数类,需要通过 new 关键词创建类的实例,参数为 数据库表名
const predicates = new relationalStore.RdbPredicates('user')
  1. 查询query

query(predicates: RdbPredicates, columns?: Array<string>):Promise<ResultSet>

根据指定条件查询数据库中的数据,使用Promise异步回调。由于共享内存大小限制为2Mb,因此单条数据的大小需小于2Mb,否则会查询失败。

参数名类型必填说明
predicatesRdbPredicatesRdbPredicates的实例对象指定的查询条件。
columnsArray表示要查询的列。如果值为空,则查询应用于所有列。

结果集Promise<ResultSet> 提供通过查询数据库生成的数据库结果集的访问方法。结果集是指用户调用关系型数据库查询接口之后返回的结果集合,提供了多种灵活的数据访问方式,以便用户获取各项数据。

// 查询
async query(id?: number) {
 const store = await relationalStore.getRdbStore(getContext(), {
     name: 'test.db', // 数据库名称
     securityLevel: relationalStore.SecurityLevel.S1 // 安全等级
  })
 const predicates = new relationalStore.RdbPredicates('user')
 // 倒序排列
 predicates.orderByDesc('id')
 // 如果有 id,添加 id 作为查询条件
 if (id) {
   predicates.equalTo('id', id)
 }
 const resultSet = await store.query(predicates)
 const list: user[] = []
 while (resultSet.goToNextRow()) {
   // 获取行数据
   const row = resultSet.getRow() as user
   // 追加到数组中
   list.push(row)
 }
 // 循环结束,释放结果集的内存空间(性能优化)
 resultSet.close()
 // 循环结束后,返回结果
 return list
}
  1. 根据id删除数据:delete

delete(predicates: RdbPredicates):Promise<number>

根据RdbPredicates的指定实例对象从数据库中删除数据,使用Promise异步回调。

// 删除
async delete(ids: number[]) {
 const store = await relationalStore.getRdbStore(getContext(), {
     name: 'test.db', // 数据库名称
     securityLevel: relationalStore.SecurityLevel.S1 // 安全等级
  })
 const predicates = new relationalStore.RdbPredicates('user')
 predicates.in('id', ids)
 // 删除完成,返回受影响的行数
 return store.delete(predicates)
}
  1. 根据 id 更新数据:update

update(values: ValuesBucket, predicates: RdbPredicates, conflict: ConflictResolution):Promise<number>

根据RdbPredicates的指定实例对象更新数据库中的数据,使用Promise异步回调。由于共享内存大小限制为2Mb,因此单条数据的大小需小于2Mb,否则会查询失败。

// 更新
async update(item: user) {
    if (!item.id) {
      return Promise.reject()
    }
    // 创建/打开数据库文件
    const store = await relationalStore.getRdbStore(getContext(), {
      name: 'test.db', // 数据库名称
      securityLevel: relationalStore.SecurityLevel.S1 // 安全等级
    })
    // 谓词条件
    const predicates = new relationalStore.RdbPredicates('user')
    // 匹配 id 用于更新
    predicates.equalTo('id', item.id)
    // 更新
    return store.update(value, predicates)
}