0
  • 聊天消息
  • 系统消息
  • 评论与回复
登录后你可以
  • 下载海量资料
  • 学习在线课程
  • 观看技术视频
  • 写文章/发帖/加入社区
会员中心
创作中心

完善资料让更多小伙伴认识你,还能领取20积分哦,立即完善>

3天内不再提示

鸿蒙开发接口数据管理:【@ohos.data.rdb (关系型数据库)】

jf_46214456 来源:jf_46214456 作者:jf_46214456 2024-06-10 18:35 次阅读

关系型数据库

关系型数据库(Relational Database,RDB)是一种基于关系模型来管理数据的数据库。关系型数据库基于SQLite组件提供了一套完整的对本地数据库进行管理的机制,对外提供了一系列的增、删、改、查等接口,也可以直接运行用户输入的SQL语句来满足复杂的场景需要。

该模块提供以下关系型数据库相关的常用功能:

  • [RdbPredicates]: 数据库中用来代表数据实体的性质、特征或者数据实体之间关系的词项,主要用来定义数据库的操作条件。
  • [RdbStore]:提供管理关系数据库(RDB)方法的接口。

说明:
开发前请熟悉鸿蒙开发指导文档 :[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]
本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import data_rdb from '@ohos.data.rdb';

data_rdb.getRdbStore

getRdbStore(context: Context, config: StoreConfig, version: number, callback: AsyncCallback): void

获得一个相关的RdbStore,操作关系型数据库,用户可以根据自己的需求配置RdbStore的参数,然后通过RdbStore调用相关接口可以执行相关的数据操作,结果以callback形式返回。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
contextContext应用的上下文。 FA模型的应用Context定义见[Context]。 Stage模型的应用Context定义见[Context]。
config[StoreConfig]与此RDB存储相关的数据库配置。
versionnumber数据库版本。
callbackAsyncCallback<[RdbStore]>指定callback回调函数,返回一个RdbStore。

示例:

const STORE_CONFIG = { name: "RdbTest.db"}
data_rdb.getRdbStore(this.context, STORE_CONFIG, 1, function (err, rdbStore) {
    if (err) {
        console.info("Get RdbStore failed, err: " + err)
        return
    }
    console.log("Get RdbStore successfully.")
})

data_rdb.getRdbStore

getRdbStore(context: Context, config: StoreConfig, version: number): Promise

获得一个相关的RdbStore,操作关系型数据库,用户可以根据自己的需求配置RdbStore的参数,然后通过RdbStore调用相关接口可以执行相关的数据操作,结果以Promise形式返回。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
contextContext应用的上下文。 FA模型的应用Context定义见[Context]。 Stage模型的应用Context定义见[Context]。
config[StoreConfig]与此RDB存储相关的数据库配置。
versionnumber数据库版本。

返回值

类型说明
Promise<[RdbStore]>指定Promise回调函数。返回一个RdbStore。

示例:

const STORE_CONFIG = { name: "RdbTest.db" }
let promise = data_rdb.getRdbStore(this.context, STORE_CONFIG, 1);
promise.then(async (rdbStore) = > {
    console.log("Get RdbStore successfully.")
}).catch((err) = > {
    console.log("Get RdbStore failed, err: " + err)
})

data_rdb.deleteRdbStore

deleteRdbStore(context: Context, name: string, callback: AsyncCallback): void

删除数据库,结果以callback形式返回。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
contextContext应用的上下文。 FA模型的应用Context定义见[Context]。 Stage模型的应用Context定义见[Context]。
namestring数据库名称。
callbackAsyncCallback指定callback回调函数。

示例:

data_rdb.deleteRdbStore(this.context, "RdbTest.db", function (err, rdbStore) {
    if (err) {
        console.info("Delete RdbStore failed, err: " + err)
        return
    }
    console.log("Delete RdbStore successfully.")
})

data_rdb.deleteRdbStore

deleteRdbStore(context: Context, name: string): Promise

使用指定的数据库文件配置删除数据库,结果以Promise形式返回。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数

参数名类型必填说明
contextContext应用的上下文。 FA模型的应用Context定义见[Context]。 Stage模型的应用Context定义见[Context]。
namestring数据库名称。

返回值

类型说明
Promise指定Promise回调函数。

示例:

let promise = data_rdb.deleteRdbStore(this.context, "RdbTest.db")
promise.then(()= >{
    console.log("Delete RdbStore successfully.")
}).catch((err) = > {
    console.info("Delete RdbStore failed, err: " + err)
})

RdbPredicates

表示关系型数据库(RDB)的谓词。该类确定RDB中条件表达式的值是true还是false。

constructor

constructor(name: string)

构造函数。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
namestring数据库表名。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")

inDevices8+

inDevices(devices: Array): RdbPredicates

同步分布式数据库时指定组网内的远程设备。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
devicesArray指定的组网内的远程设备ID。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.inDevices(['12345678abcde'])

inAllDevices8+

inAllDevices(): RdbPredicates

同步分布式数据库时连接到组网内的所有远程设备。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.inAllDevices()

equalTo

equalTo(field: string, value: ValueType): RdbPredicates

配置谓词以匹配数据字段为ValueType且值等于指定值的字段。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
value[ValueType]指示要与谓词匹配的值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "lisi")

notEqualTo

notEqualTo(field: string, value: ValueType): RdbPredicates

配置谓词以匹配数据字段为ValueType且值不等于指定值的字段。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
value[ValueType]指示要与谓词匹配的值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.notEqualTo("NAME", "lisi")

beginWrap

beginWrap(): RdbPredicates

向谓词添加左括号。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

返回值

类型说明
[RdbPredicates]返回带有左括号的Rdb谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "lisi")
    .beginWrap()
    .equalTo("AGE", 18)
    .or()
    .equalTo("SALARY", 200.5)
    .endWrap()

endWrap

endWrap(): RdbPredicates

向谓词添加右括号。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

返回值

类型说明
[RdbPredicates]返回带有右括号的Rdb谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "lisi")
    .beginWrap()
    .equalTo("AGE", 18)
    .or()
    .equalTo("SALARY", 200.5)
    .endWrap()

or

or(): RdbPredicates

将或条件添加到谓词中。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

返回值

类型说明
[RdbPredicates]返回带有或条件的Rdb谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa")
    .or()
    .equalTo("NAME", "Rose")

and

and(): RdbPredicates

向谓词添加和条件。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

返回值

类型说明
[RdbPredicates]返回带有和条件的Rdb谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa")
    .and()
    .equalTo("SALARY", 200.5)

contains

contains(field: string, value: string): RdbPredicates

配置谓词以匹配数据字段为string且value包含指定值的字段。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
valuestring指示要与谓词匹配的值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.contains("NAME", "os")

beginsWith

beginsWith(field: string, value: string): RdbPredicates

配置谓词以匹配数据字段为string且值以指定字符串开头的字段。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
valuestring指示要与谓词匹配的值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.beginsWith("NAME", "os")

endsWith

endsWith(field: string, value: string): RdbPredicates

配置谓词以匹配数据字段为string且值以指定字符串结尾的字段。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
valuestring指示要与谓词匹配的值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.endsWith("NAME", "se")

isNull

isNull(field: string): RdbPredicates

配置谓词以匹配值为null的字段。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。
  • 示例
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.isNull("NAME")

isNotNull

isNotNull(field: string): RdbPredicates

配置谓词以匹配值不为null的指定字段。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.isNotNull("NAME")

like

like(field: string, value: string): RdbPredicates

配置谓词以匹配数据字段为string且值类似于指定字符串的字段。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
valuestring指示要与谓词匹配的值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.like("NAME", "%os%")

glob

glob(field: string, value: string): RdbPredicates

配置RdbPredicates匹配数据字段为string的指定字段。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
valuestring指示要与谓词匹配的值。 支持通配符,*表示0个、1个或多个数字或字符,?表示1个数字或字符。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.glob("NAME", "?h*g")

between

between(field: string, low: ValueType, high: ValueType): RdbPredicates

将谓词配置为匹配数据字段为ValueType且value在给定范围内的指定字段。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
low[ValueType]指示与谓词匹配的最小值。
high[ValueType]指示要与谓词匹配的最大值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.between("AGE", 10, 50)

notBetween

notBetween(field: string, low: ValueType, high: ValueType): RdbPredicates

配置RdbPredicates以匹配数据字段为ValueType且value超出给定范围的指定字段。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
low[ValueType]指示与谓词匹配的最小值。
high[ValueType]指示要与谓词匹配的最大值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.notBetween("AGE", 10, 50)

greaterThan

greaterThan(field: string, value: ValueType): RdbPredicates

配置谓词以匹配数据字段为ValueType且值大于指定值的字段。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
value[ValueType]指示要与谓词匹配的值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.greaterThan("AGE", 18)

lessThan

lessThan(field: string, value: ValueType): RdbPredicates

配置谓词以匹配数据字段为valueType且value小于指定值的字段。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
value[ValueType]指示要与谓词匹配的值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.lessThan("AGE", 20)

greaterThanOrEqualTo

greaterThanOrEqualTo(field: string, value: ValueType): RdbPredicates

配置谓词以匹配数据字段为ValueType且value大于或等于指定值的字段。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
value[ValueType]指示要与谓词匹配的值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.greaterThanOrEqualTo("AGE", 18)

lessThanOrEqualTo

lessThanOrEqualTo(field: string, value: ValueType): RdbPredicates

配置谓词以匹配数据字段为ValueType且value小于或等于指定值的字段。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
value[ValueType]指示要与谓词匹配的值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.lessThanOrEqualTo("AGE", 20)

orderByAsc

orderByAsc(field: string): RdbPredicates

配置谓词以匹配其值按升序排序的列。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.orderByAsc("NAME")

orderByDesc

orderByDesc(field: string): RdbPredicates

配置谓词以匹配其值按降序排序的列。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.orderByDesc("AGE")

distinct

distinct(): RdbPredicates

配置谓词以过滤重复记录并仅保留其中一个。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

返回值

类型说明
[RdbPredicates]返回可用于过滤重复记录的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose").distinct("NAME")
let promise = rdbStore.query(predicates, ["NAME"])
promise.then((resultSet) = > {
    console.log("resultSet column names:" + resultSet.columnNames)
    console.log("resultSet column count:" + resultSet.columnCount)
}).catch((err) = > {
    console.log("query err.")
})

limitAs

limitAs(value: number): RdbPredicates

设置最大数据记录数的谓词。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
valuenumber最大数据记录数。

返回值

类型说明
[RdbPredicates]返回可用于设置最大数据记录数的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose").limitAs(3)

offsetAs

offsetAs(rowOffset: number): RdbPredicates

配置RdbPredicates以指定返回结果的起始位置。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
rowOffsetnumber返回结果的起始位置,取值为正整数。

返回值

类型说明
[RdbPredicates]返回具有指定返回结果起始位置的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose").offsetAs(3)

groupBy

groupBy(fields: Array): RdbPredicates

配置RdbPredicates按指定列分组查询结果。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldsArray指定分组依赖的列名。

返回值

类型说明
[RdbPredicates]返回分组查询列的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.groupBy(["AGE", "NAME"])

indexedBy

indexedBy(field: string): RdbPredicates

配置RdbPredicates以指定索引列。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring索引列的名称。

返回值

类型说明
[RdbPredicates]返回具有指定索引列的RdbPredicates。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.indexedBy("SALARY_INDEX")

in

in(field: string, value: Array): RdbPredicates

配置RdbPredicates以匹配数据字段为ValueType数组且值在给定范围内的指定字段。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
valueArray<[ValueType]>以ValueType型数组形式指定的要匹配的值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.in("AGE", [18, 20])

notIn

notIn(field: string, value: Array): RdbPredicates

将RdbPredicates配置为匹配数据字段为ValueType且值超出给定范围的指定字段。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
fieldstring数据库表中的列名。
valueArray<[ValueType]>以ValueType数组形式指定的要匹配的值。

返回值

类型说明
[RdbPredicates]返回与指定字段匹配的谓词。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.notIn("NAME", ["Lisa", "Rose"])

RdbStore

提供管理关系数据库(RDB)方法的接口。

insert

insert(table: string, values: ValuesBucket, callback: AsyncCallback):void

向目标表中插入一行数据,结果以callback形式返回。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
tablestring指定的目标表名。
values[ValuesBucket]表示要插入到表中的数据行。
callbackAsyncCallback指定callback回调函数。如果操作成功,返回行ID;否则返回-1。

示例:

const valueBucket = {
    "NAME": "Lisa",
    "AGE": 18,
    "SALARY": 100.5,
    "CODES": new Uint8Array([1, 2, 3, 4, 5]),
}
rdbStore.insert("EMPLOYEE", valueBucket, function (err, ret) {
    if (err) {
        console.info("Insert failed, err: " + err)
        return
    }
    console.log("Insert first done: " + ret)
})

insert

insert(table: string, values: ValuesBucket):Promise

向目标表中插入一行数据,结果以Promise形式返回。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
tablestring指定的目标表名。
values[ValuesBucket]表示要插入到表中的数据行。

返回值

类型说明
Promise指定Promise回调函数。如果操作成功,返回行ID;否则返回-1。

示例:

const valueBucket = {
    "NAME": "Lisa",
    "AGE": 18,
    "SALARY": 100.5,
    "CODES": new Uint8Array([1, 2, 3, 4, 5]),
}
let promise = rdbStore.insert("EMPLOYEE", valueBucket)
promise.then(async (ret) = > {
    console.log("Insert first done: " + ret)
}).catch((err) = > {
    console.log("Insert failed, err: " + err)
})

update

update(values: ValuesBucket, predicates: RdbPredicates, callback: AsyncCallback):void

根据RdbPredicates的指定实例对象更新数据库中的数据,结果以callback形式返回。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
values[ValuesBucket]values指示数据库中要更新的数据行。键值对与数据库表的列名相关联。
predicates[RdbPredicates]RdbPredicates的实例对象指定的更新条件。
callbackAsyncCallback指定的callback回调方法。返回受影响的行数。

示例:

const valueBucket = {
    "NAME": "Rose",
    "AGE": 22,
    "SALARY": 200.5,
    "CODES": new Uint8Array([1, 2, 3, 4, 5]),
}
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa")
rdbStore.update(valueBucket, predicates, function (err, ret) {
    if (err) {
        console.info("Updated failed, err: " + err)
        return
    }
    console.log("Updated row count: " + ret)
})

update

update(values: ValuesBucket, predicates: RdbPredicates):Promise

根据RdbPredicates的指定实例对象更新数据库中的数据,结果以Promise形式返回。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
values[ValuesBucket]values指示数据库中要更新的数据行。键值对与数据库表的列名相关联。
predicates[RdbPredicates]RdbPredicates的实例对象指定的更新条件。

返回值

类型说明
Promise指定的Promise回调方法。返回受影响的行数。

示例:

const valueBucket = {
    "NAME": "Rose",
    "AGE": 22,
    "SALARY": 200.5,
    "CODES": new Uint8Array([1, 2, 3, 4, 5]),
}
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa")
let promise = rdbStore.update(valueBucket, predicates)
promise.then(async (ret) = > {
    console.log("Updated row count: " + ret)
}).catch((err) = > {
    console.info("Updated failed, err: " + err)
})

delete

delete(predicates: RdbPredicates, callback: AsyncCallback):void

根据RdbPredicates的指定实例对象从数据库中删除数据,结果以callback形式返回。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
predicates[RdbPredicates]RdbPredicates的实例对象指定的删除条件。
callbackAsyncCallback指定callback回调函数。返回受影响的行数。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa")
rdbStore.delete(predicates, function (err, rows) {
    if (err) {
        console.info("Delete failed, err: " + err)
        return
    }
    console.log("Delete rows: " + rows)
})

delete

delete(predicates: RdbPredicates):Promise

根据RdbPredicates的指定实例对象从数据库中删除数据,结果以Promise形式返回。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
predicates[RdbPredicates]RdbPredicates的实例对象指定的删除条件。

返回值

类型说明
Promise指定Promise回调函数。返回受影响的行数。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Lisa")
let promise = rdbStore.delete(predicates)
promise.then((rows) = > {
    console.log("Delete rows: " + rows)
}).catch((err) = > {
    console.info("Delete failed, err: " + err)
})

query

query(predicates: RdbPredicates, columns: Array, callback: AsyncCallback):void

根据指定条件查询数据库中的数据,结果以callback形式返回。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
predicates[RdbPredicates]RdbPredicates的实例对象指定的查询条件。
columnsArray表示要查询的列。如果值为空,则查询应用于所有列。
callbackAsyncCallback<[ResultSet]>指定callback回调函数。如果操作成功,则返回ResultSet对象。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose")
rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"], function (err, resultSet) {
    if (err) {
        console.info("Query failed, err: " + err)
        return
    }
    console.log("ResultSet column names: " + resultSet.columnNames)
    console.log("ResultSet column count: " + resultSet.columnCount)
})

query

query(predicates: RdbPredicates, columns?: Array):Promise

根据指定条件查询数据库中的数据,结果以Promise形式返回。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

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

返回值

类型说明
Promise<[ResultSet]>指定Promise回调函数。如果操作成功,则返回ResultSet对象。

示例:

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose")
let promise = rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"])
promise.then((resultSet) = > {
    console.log("ResultSet column names: " + resultSet.columnNames)
    console.log("ResultSet column count: " + resultSet.columnCount)
}).catch((err) = > {
    console.info("Query failed, err: " + err)
})

querySql8+

querySql(sql: string, bindArgs: Array, callback: AsyncCallback):void

根据指定SQL语句查询数据库中的数据,结果以callback形式返回。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
sqlstring指定要执行的SQL语句。
bindArgsArray<[ValueType]>SQL语句中参数的值。
callbackAsyncCallback<[ResultSet]>指定callback回调函数。如果操作成功,则返回ResultSet对象。

示例:

rdbStore.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo'], function (err, resultSet) {
    if (err) {
        console.info("Query failed, err: " + err)
        return
    }
    console.log("ResultSet column names: " + resultSet.columnNames)
    console.log("ResultSet column count: " + resultSet.columnCount)
})

querySql8+

querySql(sql: string, bindArgs?: Array):Promise

根据指定SQL语句查询数据库中的数据,结果以Promise形式返回。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
sqlstring指定要执行的SQL语句。
bindArgsArray<[ValueType]>SQL语句中参数的值。

返回值

类型说明
Promise<[ResultSet]>指定Promise回调函数。如果操作成功,则返回ResultSet对象。

示例:

let promise = rdbStore.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo'])
promise.then((resultSet) = > {
    console.log("ResultSet column names: " + resultSet.columnNames)
    console.log("ResultSet column count: " + resultSet.columnCount)
}).catch((err) = > {
    console.info("Query failed, err: " + err)
})

executeSql

executeSql(sql: string, bindArgs: Array, callback: AsyncCallback):void

执行包含指定参数但不返回值的SQL语句,结果以callback形式返回。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
sqlstring指定要执行的SQL语句。
bindArgsArray<[ValueType]>SQL语句中参数的值。
callbackAsyncCallback指定callback回调函数。

示例:

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)"
rdbStore.executeSql(SQL_CREATE_TABLE, null, function(err) {
    if (err) {
        console.info("ExecuteSql failed, err: " + err)
        return
    }
    console.info('Create table done.')
})

executeSql

executeSql(sql: string, bindArgs?: Array):Promise

执行包含指定参数但不返回值的SQL语句,结果以Promise形式返回。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
sqlstring指定要执行的SQL语句。
bindArgsArray<[ValueType]>SQL语句中参数的值。

返回值

类型说明
Promise指定Promise回调函数。

示例:

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)"
let promise = rdbStore.executeSql(SQL_CREATE_TABLE)
promise.then(() = > {
    console.info('Create table done.')
}).catch((err) = > {
    console.info("ExecuteSql failed, err: " + err)
})

beginTransaction8+

beginTransaction():void

在开始执行SQL语句之前,开始事务。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

示例:

rdbStore.beginTransaction()
const valueBucket = {
    "name": "lisi",
    "age": 18,
    "salary": 100.5,
    "blobType": new Uint8Array([1, 2, 3]),
}
rdbStore.insert("test", valueBucket, function (err, ret) {
    if (err) {
        console.info("Insert failed, err: " + err)
        return
    }
    console.log("Insert successfully: " + ret)
})
rdbStore.commit()

commit8+

commit():void

提交已执行的SQL语句。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

示例:

rdbStore.beginTransaction()
const valueBucket = {
    "name": "lisi",
    "age": 18,
    "salary": 100.5,
    "blobType": new Uint8Array([1, 2, 3]),
}

rdbStore.insert("test", valueBucket, function (err, ret) {
    if (err) {
        console.info("Insert failed, err: " + err)
        return
    }
    console.log("Insert successfully: " + ret)
})
rdbStore.commit()

rollBack8+

rollBack():void;

回滚已经执行的SQL语句。

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

示例:

try {
    rdbStore.beginTransaction()
    const valueBucket = {
        "id": 1,
        "name": "lisi",
        "age": 18,
        "salary": 100.5,
        "blobType": new Uint8Array([1, 2, 3]),
    }
    rdbStore.insert("test", valueBucket, function (err, ret) {
        if (err) {
            console.info("Insert failed, err: " + err)
            return
        }
        console.log("Insert successfully: " + ret)
    })
    rdbStore.commit()
} catch (e) {
    rdbStore.rollBack()
}

setDistributedTables8+

setDistributedTables(tables: Array, callback: AsyncCallback): void

设置分布式列表,结果以callback形式返回。

需要权限: ohos.permission.DISTRIBUTED_DATASYNC

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
tablesArray要设置的分布式列表表名
callbackAsyncCallback指定callback回调函数。

示例:

rdbStore.setDistributedTables(["EMPLOYEE"], function (err) {
    if (err) {
        console.info('SetDistributedTables failed, err: ' + err)
        return
    }
    console.info('SetDistributedTables successfully.')
})

setDistributedTables8+

setDistributedTables(tables: Array): Promise

设置分布式列表,结果以Promise形式返回。

需要权限: ohos.permission.DISTRIBUTED_DATASYNC

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
tablesArray要设置的分布式列表表名。

返回值

类型说明
Promise指定Promise回调函数。

示例:

let promise = rdbStore.setDistributedTables(["EMPLOYEE"])
promise.then(() = > {
    console.info("SetDistributedTables successfully.")
}).catch((err) = > {
    console.info("SetDistributedTables failed, err: " + err)
})

obtainDistributedTableName8+

obtainDistributedTableName(device: string, table: string, callback: AsyncCallback): void

根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时,需要使用分布式表名, 结果以callback形式返回。

需要权限: ohos.permission.DISTRIBUTED_DATASYNC

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
devicestring远程设备 。
tablestring本地表名。
callbackAsyncCallback指定的callback回调函数。如果操作成功,返回远程设备的分布式表名。

示例:

rdbStore.obtainDistributedTableName("12345678abcde", "EMPLOYEE", function (err, tableName) {
    if (err) {
        console.info('ObtainDistributedTableName failed, err: ' + err)
        return
    }
    console.info('ObtainDistributedTableName successfully, tableName=' + tableName)
})

obtainDistributedTableName8+

obtainDistributedTableName(device: string, table: string): Promise

根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时,需要使用分布式表名,结果以Promise形式返回。

需要权限: ohos.permission.DISTRIBUTED_DATASYNC

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
devicestring远程设备。
tablestring本地表名。

返回值

类型说明
Promise指定Promise回调函数。如果操作成功,返回远程设备的分布式表名。

示例:

let promise = rdbStore.obtainDistributedTableName("12345678abcde", "EMPLOYEE")
promise.then((tableName) = > {
    console.info('ObtainDistributedTableName successfully, tableName=' + tableName)
}).catch((err) = > {
    console.info('ObtainDistributedTableName failed, err: ' + err)
})

sync8+

sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback>): void

在设备之间同步数据, 结果以callback形式返回。

需要权限: ohos.permission.DISTRIBUTED_DATASYNC

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
mode[SyncMode]指同步模式。该值可以是推、拉。
predicates[RdbPredicates]约束同步数据和设备。
callbackAsyncCallback>指定的callback回调函数,用于向调用者发送同步结果。string:设备ID;number:每个设备同步状态,0表示成功,其他值表示失败。

示例:

let predicates = new data_rdb.RdbPredicates('EMPLOYEE')
predicates.inDevices(['12345678abcde'])
rdbStore.sync(data_rdb.SyncMode.SYNC_MODE_PUSH, predicates, function (err, result) {
    if (err) {
        console.log('Sync failed, err: ' + err)
        return
    }
    console.log('Sync done.')
    for (let i = 0; i < result.length; i++) {
        console.log('device=' + result[i][0] + ' status=' + result[i][1])
    }
})

sync8+

sync(mode: SyncMode, predicates: RdbPredicates): Promise>

在设备之间同步数据,结果以Promise形式返回。

需要权限: ohos.permission.DISTRIBUTED_DATASYNC

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
mode[SyncMode]指同步模式。该值可以是推、拉。
predicates[RdbPredicates]约束同步数据和设备。

返回值

类型说明
Promise>指定Promise回调函数,用于向调用者发送同步结果。string:设备ID;number:每个设备同步状态,0表示成功,其他值表示失败。

示例:

let predicates = new data_rdb.RdbPredicates('EMPLOYEE')
predicates.inDevices(['12345678abcde'])
let promise = rdbStore.sync(data_rdb.SyncMode.SYNC_MODE_PUSH, predicates)
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')
})

on('dataChange')8+

on(event: 'dataChange', type: SubscribeType, observer: Callback>): void

注册数据库的观察者。当分布式数据库中的数据发生更改时,将调用回调。

需要权限: ohos.permission.DISTRIBUTED_DATASYNC

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
eventstring取值为'dataChange',表示数据更改。
type[SubscribeType]指在{@code SubscribeType}中定义的订阅类型。
observerCallback>指分布式数据库中数据更改事件的观察者。

示例:

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

off('dataChange')8+

off(event:'dataChange', type: SubscribeType, observer: Callback>): void

从数据库中删除指定类型的指定观察者, 结果以callback形式返回。

需要权限: ohos.permission.DISTRIBUTED_DATASYNC

系统能力: SystemCapability.DistributedDataManager.RelationalStore.Core。

参数:

参数名类型必填说明
eventstring取值为'dataChange',表示数据更改。
type[SubscribeType]指在{@code SubscribeType}中定义的订阅类型。
observerCallback>指已注册的数据更改观察者。

示例:

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

StoreConfig

管理关系数据库配置。

系统能力: 以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。

参数名类型必填说明
namestring数据库文件名。

ValueType

用于表示允许的数据字段类型。

系统能力: 以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。

名称说明
number表示值类型为数字。
string表示值类型为字符。
boolean表示值类型为布尔值。

ValuesBucket

用于存储键值对。

系统能力: 以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。

名称参数类型必填说明
[key: string][ValueType]Uint8Arraynull

SyncMode8+

指数据库同步模式。

系统能力: 以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。

名称默认值说明
SYNC_MODE_PUSH0表示数据从本地设备推送到远程设备。
SYNC_MODE_PULL1表示数据从远程设备拉至本地设备。HarmonyOSOpenHarmony鸿蒙文档籽料:mau123789是v直接拿

SubscribeType8+

描述订阅类型。

需要权限: ohos.permission.DISTRIBUTED_DATASYNC

系统能力: 以下各项对应的系统能力均为SystemCapability.DistributedDataManager.RelationalStore.Core。

名称默认值说明
SUBSCRIBE_TYPE_REMOTE0订阅远程数据更改。

审核编辑 黄宇

声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。 举报投诉
  • 接口
    +关注

    关注

    33

    文章

    8537

    浏览量

    150906
  • 数据库
    +关注

    关注

    7

    文章

    3770

    浏览量

    64301
  • 鸿蒙
    +关注

    关注

    57

    文章

    2325

    浏览量

    42766
收藏 人收藏

    评论

    相关推荐

    HarmonyOS开发案例:【搭建关系数据库】(4)

    本节将介绍如何调用关系数据库接口在本地搭建数据库,并读写相应的用户数据
    的头像 发表于 05-11 10:27 764次阅读
    HarmonyOS<b class='flag-5'>开发</b>案例:【搭建<b class='flag-5'>关系</b><b class='flag-5'>型</b><b class='flag-5'>数据库</b>】(4)

    Data Ability关系数据库练习

    关系数据库*/ private StoreConfig config = StoreConfig.newDefaultConfig(DB_NAME); private RdbStore
    发表于 03-08 09:37

    HarmonyOS应用开发数据交互--关系数据库完整流程练习

    名称使用默认配置创建数据库配置。 private RdbStore rdbStore;//提供管理关系数据库 (RDB) 的方法。 //RdbOpenCallback
    发表于 09-13 15:05

    基于Data Ability的关系数据库数据管理能力,实现数据库相关应用服务的快速开发

    、音乐等)和结构化数据(如数据库等)。同时,HarmonyOS提供多种数据管理能力,例如:关系数据库
    发表于 09-26 16:43

    一款基于Java实现的小巧而强大的关系数据库

    H2 是一款基于 Java 实现的小巧而强大的关系数据库,支持嵌入式、客户端/服务器以及混合部署模式。H2 数据库适合嵌入小型应用程序、元数据管理
    发表于 10-27 06:12

    基于Rdb创建的一个Data_Ability的数据操作过程

    ;//导入rdb关系数据库 模块import dataRdb from '@ohos.data.rdb'//=====================定义变量部分
    发表于 03-29 13:50

    HarmonyOS数据管理与应用数据持久化(一)

    ,分为用户首选项、键值数据库关系数据库。 ● 数据管理:提供高效的
    发表于 11-01 16:27

    什么是关系数据库

    什么是关系数据库 关系数据库简介   关系
    发表于 06-17 07:38 9120次阅读

    基于SQLite的鸿蒙关系数据库使用

    HarmonyOS关系数据库基于SQLite组件提供了一套完整的对本地数据库进行管理的机制,对外提供了一系列的增、删、改、查
    的头像 发表于 01-20 11:48 4056次阅读
    基于SQLite的<b class='flag-5'>鸿蒙</b>的<b class='flag-5'>关系</b><b class='flag-5'>型</b><b class='flag-5'>数据库</b>使用

    鸿蒙数据库知识点学习

    鸿蒙数据库知识点,了解了存储机制并且尝试了使用,发现鸿蒙数据库真的做到了应有尽有,操作还简单的地步。 鸿蒙
    的头像 发表于 09-06 09:34 3143次阅读

    OpenHarmony关系数据库概述

    关系数据库(Relational Database, 以下简称RDB)是一种基于关系模型来管理
    的头像 发表于 03-28 18:08 1024次阅读
    OpenHarmony<b class='flag-5'>关系</b><b class='flag-5'>型</b><b class='flag-5'>数据库</b>概述

    鸿蒙HarmonyOS开发实例:【分布式关系数据库

    使用[@ohos.data.relationalStore]接口和[@ohos.distributedDeviceManager] 接口展示了在eTS中分布式
    的头像 发表于 04-11 09:52 838次阅读
    <b class='flag-5'>鸿蒙</b>HarmonyOS<b class='flag-5'>开发</b>实例:【分布式<b class='flag-5'>关系</b><b class='flag-5'>型</b><b class='flag-5'>数据库</b>】

    鸿蒙开发接口数据管理:【@ohos.data.dataAbility (DataAbility谓词)】

    DataAbility 谓词用于构造关系数据库的谓词,提供用于实现不同查询方法的谓词。
    的头像 发表于 06-06 17:20 815次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b><b class='flag-5'>接口</b><b class='flag-5'>数据管理</b>:【@<b class='flag-5'>ohos.data</b>.dataAbility (DataAbility谓词)】

    鸿蒙开发接口数据管理:【@ohos.data.distributedData (分布式数据管理)】

    分布式数据管理为应用程序提供不同设备间数据库的分布式协同能力。通过调用分布式数据各个接口,应用程序可将数据保存到分布式
    的头像 发表于 06-07 09:30 918次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b><b class='flag-5'>接口</b><b class='flag-5'>数据管理</b>:【@<b class='flag-5'>ohos.data</b>.distributedData (分布式<b class='flag-5'>数据管理</b>)】

    鸿蒙开发接口数据管理:【data/rdb/resultSet (结果集)】

    结果集是指用户调用关系数据库查询接口之后返回的结果集合,提供了多种灵活的数据访问方式,以便用户获取各项
    的头像 发表于 06-11 16:59 621次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b><b class='flag-5'>接口</b><b class='flag-5'>数据管理</b>:【<b class='flag-5'>data</b>/<b class='flag-5'>rdb</b>/resultSet (结果集)】