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

2024-06-07 23:52
文章标签 接口 关系 开发 数据库 data rdb 鸿蒙 数据管理 ohos

本文主要是介绍鸿蒙开发接口数据管理：【@ohos.data.rdb (关系型数据库)】，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

关系型数据库

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

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

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

说明：

本模块首批接口从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<Array<[string, number]>>): void

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

需要权限：  ohos.permission.DISTRIBUTED_DATASYNC

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

参数：

参数名类型必填说明
mode[SyncMode]是指同步模式。该值可以是推、拉。
predicates[RdbPredicates]是约束同步数据和设备。
callbackAsyncCallback<Array<[string, number]>>是指定的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<Array<[string, number]>>

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

需要权限：  ohos.permission.DISTRIBUTED_DATASYNC

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

参数：

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

返回值：

类型说明
Promise<Array<[string, number]>>指定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<Array>): void

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

需要权限：  ohos.permission.DISTRIBUTED_DATASYNC

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

参数：

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

示例：

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<Array>): void

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

需要权限：  ohos.permission.DISTRIBUTED_DATASYNC

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

参数：

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

示例：

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表示数据从远程设备拉至本地设备。

SubscribeType8+

描述订阅类型。

需要权限：  ohos.permission.DISTRIBUTED_DATASYNC

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

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

这篇关于鸿蒙开发接口数据管理：【@ohos.data.rdb (关系型数据库)】的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1040660。

相关文章

Mysql数据库中数据的操作CRUD详解

Mysql数据库中数据的操作CRUD详解

《Mysql数据库中数据的操作CRUD详解》：本文主要介绍Mysql数据库中数据的操作（CRUD）,详细描述对Mysql数据库中数据的操作（CRUD）,包括插入、修改、删除数据,还有查询数据,包括... 目录一、插入数据（insert）1.插入数据的语法2.注意事项二、修改数据（update）1.语法2.有
阅读更多...
SpringBoot实现接口数据加解密的三种实战方案

SpringBoot实现接口数据加解密的三种实战方案

《SpringBoot实现接口数据加解密的三种实战方案》在金融支付、用户隐私信息传输等场景中,接口数据若以明文传输,极易被中间人攻击窃取,SpringBoot提供了多种优雅的加解密实现方案,本文将从原... 目录一、为什么需要接口数据加解密？二、核心加解密算法选择1. 对称加密（AES）2. 非对称加密（R
阅读更多...
Java对接Dify API接口的完整流程

Java对接Dify API接口的完整流程

《Java对接DifyAPI接口的完整流程》Dify是一款AI应用开发平台,提供多种自然语言处理能力,通过调用Dify开放API,开发者可以快速集成智能对话、文本生成等功能到自己的Java应用中,本... 目录Java对接Dify API接口完整指南一、Dify API简介二、准备工作三、基础对接实现1.
阅读更多...
Redis持久化机制之RDB与AOF的使用

Redis持久化机制之RDB与AOF的使用

《Redis持久化机制之RDB与AOF的使用》：本文主要介绍Redis持久化机制之RDB与AOF的使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录Redis持久化机制-RDB与AOF一、RDB持久化机制1、RDB简介2、RDB的工作原理3、RDB的优缺点4
阅读更多...
一文教你如何解决Python开发总是import出错的问题

一文教你如何解决Python开发总是import出错的问题

《一文教你如何解决Python开发总是import出错的问题》经常朋友碰到Python开发的过程中import包报错的问题,所以本文将和大家介绍一下可编辑安装（EditableInstall）模式,可... 目录摘要1. 可编辑安装（Editable Install）模式到底在解决什么问题？2. 原理3.
阅读更多...
查看MySQL数据库版本的四种方法

查看MySQL数据库版本的四种方法

《查看MySQL数据库版本的四种方法》查看MySQL数据库的版本信息可以通过多种方法实现,包括使用命令行工具、SQL查询语句和图形化管理工具等,以下是详细的步骤和示例代码,需要的朋友可以参考下... 目录方法一：使用命令行工具1. 使用 mysql 命令示例：方法二：使用 mysqladmin 命令示例：方
阅读更多...
Python+PyQt5开发一个Windows电脑启动项管理神器

Python+PyQt5开发一个Windows电脑启动项管理神器

《Python+PyQt5开发一个Windows电脑启动项管理神器》：本文主要介绍如何使用PyQt5开发一款颜值与功能并存的Windows启动项管理工具,不仅能查看/删除现有启动项,还能智能添加新... 目录开篇：为什么我们需要启动项管理工具功能全景图核心技术解析1. Windows注册表操作2. 启动文件
阅读更多...
使用Python开发Markdown兼容公式格式转换工具

使用Python开发Markdown兼容公式格式转换工具

《使用Python开发Markdown兼容公式格式转换工具》在技术写作中我们经常遇到公式格式问题,例如MathML无法显示,LaTeX格式错乱等,所以本文我们将使用Python开发Markdown兼容... 目录一、工具背景二、环境配置（Windows 10/11）1. 创建conda环境2. 获取XSLT
阅读更多...
Android开发环境配置避坑指南

Android开发环境配置避坑指南

《Android开发环境配置避坑指南》本文主要介绍了Android开发环境配置过程中遇到的问题及解决方案,包括VPN注意事项、工具版本统一、Gerrit邮箱配置、Git拉取和提交代码、MergevsR... 目录网络环境：VPN 注意事项工具版本统一：android Studio & JDKGerrit的邮
阅读更多...
Python开发文字版随机事件游戏的项目实例

Python开发文字版随机事件游戏的项目实例

《Python开发文字版随机事件游戏的项目实例》随机事件游戏是一种通过生成不可预测的事件来增强游戏体验的类型,在这篇博文中,我们将使用Python开发一款文字版随机事件游戏,通过这个项目,读者不仅能够... 目录项目概述2.1 游戏概念2.2 游戏特色2.3 目标玩家群体技术选择与环境准备3.1 开发环境3
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2