中俊为 | OpenHarmony文档中心 | 搜索更快捷

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

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

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

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

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

说明：

本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

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

data_rdb.getRdbStoreV99+

getRdbStoreV9(context: Context, config: StoreConfigV9, version: number, callback: AsyncCallback<RdbStoreV9>): void

获得一个相关的RdbStoreV9，操作关系型数据库，用户可以根据自己的需求配置RdbStoreV9的参数，然后通过RdbStoreV9调用相关接口可以执行相关的数据操作，使用callback异步回调。

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

参数：

参数名 类型 必填 说明
context Context 是 应用的上下文。
FA模型的应用Context定义见Context。
Stage模型的应用Context定义见Context。
config StoreConfigV9 是 与此RDB存储相关的数据库配置。
version number 是 数据库版本。
目前暂不支持通过version自动识别数据库升级降级操作，只能由开发者自行维护。
callback AsyncCallback<RdbStoreV9> 是 指定callback回调函数，返回RdbStoreV9对象。

错误码：

以下错误码的详细介绍请参见关系型数据库错误码。

错误码ID 错误信息
14800010 Invalid database name.
14800011 Database corrupted.

示例：

FA模型示例：

// 获取context
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()

// 获取context后调用getRdbStoreV9
const STORE_CONFIGV9 = { name: "RdbTest.db",
                     securityLevel: data_rdb.SecurityLevel.S1}
data_rdb.getRdbStoreV9(context, STORE_CONFIGV9, 1, function (err, rdbStoreV9) {
    if (err) {
        console.info("Get RdbStoreV9 failed, err: " + err)
        return
    }
    console.log("Get RdbStoreV9 successfully.")
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14

Stage模型示例：

// 获取context
import Ability from '@ohos.application.Ability'
let context
class MainAbility extends Ability{
    onWindowStageCreate(windowStage){
        context = this.context
    }
}

// 获取context后调用getRdbStoreV9
const STORE_CONFIGV9 = { name: "RdbTest.db",
                     securityLevel: data_rdb.SecurityLevel.S1}
data_rdb.getRdbStoreV9(context, STORE_CONFIGV9, 1, function (err, rdbStoreV9) {
    if (err) {
        console.info("Get RdbStoreV9 failed, err: " + err)
        return
    }
    console.log("Get RdbStoreV9 successfully.")
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

data_rdb.getRdbStoreV99+

getRdbStoreV9(context: Context, config: StoreConfigV9, version: number): Promise<RdbStoreV9>

获得一个相关的RdbStoreV9，操作关系型数据库，用户可以根据自己的需求配置RdbStoreV9的参数，然后通过RdbStoreV9调用相关接口可以执行相关的数据操作，使用Promise异步回调。

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

参数：

参数名 类型 必填 说明
context Context 是 应用的上下文。
FA模型的应用Context定义见Context。
Stage模型的应用Context定义见Context。
config StoreConfigV9 是 与此RDB存储相关的数据库配置。
version number 是 数据库版本。
目前暂不支持通过version自动识别数据库升级降级操作，只能由开发者自行维护。

返回值：

类型 说明
Promise<RdbStoreV9> Promise对象。返回RdbStoreV9对象。

错误码：

以下错误码的详细介绍请参见关系型数据库错误码。

错误码ID 错误信息
14800010 Invalid database name.
14800011 Database corrupted.

示例：

FA模型示例：

// 获取context
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()

// 获取context后调用getRdbStoreV9
const STORE_CONFIGV9 = { name: "RdbTest.db",
                     securityLevel: data_rdb.SecurityLevel.S1}
let promise = data_rdb.getRdbStoreV9(context, STORE_CONFIGV9, 1);
promise.then(async (rdbStoreV9) => {
    console.log("Get RdbStoreV9 successfully.")
}).catch((err) => {
    console.log("Get RdbStoreV9 failed, err: " + err)
})
1
2
3
4
5
6
7
8
9
10
11
12
13

Stage模型示例：

// 获取context
import Ability from '@ohos.application.Ability'
let context
class MainAbility extends Ability{
    onWindowStageCreate(windowStage){
        context = this.context
    }
}

// 获取context后调用getRdbStoreV9
const STORE_CONFIGV9 = { name: "RdbTest.db",
                     securityLevel: data_rdb.SecurityLevel.S1}
let promise = data_rdb.getRdbStoreV9(context, STORE_CONFIGV9, 1);
promise.then(async (rdbStoreV9) => {
    console.log("Get RdbStoreV9 successfully.")
}).catch((err) => {
    console.log("Get RdbStoreV9 failed, err: " + err)
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

data_rdb.deleteRdbStoreV99+

deleteRdbStoreV9(context: Context, name: string, callback: AsyncCallback<void>): void

删除数据库，使用callback异步回调。

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

参数：

参数名 类型 必填 说明
context Context 是 应用的上下文。
FA模型的应用Context定义见Context。
Stage模型的应用Context定义见Context。
name string 是 数据库名称。
callback AsyncCallback<void> 是 指定callback回调函数。

错误码：

以下错误码的详细介绍请参见关系型数据库错误码。

错误码ID 错误信息
14800010 Invalid database name.

示例：

FA模型示例：

// 获取context
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()

// 获取context后调用deleteRdbStoreV9
data_rdb.deleteRdbStoreV9(context, "RdbTest.db", function (err) {
    if (err) {
        console.info("Delete RdbStorev9 failed, err: " + err)
        return
    }
    console.log("Delete RdbStorev9 successfully.")
})
1
2
3
4
5
6
7
8
9
10
11
12

Stage模型示例：

// 获取context
import Ability from '@ohos.application.Ability'
let context
class MainAbility extends Ability{
    onWindowStageCreate(windowStage){
        context = this.context
    }
}

// 获取context后调用deleteRdbStoreV9
data_rdb.deleteRdbStoreV9(context, "RdbTest.db", function (err) {
    if (err) {
        console.info("Delete RdbStoreV9 failed, err: " + err)
        return
    }
    console.log("Delete RdbStoreV9 successfully.")
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

data_rdb.deleteRdbStoreV99+

deleteRdbStoreV9(context: Context, name: string): Promise<void>

使用指定的数据库文件配置删除数据库，使用Promise异步回调。

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

参数

参数名 类型 必填 说明
context Context 是 应用的上下文。
FA模型的应用Context定义见Context。
Stage模型的应用Context定义见Context。
name string 是 数据库名称。

返回值：

类型 说明
Promise<void> 无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见关系型数据库错误码。

错误码ID 错误信息
14800010 Invalid database name.

示例：

FA模型示例：

// 获取context
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()

// 获取context后调用deleteRdbStoreV9
let promise = data_rdb.deleteRdbStoreV9(context, "RdbTest.db")
promise.then(()=>{
    console.log("Delete RdbStoreV9 successfully.")
}).catch((err) => {
    console.info("Delete RdbStoreV9 failed, err: " + err)
})
1
2
3
4
5
6
7
8
9
10
11

Stage模型示例：

// 获取context
import Ability from '@ohos.application.Ability'
let context
class MainAbility extends Ability{
    onWindowStageCreate(windowStage){
        context = this.context
    }
}

// 获取context后调用deleteRdbStoreV9
let promise = data_rdb.deleteRdbStoreV9(context, "RdbTest.db")
promise.then(()=>{
    console.log("Delete RdbStoreV9 successfully.")
}).catch((err) => {
    console.info("Delete RdbStoreV9 failed, err: " + err)
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

data_rdb.getRdbStore(deprecated)

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

获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，使用callback异步回调。

说明：

从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用data_rdb.getRdbStoreV9替代。

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

参数：

参数名 类型 必填 说明
context Context 是 应用的上下文。
FA模型的应用Context定义见Context。
Stage模型的应用Context定义见Context。
config StoreConfig 是 与此RDB存储相关的数据库配置。
version number 是 数据库版本。
目前暂不支持通过version自动识别数据库升级降级操作，只能由开发者自行维护。
callback AsyncCallback<RdbStore> 是 指定callback回调函数，返回RdbStore对象。

示例：

FA模型示例：

// 获取context
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()

// 获取context后调用getRdbStore
const STORE_CONFIG = { name: "RdbTest.db"}
data_rdb.getRdbStore(context, STORE_CONFIG, 1, function (err, rdbStore) {
    if (err) {
        console.info("Get RdbStore failed, err: " + err)
        return
    }
    console.log("Get RdbStore successfully.")
})
1
2
3
4
5
6
7
8
9
10
11
12
13

Stage模型示例：

// 获取context
import Ability from '@ohos.application.Ability'
let context
class MainAbility extends Ability{
    onWindowStageCreate(windowStage){
        context = this.context
    }
}

// 获取context后调用getRdbStore
const STORE_CONFIG = { name: "RdbTest.db"}
data_rdb.getRdbStore(context, STORE_CONFIG, 1, function (err, rdbStore) {
    if (err) {
        console.info("Get RdbStore failed, err: " + err)
        return
    }
    console.log("Get RdbStore successfully.")
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

data_rdb.getRdbStore(deprecated)

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

获得一个相关的RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作，使用Promise异步回调。

说明：

从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用data_rdb.getRdbStoreV9替代。

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

参数：

参数名 类型 必填 说明
context Context 是 应用的上下文。
FA模型的应用Context定义见Context。
Stage模型的应用Context定义见Context。
config StoreConfig 是 与此RDB存储相关的数据库配置。
version number 是 数据库版本。
目前暂不支持通过version自动识别数据库升级降级操作，只能由开发者自行维护。

返回值：

类型 说明
Promise<RdbStore> Promise对象。返回RdbStore对象。

示例：

FA模型示例：

// 获取context
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()

// 获取context后调用getRdbStore
const STORE_CONFIG = { name: "RdbTest.db" }
let promise = data_rdb.getRdbStore(context, STORE_CONFIG, 1);
promise.then(async (rdbStore) => {
    console.log("Get RdbStore successfully.")
}).catch((err) => {
    console.log("Get RdbStore failed, err: " + err)
})
1
2
3
4
5
6
7
8
9
10
11
12

Stage模型示例：

// 获取context
import Ability from '@ohos.application.Ability'
let context
class MainAbility extends Ability{
    onWindowStageCreate(windowStage){
        context = this.context
    }
}

// 获取context后调用getRdbStore
const STORE_CONFIG = { name: "RdbTest.db" }
let promise = data_rdb.getRdbStore(context, STORE_CONFIG, 1);
promise.then(async (rdbStore) => {
    console.log("Get RdbStore successfully.")
}).catch((err) => {
    console.log("Get RdbStore failed, err: " + err)
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

data_rdb.deleteRdbStore(deprecated)

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

删除数据库，使用callback异步回调。

说明：

从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用data_rdb.deleteRdbStoreV9替代。

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

参数：

参数名 类型 必填 说明
context Context 是 应用的上下文。
FA模型的应用Context定义见Context。
Stage模型的应用Context定义见Context。
name string 是 数据库名称。
callback AsyncCallback<void> 是 指定callback回调函数。

示例：

FA模型示例：

// 获取context
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()

// 获取context后调用deleteRdbStore
data_rdb.deleteRdbStore(context, "RdbTest.db", function (err) {
    if (err) {
        console.info("Delete RdbStore failed, err: " + err)
        return
    }
    console.log("Delete RdbStore successfully.")
})
1
2
3
4
5
6
7
8
9
10
11
12

Stage模型示例：

// 获取context
import Ability from '@ohos.application.Ability'
let context
class MainAbility extends Ability{
    onWindowStageCreate(windowStage){
        context = this.context
    }
}

// 获取context后调用deleteRdbStore
data_rdb.deleteRdbStore(context, "RdbTest.db", function (err) {
    if (err) {
        console.info("Delete RdbStore failed, err: " + err)
        return
    }
    console.log("Delete RdbStore successfully.")
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

data_rdb.deleteRdbStore(deprecated)

deleteRdbStore(context: Context, name: string): Promise<void>

使用指定的数据库文件配置删除数据库，使用Promise异步回调。

说明：

从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用data_rdb.deleteRdbStoreV9替代。

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

参数

参数名 类型 必填 说明
context Context 是 应用的上下文。
FA模型的应用Context定义见Context。
Stage模型的应用Context定义见Context。
name string 是 数据库名称。

返回值：

类型 说明
Promise<void> 无返回结果的Promise对象。

示例：

FA模型示例：

// 获取context
import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()

// 获取context后调用deleteRdbStore
let promise = data_rdb.deleteRdbStore(context, "RdbTest.db")
promise.then(() => {
    console.log("Delete RdbStore successfully.")
}).catch((err) => {
    console.info("Delete RdbStore failed, err: " + err)
})
1
2
3
4
5
6
7
8
9
10
11

Stage模型示例：

// 获取context
import Ability from '@ohos.application.Ability'
let context
class MainAbility extends Ability{
    onWindowStageCreate(windowStage){
        context = this.context
    }
}

// 获取context后调用deleteRdbStore
let promise = data_rdb.deleteRdbStore(context, "RdbTest.db")
promise.then(()=>{
    console.log("Delete RdbStore successfully.")
}).catch((err) => {
    console.info("Delete RdbStore failed, err: " + err)
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

RdbPredicatesV99+

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

constructor9+

constructor(name: string)

构造函数。

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

参数：

参数名 类型 必填 说明
name string 是 数据库表名。

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
1

inDevices9+

inDevices(devices: Array<string>): RdbPredicatesV9

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

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

参数：

参数名 类型 必填 说明
devices Array<string> 是 指定的组网内的远程设备ID。

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.inDevices(['12345678abcde'])
1
2

inAllDevices9+

inAllDevices(): RdbPredicatesV9

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

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

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.inAllDevices()
1
2

equalTo9+

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

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

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

参数：

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

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "lisi")
1
2

notEqualTo9+

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

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

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

参数：

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

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.notEqualTo("NAME", "lisi")
1
2

beginWrap9+

beginWrap(): RdbPredicatesV9

向谓词添加左括号。

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

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "lisi")
    .beginWrap()
    .equalTo("AGE", 18)
    .or()
    .equalTo("SALARY", 200.5)
    .endWrap()
1
2
3
4
5
6
7

endWrap9+

endWrap(): RdbPredicatesV9

向谓词添加右括号。

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

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "lisi")
    .beginWrap()
    .equalTo("AGE", 18)
    .or()
    .equalTo("SALARY", 200.5)
    .endWrap()
1
2
3
4
5
6
7

or9+

or(): RdbPredicatesV9

将或条件添加到谓词中。

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

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "Lisa")
    .or()
    .equalTo("NAME", "Rose")
1
2
3
4

and9+

and(): RdbPredicatesV9

向谓词添加和条件。

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

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "Lisa")
    .and()
    .equalTo("SALARY", 200.5)
1
2
3
4

contains9+

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

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

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

参数：

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

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.contains("NAME", "os")
1
2

beginsWith9+

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

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

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

参数：

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

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.beginsWith("NAME", "os")
1
2

endsWith9+

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

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

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

参数：

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

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.endsWith("NAME", "se")
1
2

isNull9+

isNull(field: string): RdbPredicatesV9

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

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

参数：

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

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.isNull("NAME")
1
2

isNotNull9+

isNotNull(field: string): RdbPredicatesV9

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

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

参数：

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

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.isNotNull("NAME")
1
2

like9+

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

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

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

参数：

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

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.like("NAME", "%os%")
1
2

glob9+

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

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

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

参数：

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

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.glob("NAME", "?h*g")
1
2

between9+

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

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

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

参数：

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

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.between("AGE", 10, 50)
1
2

notBetween9+

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

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

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

参数：

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

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.notBetween("AGE", 10, 50)
1
2

greaterThan9+

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

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

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

参数：

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

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.greaterThan("AGE", 18)
1
2

lessThan9+

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

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

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

参数：

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

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.lessThan("AGE", 20)
1
2

greaterThanOrEqualTo9+

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

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

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

参数：

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

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.greaterThanOrEqualTo("AGE", 18)
1
2

lessThanOrEqualTo9+

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

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

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

参数：

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

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.lessThanOrEqualTo("AGE", 20)
1
2

orderByAsc9+

orderByAsc(field: string): RdbPredicatesV9

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

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

参数：

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

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.orderByAsc("NAME")
1
2

orderByDesc9+

orderByDesc(field: string): RdbPredicatesV9

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

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

参数：

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

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.orderByDesc("AGE")
1
2

distinct9+

distinct(): RdbPredicatesV9

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

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

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "Rose").distinct()
1
2

limitAs9+

limitAs(value: number): RdbPredicatesV9

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

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

参数：

参数名 类型 必填 说明
value number 是 最大数据记录数。

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "Rose").limitAs(3)
1
2

offsetAs9+

offsetAs(rowOffset: number): RdbPredicatesV9

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

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

参数：

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

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "Rose").offsetAs(3)
1
2

groupBy9+

groupBy(fields: Array<string>): RdbPredicatesV9

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

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

参数：

参数名 类型 必填 说明
fields Array<string> 是 指定分组依赖的列名。

返回值：

类型 说明
RdbPredicatesV9 返回分组查询列的谓词。

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.groupBy(["AGE", "NAME"])
1
2

indexedBy9+

indexedBy(field: string): RdbPredicatesV9

配置RdbPredicatesV9以指定索引列。

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

参数：

参数名 类型 必填 说明
field string 是 索引列的名称。

返回值：

类型 说明
RdbPredicatesV9 返回具有指定索引列的RdbPredicatesV9。

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.indexedBy("SALARY_INDEX")
1
2

in9+

in(field: string, value: Array<ValueType>): RdbPredicatesV9

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

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

参数：

参数名 类型 必填 说明
field string 是 数据库表中的列名。
value Array<ValueType> 是 以ValueType型数组形式指定的要匹配的值。

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.in("AGE", [18, 20])
1
2

notIn9+

notIn(field: string, value: Array<ValueType>): RdbPredicatesV9

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

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

参数：

参数名 类型 必填 说明
field string 是 数据库表中的列名。
value Array<ValueType> 是 以ValueType数组形式指定的要匹配的值。

返回值：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.notIn("NAME", ["Lisa", "Rose"])
1
2

RdbStoreV99+

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

在使用以下相关接口前，请使用executeSql接口初始化数据库表结构和相关数据，具体可见关系型数据库开发指导。

insert9+

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

向目标表中插入一行数据，使用callback异步回调。

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

参数：

参数名 类型 必填 说明
table string 是 指定的目标表名。
values ValuesBucket 是 表示要插入到表中的数据行。
callback AsyncCallback<number> 是 指定callback回调函数。如果操作成功，返回行ID；否则返回-1。

示例：

const valueBucket = {
    "NAME": "Lisa",
    "AGE": 18,
    "SALARY": 100.5,
    "CODES": new Uint8Array([1, 2, 3, 4, 5]),
}
rdbStoreV9.insert("EMPLOYEE", valueBucket, function (status, rowId) {
    if (status) {
        console.log("Insert is failed");
        return;
    }
    console.log("Insert is successful, rowId = " + rowId);
})
1
2
3
4
5
6
7
8
9
10
11
12
13

insert9+

insert(table: string, values: ValuesBucket):Promise<number>

向目标表中插入一行数据，使用Promise异步回调。

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

参数：

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

返回值：

类型 说明
Promise<number> Promise对象。如果操作成功，返回行ID；否则返回-1。

示例：

const valueBucket = {
    "NAME": "Lisa",
    "AGE": 18,
    "SALARY": 100.5,
    "CODES": new Uint8Array([1, 2, 3, 4, 5]),
}
let promise = rdbStoreV9.insert("EMPLOYEE", valueBucket)
promise.then((rowId) => {
    console.log("Insert is successful, rowId = " + rowId);
}).catch((status) => {
    console.log("Insert is failed");
})
1
2
3
4
5
6
7
8
9
10
11
12

batchInsert9+

batchInsert(table: string, values: Array<ValuesBucket>, callback: AsyncCallback<number>):void

向目标表中插入一组数据，使用callback异步回调。

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

参数：

参数名 类型 必填 说明
table string 是 指定的目标表名。
values Array<ValuesBucket> 是 表示要插入到表中的一组数据。
callback AsyncCallback<number> 是 指定callback回调函数。如果操作成功，返回插入的数据个数，否则返回-1。

示例：

const valueBucket1 = {
    "NAME": "Lisa",
    "AGE": 18,
    "SALARY": 100.5,
    "CODES": new Uint8Array([1, 2, 3, 4, 5])
}
const valueBucket2 = {
    "NAME": "Jack",
    "AGE": 19,
    "SALARY": 101.5,
    "CODES": new Uint8Array([6, 7, 8, 9, 10])
}
const valueBucket3 = {
    "NAME": "Tom",
    "AGE": 20,
    "SALARY": 102.5,
    "CODES": new Uint8Array([11, 12, 13, 14, 15])
}

let valueBuckets = new Array(valueBucket1, valueBucket2, valueBucket3);
rdbStoreV9.batchInsert("EMPLOYEE", valueBuckets, function(status, insertNum) {
    if (status) {
        console.log("batchInsert is failed, status = " + status);
        return;
    }
    console.log("batchInsert is successful, the number of values that were inserted = " + insertNum);
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

batchInsert9+

batchInsert(table: string, values: Array<ValuesBucket>):Promise<number>

向目标表中插入一组数据，使用Promise异步回调。

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

参数：

参数名 类型 必填 说明
table string 是 指定的目标表名。
values Array<ValuesBucket> 是 表示要插入到表中的一组数据。

返回值：

类型 说明
Promise<number> Promise对象。如果操作成功，返回插入的数据个数，否则返回-1。

示例：

const valueBucket1 = {
    "NAME": "Lisa",
    "AGE": 18,
    "SALARY": 100.5,
    "CODES": new Uint8Array([1, 2, 3, 4, 5])
}
const valueBucket2 = {
    "NAME": "Jack",
    "AGE": 19,
    "SALARY": 101.5,
    "CODES": new Uint8Array([6, 7, 8, 9, 10])
}
const valueBucket3 = {
    "NAME": "Tom",
    "AGE": 20,
    "SALARY": 102.5,
    "CODES": new Uint8Array([11, 12, 13, 14, 15])
}

let valueBuckets = new Array(valueBucket1, valueBucket2, valueBucket3);
let promise = rdbStoreV9.batchInsert("EMPLOYEE", valueBuckets);
promise.then((insertNum) => {
    console.log("batchInsert is successful, the number of values that were inserted = " + insertNum);
}).catch((status) => {
    console.log("batchInsert is failed, status = " + status);
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

update9+

update(values: ValuesBucket, predicates: RdbPredicatesV9, callback: AsyncCallback<number>):void

根据RdbPredicatesV9的指定实例对象更新数据库中的数据，使用callback异步回调。

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

参数：

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

示例：

const valueBucket = {
    "NAME": "Rose",
    "AGE": 22,
    "SALARY": 200.5,
    "CODES": new Uint8Array([1, 2, 3, 4, 5]),
}
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "Lisa")
rdbStoreV9.update(valueBucket, predicatesV9, function (err, ret) {
    if (err) {
        console.info("Updated failed, err: " + err)
        return
    }
    console.log("Updated row count: " + ret)
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

update9+

update(values: ValuesBucket, predicates: RdbPredicatesV9):Promise<number>

根据RdbPredicatesV9的指定实例对象更新数据库中的数据，使用Promise异步回调。

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

参数：

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

返回值：

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

示例：

const valueBucket = {
    "NAME": "Rose",
    "AGE": 22,
    "SALARY": 200.5,
    "CODES": new Uint8Array([1, 2, 3, 4, 5]),
}
let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "Lisa")
let promise = rdbStoreV9.update(valueBucket, predicatesV9)
promise.then(async (ret) => {
    console.log("Updated row count: " + ret)
}).catch((err) => {
    console.info("Updated failed, err: " + err)
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14

update9+

update(table: string, values: ValuesBucket, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback<number>):void

根据DataSharePredicates的指定实例对象更新数据库中的数据，使用callback异步回调。

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

系统接口： 此接口为系统接口。

参数：

参数名 类型 必填 说明
table string 是 指定的目标表名。
values ValuesBucket 是 values指示数据库中要更新的数据行。键值对与数据库表的列名相关联。
predicates dataSharePredicates.DataSharePredicates 是 DataSharePredicates的实例对象指定的更新条件。
callback AsyncCallback<number> 是 指定的callback回调方法。返回受影响的行数。

示例：

import dataSharePredicates from '@ohos.data.dataSharePredicates'
const valueBucket = {
    "NAME": "Rose",
    "AGE": 22,
    "SALARY": 200.5,
    "CODES": new Uint8Array([1, 2, 3, 4, 5]),
}
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "Lisa")
rdbStoreV9.update("EMPLOYEE", valueBucket, predicates, function (err, ret) {
    if (err) {
        console.info("Updated failed, err: " + err)
        return
    }
    console.log("Updated row count: " + ret)
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

update9+

update(table: string, values: ValuesBucket, predicates: dataSharePredicates.DataSharePredicates):Promise<number>

根据DataSharePredicates的指定实例对象更新数据库中的数据，使用Promise异步回调。

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

系统接口： 此接口为系统接口。

参数：

参数名 类型 必填 说明
table string 是 指定的目标表名。
values ValuesBucket 是 values指示数据库中要更新的数据行。键值对与数据库表的列名相关联。
predicates dataSharePredicates.DataSharePredicates 是 DataSharePredicates的实例对象指定的更新条件。

返回值：

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

示例：

import dataSharePredicates from '@ohos.data.dataSharePredicates'
const valueBucket = {
    "NAME": "Rose",
    "AGE": 22,
    "SALARY": 200.5,
    "CODES": new Uint8Array([1, 2, 3, 4, 5]),
}
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "Lisa")
let promise = rdbStoreV9.update("EMPLOYEE", valueBucket, predicates)
promise.then(async (ret) => {
    console.log("Updated row count: " + ret)
}).catch((err) => {
    console.info("Updated failed, err: " + err)
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

delete9+

delete(predicates: RdbPredicatesV9, callback: AsyncCallback<number>):void

根据RdbPredicatesV9的指定实例对象从数据库中删除数据，使用callback异步回调。

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

参数：

参数名 类型 必填 说明
predicates RdbPredicatesV9 是 RdbPredicatesV9的实例对象指定的删除条件。
callback AsyncCallback<number> 是 指定callback回调函数。返回受影响的行数。

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "Lisa")
rdbStoreV9.delete(predicatesV9, function (err, rows) {
    if (err) {
        console.info("Delete failed, err: " + err)
        return
    }
    console.log("Delete rows: " + rows)
})
1
2
3
4
5
6
7
8
9

delete9+

delete(predicates: RdbPredicatesV9):Promise<number>

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

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

参数：

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

返回值：

类型 说明
Promise<number> Promise对象。返回受影响的行数。

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "Lisa")
let promise = rdbStoreV9.delete(predicatesV9)
promise.then((rows) => {
    console.log("Delete rows: " + rows)
}).catch((err) => {
    console.info("Delete failed, err: " + err)
})
1
2
3
4
5
6
7
8

delete9+

delete(table: string, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback<number>):void

根据DataSharePredicates的指定实例对象从数据库中删除数据，使用callback异步回调。

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

系统接口： 此接口为系统接口。

参数：

参数名 类型 必填 说明
table string 是 指定的目标表名。
predicates dataSharePredicates.DataSharePredicates 是 DataSharePredicates的实例对象指定的删除条件。
callback AsyncCallback<number> 是 指定callback回调函数。返回受影响的行数。

示例：

import dataSharePredicates from '@ohos.data.dataSharePredicates'
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "Lisa")
rdbStoreV9.delete("EMPLOYEE", predicates, function (err, rows) {
    if (err) {
        console.info("Delete failed, err: " + err)
        return
    }
    console.log("Delete rows: " + rows)
})
1
2
3
4
5
6
7
8
9
10

delete9+

delete(table: string, predicates: dataSharePredicates.DataSharePredicates):Promise<number>

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

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

系统接口： 此接口为系统接口。

参数：

参数名 类型 必填 说明
table string 是 指定的目标表名。
predicates dataSharePredicates.DataSharePredicates 是 DataSharePredicates的实例对象指定的删除条件。

返回值：

类型 说明
Promise<number> Promise对象。返回受影响的行数。

示例：

import dataSharePredicates from '@ohos.data.dataSharePredicates'
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "Lisa")
let promise = rdbStoreV9.delete("EMPLOYEE", predicates)
promise.then((rows) => {
    console.log("Delete rows: " + rows)
}).catch((err) => {
    console.info("Delete failed, err: " + err)
})
1
2
3
4
5
6
7
8
9

query9+

query(predicates: RdbPredicatesV9, columns: Array<string>, callback: AsyncCallback<ResultSetV9>):void

根据指定条件查询数据库中的数据，使用callback异步回调。

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

参数：

参数名 类型 必填 说明
predicates RdbPredicatesV9 是 RdbPredicatesV9的实例对象指定的查询条件。
columns Array<string> 是 表示要查询的列。如果值为空，则查询应用于所有列。
callback AsyncCallback<ResultSetV9> 是 指定callback回调函数。如果操作成功，则返回ResultSetV9对象。

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "Rose")
rdbStoreV9.query(predicatesV9, ["ID", "NAME", "AGE", "SALARY", "CODES"], function (err, resultSetV9) {
    if (err) {
        console.info("Query failed, err: " + err)
        return
    }
    console.log("ResultSet column names: " + resultSetV9.columnNames)
    console.log("ResultSet column count: " + resultSetV9.columnCount)
})
1
2
3
4
5
6
7
8
9
10

query9+

query(predicates: RdbPredicatesV9, columns?: Array<string>):Promise<ResultSetV9>

根据指定条件查询数据库中的数据，使用Promise异步回调。

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

参数：

参数名 类型 必填 说明
predicates RdbPredicatesV9 是 RdbPredicatesV9的实例对象指定的查询条件。
columns Array<string> 否 表示要查询的列。如果值为空，则查询应用于所有列。

返回值：

类型 说明
Promise<ResultSetV9> Promise对象。如果操作成功，则返回ResultSetV9对象。

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9("EMPLOYEE")
predicatesV9.equalTo("NAME", "Rose")
let promise = rdbStoreV9.query(predicatesV9, ["ID", "NAME", "AGE", "SALARY", "CODES"])
promise.then((resultSetV9) => {
  console.log("ResultSet column names: " + resultSetV9.columnNames)
  console.log("ResultSet column count: " + resultSetV9.columnCount)
}).catch((err) => {
  console.info("Query failed, err: " + err)
})
1
2
3
4
5
6
7
8
9

query9+

query(table: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array<string>, callback: AsyncCallback<ResultSetV9>):void

根据指定条件查询数据库中的数据，使用callback异步回调。

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

系统接口： 此接口为系统接口。

参数：

参数名 类型 必填 说明
table string 是 指定的目标表名。
predicates dataSharePredicates.DataSharePredicates 是 DataSharePredicates的实例对象指定的查询条件。
columns Array<string> 是 表示要查询的列。如果值为空，则查询应用于所有列。
callback AsyncCallback<ResultSetV9> 是 指定callback回调函数。如果操作成功，则返回ResultSetV9对象。

示例：

import dataSharePredicates from '@ohos.data.dataSharePredicates'
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "Rose")
rdbStoreV9.query("EMPLOYEE", predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"], function (err, resultSetV9) {
    if (err) {
        console.info("Query failed, err: " + err)
        return
    }
    console.log("ResultSet column names: " + resultSetV9.columnNames)
    console.log("ResultSet column count: " + resultSetV9.columnCount)
})
1
2
3
4
5
6
7
8
9
10
11

query9+

query(table: string, predicates: dataSharePredicates.DataSharePredicates, columns?: Array<string>):Promise<ResultSetV9>

根据指定条件查询数据库中的数据，使用Promise异步回调。

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

系统接口： 此接口为系统接口。

参数：

参数名 类型 必填 说明
table string 是 指定的目标表名。
predicates dataSharePredicates.DataSharePredicates 是 DataSharePredicates的实例对象指定的查询条件。
columns Array<string> 否 表示要查询的列。如果值为空，则查询应用于所有列。

返回值：

类型 说明
Promise<ResultSetV9> Promise对象。如果操作成功，则返回ResultSetV9对象。

示例：

import dataSharePredicates from '@ohos.data.dataSharePredicates'
let predicates = new dataSharePredicates.DataSharePredicates()
predicates.equalTo("NAME", "Rose")
let promise = rdbStoreV9.query("EMPLOYEE", predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"])
promise.then((resultSetV9) => {
    console.log("ResultSet column names: " + resultSetV9.columnNames)
    console.log("ResultSet column count: " + resultSetV9.columnCount)
}).catch((err) => {
    console.info("Query failed, err: " + err)
})
1
2
3
4
5
6
7
8
9
10

remoteQuery9+

remoteQuery(device: string, table: string, predicates: RdbPredicatesV9, columns: Array<string> , callback: AsyncCallback<ResultSetV9>): void

根据指定条件查询远程设备数据库中的数据。使用callback异步回调。

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

参数：

参数名 类型 必填 说明
device string 是 指定的远程设备的networkId。
table string 是 指定的目标表名。
predicates RdbPredicatesV9 是 RdbPredicatesV9的实例对象，指定查询的条件。
columns Array<string> 是 表示要查询的列。如果值为空，则查询应用于所有列。
callback AsyncCallback<ResultSetV9> 是 指定callback回调函数。如果操作成功，则返回ResultSetV9对象。

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9('EMPLOYEE')
predicatesV9.greaterThan("id", 0)
rdbStoreV9.remoteQuery("deviceId", "EMPLOYEE", predicatesV9, ["ID", "NAME", "AGE", "SALARY", "CODES"],
    function(err, resultSetV9){
    if (err) {
        console.info("Failed to remoteQuery, err: " + err)
        return
    }
    console.info("ResultSet column names: " + resultSetV9.columnNames)
    console.info("ResultSet column count: " + resultSetV9.columnCount)
})
1
2
3
4
5
6
7
8
9
10
11

remoteQuery9+

remoteQuery(device: string, table: string, predicates: RdbPredicatesV9, columns: Array<string>): Promise<ResultSetV9>

根据指定条件查询远程设备数据库中的数据。使用Promise异步回调。

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

参数：

参数名 类型 必填 说明
device string 是 指定的远程设备的networkId。
table string 是 指定的目标表名。
predicates RdbPredicatesV9 是 RdbPredicatesV9的实例对象，指定查询的条件。
columns Array<string> 是 表示要查询的列。如果值为空，则查询应用于所有列。

返回值：

类型 说明
Promise<ResultSetV9> Promise对象。如果操作成功，则返回ResultSetV9对象。

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9('EMPLOYEE')
predicatesV9.greaterThan("id", 0)
let promise = rdbStoreV9.remoteQuery("deviceId", "EMPLOYEE", predicatesV9, ["ID", "NAME", "AGE", "SALARY", "CODES"])
promise.then((resultSetV9) => {
    console.info("ResultSet column names: " + resultSetV9.columnNames)
    console.info("ResultSet column count: " + resultSetV9.columnCount)
}).catch((err) => {
    console.info("Failed to remoteQuery , err: " + err)
})
1
2
3
4
5
6
7
8
9

querySql9+

querySql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallback<ResultSetV9>):void

根据指定SQL语句查询数据库中的数据，使用callback异步回调。

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

参数：

参数名 类型 必填 说明
sql string 是 指定要执行的SQL语句。
bindArgs Array<ValueType> 是 SQL语句中参数的值。
callback AsyncCallback<ResultSetV9> 是 指定callback回调函数。如果操作成功，则返回ResultSetV9对象。

示例：

rdbStoreV9.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo'], function (err, resultSetV9) {
    if (err) {
        console.info("Query failed, err: " + err)
        return
    }
    console.log("ResultSet column names: " + resultSetV9.columnNames)
    console.log("ResultSet column count: " + resultSetV9.columnCount)
})
1
2
3
4
5
6
7
8

querySql9+

querySql(sql: string, bindArgs?: Array<ValueType>):Promise<ResultSetV9>

根据指定SQL语句查询数据库中的数据，使用Promise异步回调。

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

参数：

参数名 类型 必填 说明
sql string 是 指定要执行的SQL语句。
bindArgs Array<ValueType> 否 SQL语句中参数的值。

返回值：

类型 说明
Promise<ResultSetV9> Promise对象。如果操作成功，则返回ResultSetV9对象。

示例：

let promise = rdbStoreV9.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo'])
promise.then((resultSetV9) => {
    console.log("ResultSet column names: " + resultSetV9.columnNames)
    console.log("ResultSet column count: " + resultSetV9.columnCount)
}).catch((err) => {
    console.info("Query failed, err: " + err)
})
1
2
3
4
5
6
7

executeSql9+

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

执行包含指定参数但不返回值的SQL语句，使用callback异步回调。

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

参数：

参数名 类型 必填 说明
sql string 是 指定要执行的SQL语句。
bindArgs Array<ValueType> 是 SQL语句中参数的值。
callback AsyncCallback<void> 是 指定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)"
rdbStoreV9.executeSql(SQL_CREATE_TABLE, null, function(err) {
    if (err) {
        console.info("ExecuteSql failed, err: " + err)
        return
    }
    console.info('Create table done.')
})
1
2
3
4
5
6
7
8

executeSql9+

executeSql(sql: string, bindArgs?: Array<ValueType>):Promise<void>

执行包含指定参数但不返回值的SQL语句，使用Promise异步回调。

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

参数：

参数名 类型 必填 说明
sql string 是 指定要执行的SQL语句。
bindArgs Array<ValueType> 否 SQL语句中参数的值。

返回值：

类型 说明
Promise<void> 无返回结果的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 = rdbStoreV9.executeSql(SQL_CREATE_TABLE)
promise.then(() => {
    console.info('Create table done.')
}).catch((err) => {
    console.info("ExecuteSql failed, err: " + err)
})
1
2
3
4
5
6
7

beginTransaction9+

beginTransaction():void

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

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

示例：

import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
const STORE_CONFIG = { name: "RdbTest.db",
                     securityLevel: data_rdb.SecurityLevel.S1}
data_rdb.getRdbStoreV9(context, STORE_CONFIG, 1, async function (err, rdbStoreV9) {
    rdbStoreV9.beginTransaction()
	const valueBucket = {
		"name": "lisi",
		"age": 18,
		"salary": 100.5,
		"blobType": new Uint8Array([1, 2, 3]),
	}
	await rdbStoreV9.insert("test", valueBucket)
	rdbStoreV9.commit()
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

commit9+

commit():void

提交已执行的SQL语句。

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

示例：

import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
const STORE_CONFIG = { name: "RdbTest.db",
                     securityLevel: data_rdb.SecurityLevel.S1}
data_rdb.getRdbStoreV9(context, STORE_CONFIG, 1, async function (err, rdbStoreV9) {
    rdbStoreV9.beginTransaction()
	const valueBucket = {
		"name": "lisi",
		"age": 18,
		"salary": 100.5,
		"blobType": new Uint8Array([1, 2, 3]),
	}
	await rdbStoreV9.insert("test", valueBucket)
	rdbStoreV9.commit()
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

rollBack9+

rollBack():void

回滚已经执行的SQL语句。

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

示例：

import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
const STORE_CONFIG = { name: "RdbTest.db",
                     securityLevel: data_rdb.SecurityLevel.S1}
data_rdb.getRdbStoreV9(context, STORE_CONFIG, 1, async function (err, rdbStoreV9) {
    try {
		rdbStoreV9.beginTransaction()
		const valueBucket = {
			"id": 1,
			"name": "lisi",
			"age": 18,
			"salary": 100.5,
			"blobType": new Uint8Array([1, 2, 3]),
		}
		await rdbStoreV9.insert("test", valueBucket)
		rdbStoreV9.commit()
	} catch (e) {
		rdbStoreV9.rollBack()
	}
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

backup9+

backup(destName:string, callback: AsyncCallback<void>):void

以指定名称备份数据库，使用callback异步回调。

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

参数：

参数名 类型 必填 说明
destName string 是 指定数据库的备份文件名。
callback AsyncCallback<void> 是 指定callback回调函数。

示例：

rdbStoreV9.backup("dbBackup.db", function(err) {
    if (err) {
        console.info('Backup failed, err: ' + err)
        return
    }
    console.info('Backup success.')
})
1
2
3
4
5
6
7

backup9+

backup(destName:string): Promise<void>

以指定名称备份数据库，使用Promise异步回调。

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

参数：

参数名 类型 必填 说明
destName string 是 指定数据库的备份文件名。

返回值：

类型 说明
Promise<void> 无返回结果的Promise对象。

示例：

let promiseBackup = rdbStoreV9.backup("dbBackup.db")
promiseBackup.then(()=>{
    console.info('Backup success.')
}).catch((err)=>{
    console.info('Backup failed, err: ' + err)
})
1
2
3
4
5
6

restore9+

restore(srcName:string, callback: AsyncCallback<void>):void

从指定的数据库备份文件恢复数据库，使用callback异步回调。

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

参数：

参数名 类型 必填 说明
srcName string 是 指定数据库的备份文件名。
callback AsyncCallback<void> 是 指定callback回调函数。

示例：

rdbStoreV9.restore("dbBackup.db", function(err) {
    if (err) {
        console.info('Restore failed, err: ' + err)
        return
    }
    console.info('Restore success.')
})
1
2
3
4
5
6
7

restore9+

restore(srcName:string): Promise<void>

从指定的数据库备份文件恢复数据库，使用Promise异步回调。

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

参数：

参数名 类型 必填 说明
srcName string 是 指定数据库的备份文件名。

返回值：

类型 说明
Promise<void> 无返回结果的Promise对象。

示例：

let promiseRestore = rdbStoreV9.restore("dbBackup.db")
promiseRestore.then(()=>{
    console.info('Restore success.')
}).catch((err)=>{
    console.info('Restore failed, err: ' + err)
})
1
2
3
4
5
6

setDistributedTables9+

setDistributedTables(tables: Array<string>, callback: AsyncCallback<void>): void

设置分布式列表，使用callback异步回调。

需要权限： ohos.permission.DISTRIBUTED_DATASYNC

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

参数：

参数名 类型 必填 说明
tables Array<string> 是 要设置的分布式列表表名
callback AsyncCallback<void> 是 指定callback回调函数。

示例：

rdbStoreV9.setDistributedTables(["EMPLOYEE"], function (err) {
    if (err) {
        console.info('SetDistributedTables failed, err: ' + err)
        return
    }
    console.info('SetDistributedTables successfully.')
})
1
2
3
4
5
6
7

setDistributedTables9+

setDistributedTables(tables: Array<string>): Promise<void>

设置分布式列表，使用Promise异步回调。

需要权限： ohos.permission.DISTRIBUTED_DATASYNC

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

参数：

参数名 类型 必填 说明
tables Array<string> 是 要设置的分布式列表表名。

返回值：

类型 说明
Promise<void> 无返回结果的Promise对象。

示例：

let promise = rdbStoreV9.setDistributedTables(["EMPLOYEE"])
promise.then(() => {
    console.info("SetDistributedTables successfully.")
}).catch((err) => {
    console.info("SetDistributedTables failed, err: " + err)
})
1
2
3
4
5
6

obtainDistributedTableName9+

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

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

需要权限： ohos.permission.DISTRIBUTED_DATASYNC

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

参数：

参数名 类型 必填 说明
device string 是 远程设备 。
table string 是 本地表名。
callback AsyncCallback<string> 是 指定的callback回调函数。如果操作成功，返回远程设备的分布式表名。

示例：

rdbStoreV9.obtainDistributedTableName("12345678abcde", "EMPLOYEE", function (err, tableName) {
    if (err) {
        console.info('ObtainDistributedTableName failed, err: ' + err)
        return
    }
    console.info('ObtainDistributedTableName successfully, tableName=.' + tableName)
})
1
2
3
4
5
6
7

obtainDistributedTableName9+

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

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

需要权限： ohos.permission.DISTRIBUTED_DATASYNC

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

参数：

参数名 类型 必填 说明
device string 是 远程设备。
table string 是 本地表名。

返回值：

类型 说明
Promise<string> Promise对象。如果操作成功，返回远程设备的分布式表名。

示例：

let promise = rdbStoreV9.obtainDistributedTableName("12345678abcde", "EMPLOYEE")
promise.then((tableName) => {
    console.info('ObtainDistributedTableName successfully, tableName= ' + tableName)
}).catch((err) => {
    console.info('ObtainDistributedTableName failed, err: ' + err)
})
1
2
3
4
5
6

sync9+

sync(mode: SyncMode, predicates: RdbPredicatesV9, callback: AsyncCallback<Array<[string, number]>>): void

在设备之间同步数据, 使用callback异步回调。

需要权限： ohos.permission.DISTRIBUTED_DATASYNC

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

参数：

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

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9('EMPLOYEE')
predicatesV9.inDevices(['12345678abcde'])
rdbStoreV9.sync(data_rdb.SyncMode.SYNC_MODE_PUSH, predicatesV9, 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])
    }
})
1
2
3
4
5
6
7
8
9
10
11
12

sync9+

sync(mode: SyncMode, predicates: RdbPredicatesV9): Promise<Array<[string, number]>>

在设备之间同步数据，使用Promise异步回调。

需要权限： ohos.permission.DISTRIBUTED_DATASYNC

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

参数：

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

返回值：

类型 说明
Promise<Array<[string, number]>> Promise对象，用于向调用者发送同步结果。string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。

示例：

let predicatesV9 = new data_rdb.RdbPredicatesV9('EMPLOYEE')
predicatesV9.inDevices(['12345678abcde'])
let promise = rdbStoreV9.sync(data_rdb.SyncMode.SYNC_MODE_PUSH, predicatesV9)
promise.then((resultSetV9) =>{
    console.log('Sync done.')
    for (let i = 0; i < resultSetV9.length; i++) {
        console.log('device=' + resultSetV9[i][0] + ' status=' + resultSetV9[i][1])
    }
}).catch((err) => {
    console.log('Sync failed')
})
1
2
3
4
5
6
7
8
9
10
11

on('dataChange')9+

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

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

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

参数：

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

示例：

function storeObserver(devices) {
    for (let i = 0; i < devices.length; i++) {
        console.log('device=' + devices[i] + ' data changed')
    }
}
try {
    rdbStoreV9.on('dataChange', data_rdb.SubscribeType.SUBSCRIBE_TYPE_REMOTE, storeObserver)
} catch (err) {
    console.log('Register observer failed')
}
1
2
3
4
5
6
7
8
9
10

off('dataChange')9+

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

从数据库中删除指定类型的指定观察者, 使用callback异步回调。

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

参数：

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

示例：

function storeObserver(devices) {
    for (let i = 0; i < devices.length; i++) {
        console.log('device=' + devices[i] + ' data changed')
    }
}
try {
    rdbStoreV9.off('dataChange', data_rdb.SubscribeType.SUBSCRIBE_TYPE_REMOTE, storeObserver)
} catch (err) {
    console.log('Unregister observer failed')
}
1
2
3
4
5
6
7
8
9
10

StoreConfigV99+

管理关系数据库配置。

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

名称 类型 必填 说明
name string 是 数据库文件名。
securityLevel SecurityLevel 是 设置数据库安全级别
encrypt boolean 否 指定数据库是否加密。
true:加密。
false:非加密。

SecurityLevel9+

数据库的安全级别枚举。

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

名称 值 说明
S1 1 表示数据库的安全级别为低级别，当数据泄露时会产生较低影响。例如，包含壁纸等系统数据的数据库。
S2 2 表示数据库的安全级别为中级别，当数据泄露时会产生较大影响。例如，包含录音、视频等用户生成数据或通话记录等信息的数据库。
S3 3 表示数据库的安全级别为高级别，当数据泄露时会产生重大影响。例如，包含用户运动、健康、位置等信息的数据库。
S4 4 表示数据库的安全级别为关键级别，当数据泄露时会产生严重影响。例如，包含认证凭据、财务数据等信息的数据库。

ValueType

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

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

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

ValuesBucket

用于存储键值对的类型。

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

键类型 值类型
string ValueType| Uint8Array | null

SyncMode8+

指数据库同步模式。

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

名称 值 说明
SYNC_MODE_PUSH 0 表示数据从本地设备推送到远程设备。
SYNC_MODE_PULL 1 表示数据从远程设备拉至本地设备。

SubscribeType8+

描述订阅类型。

需要权限： ohos.permission.DISTRIBUTED_DATASYNC

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

名称 值 说明
SUBSCRIBE_TYPE_REMOTE 0 订阅远程数据更改。

RdbPredicates(deprecated)

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

说明：

从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用RdbPredicatesV9替代。

constructor(deprecated)

constructor(name: string)

构造函数。

说明：

从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用constructor替代。

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

参数：

参数名 类型 必填 说明
name string 是 数据库表名。

示例：

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

inDevices(deprecated)

inDevices(devices: Array<string>): RdbPredicates

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

说明：

从 API Version 8 开始支持，从 API Version 9 开始废弃，建议使用inDevices替代。

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

参数：

参数名 类型 必填 说明
devices Array<string> 是 指定的组网内的远程设备ID。

返回值：

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

示例：

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

inAllDevices(deprecated)

inAllDevices(): RdbPredicates

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

说明：

从 API Version 8 开始支持，从 API Version 9 开始废弃，建议使用inAllDevices替代。

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

返回值：

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

示例：

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

equalTo(deprecated)

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

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

说明：

从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用equalTo替代。

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

参数：

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

返回值：

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

示例：

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

notEqualTo(deprecated)

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

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

说明：

从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用notEqualTo替代。

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

参数：

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

返回值：

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

示例：

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

beginWrap(deprecated)

beginWrap(): RdbPredicates

向谓词添加左括号。

说明：

从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用beginWrap替代。

系统能力： 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()
1
2
3
4
5
6
7

endWrap(deprecated)

endWrap(): RdbPredicates

向谓词添加右括号。

说明：

从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用endWrap替代。

系统能力： 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()
1
2
3
4
5
6
7

or(deprecated)

or(): RdbPredicates

将或条件添加到谓词中。

说明：

从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用or替代。

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

返回值：

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

示例：

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

and(deprecated)

and(): RdbPredicates

向谓词添加和条件。

说明：

从 API Version 7 开始支持，从 API Version 9 开始废弃，建议使用and替代。

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

返回值：

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

示例：

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

contains(deprecated)

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

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

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用contains替代。

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

参数：

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

返回值：

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

示例：

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

beginsWith(deprecated)

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

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

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用beginsWith替代。

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

参数：

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

返回值：

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

示例：

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

endsWith(deprecated)

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

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

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用endsWith替代。

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

参数：

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

返回值：

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

示例：

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

isNull(deprecated)

isNull(field: string): RdbPredicates

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

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用isNull替代。

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

参数：

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

返回值：

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

示例：

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.isNull("NAME")
1
2

isNotNull(deprecated)

isNotNull(field: string): RdbPredicates

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

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用isNotNull替代。

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

参数：

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

返回值：

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

示例：

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

like(deprecated)

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

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

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用like替代。

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

参数：

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

返回值：

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

示例：

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

glob(deprecated)

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

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

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用glob替代。

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

参数：

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

返回值：

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

示例：

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

between(deprecated)

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

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

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用between替代。

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

参数：

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

返回值：

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

示例：

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

notBetween(deprecated)

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

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

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用notBetween替代。

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

参数：

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

返回值：

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

示例：

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

greaterThan(deprecated)

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

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

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用greaterThan替代。

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

参数：

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

返回值：

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

示例：

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

lessThan(deprecated)

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

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

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用lessThan替代。

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

参数：

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

返回值：

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

示例：

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

greaterThanOrEqualTo(deprecated)

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

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

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用greaterThanOrEqualTo替代。

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

参数：

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

返回值：

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

示例：

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

lessThanOrEqualTo(deprecated)

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

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

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用lessThanOrEqualTo替代。

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

参数：

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

返回值：

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

示例：

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

orderByAsc(deprecated)

orderByAsc(field: string): RdbPredicates

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

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用orderByAsc替代。

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

参数：

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

返回值：

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

示例：

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

orderByDesc(deprecated)

orderByDesc(field: string): RdbPredicates

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

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用orderByDesc替代。

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

参数：

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

返回值：

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

示例：

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

distinct(deprecated)

distinct(): RdbPredicates

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

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用distinct替代。

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

返回值：

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

示例：

let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.equalTo("NAME", "Rose").distinct()
1
2

limitAs(deprecated)

limitAs(value: number): RdbPredicates

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

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用limitAs替代。

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

参数：

参数名 类型 必填 说明
value number 是 最大数据记录数。

返回值：

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

示例：

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

offsetAs(deprecated)

offsetAs(rowOffset: number): RdbPredicates

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

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用offsetAs替代。

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

参数：

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

返回值：

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

示例：

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

groupBy(deprecated)

groupBy(fields: Array<string>): RdbPredicates

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

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用groupBy替代。

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

参数：

参数名 类型 必填 说明
fields Array<string> 是 指定分组依赖的列名。

返回值：

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

示例：

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

indexedBy(deprecated)

indexedBy(field: string): RdbPredicates

配置RdbPredicates以指定索引列。

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用indexedBy替代。

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

参数：

参数名 类型 必填 说明
field string 是 索引列的名称。

返回值：

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

示例：

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

in(deprecated)

in(field: string, value: Array<ValueType>): RdbPredicates

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

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用in替代。

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

参数：

参数名 类型 必填 说明
field string 是 数据库表中的列名。
value Array<ValueType> 是 以ValueType型数组形式指定的要匹配的值。

返回值：

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

示例：

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

notIn(deprecated)

notIn(field: string, value: Array<ValueType>): RdbPredicates

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

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用notIn替代。

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

参数：

参数名 类型 必填 说明
field string 是 数据库表中的列名。
value Array<ValueType> 是 以ValueType数组形式指定的要匹配的值。

返回值：

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

示例：

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

RdbStore(deprecated)

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

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用RdbStoreV9替代。

在使用以下相关接口前，请使用executeSql接口初始化数据库表结构和相关数据，具体可见关系型数据库开发指导。

insert(deprecated)

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

向目标表中插入一行数据，使用callback异步回调。

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用insert替代。

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

参数：

参数名 类型 必填 说明
table string 是 指定的目标表名。
values ValuesBucket 是 表示要插入到表中的数据行。
callback AsyncCallback<number> 是 指定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 (status, rowId) {
    if (status) {
        console.log("Insert is failed");
        return;
    }
    console.log("Insert is successful, rowId = " + rowId);
})
1
2
3
4
5
6
7
8
9
10
11
12
13

insert(deprecated)

insert(table: string, values: ValuesBucket):Promise<number>

向目标表中插入一行数据，使用Promise异步回调。

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用insert替代。

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

参数：

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

返回值：

类型 说明
Promise<number> 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((rowId) => {
    console.log("Insert is successful, rowId = " + rowId);
}).catch((status) => {
    console.log("Insert is failed");
})
1
2
3
4
5
6
7
8
9
10
11
12

batchInsert(deprecated)

batchInsert(table: string, values: Array<ValuesBucket>, callback: AsyncCallback<number>):void

向目标表中插入一组数据，使用callback异步回调。

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用batchInsert替代。

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

参数：

参数名 类型 必填 说明
table string 是 指定的目标表名。
values Array<ValuesBucket> 是 表示要插入到表中的一组数据。
callback AsyncCallback<number> 是 指定callback回调函数。如果操作成功，返回插入的数据个数，否则返回-1。

示例：

const valueBucket1 = {
    "NAME": "Lisa",
    "AGE": 18,
    "SALARY": 100.5,
    "CODES": new Uint8Array([1, 2, 3, 4, 5])
}
const valueBucket2 = {
    "NAME": "Jack",
    "AGE": 19,
    "SALARY": 101.5,
    "CODES": new Uint8Array([6, 7, 8, 9, 10])
}
const valueBucket3 = {
    "NAME": "Tom",
    "AGE": 20,
    "SALARY": 102.5,
    "CODES": new Uint8Array([11, 12, 13, 14, 15])
}

let valueBuckets = new Array(valueBucket1, valueBucket2, valueBucket3);
rdbStore.batchInsert("EMPLOYEE", valueBuckets, function(status, insertNum) {
    if (status) {
        console.log("batchInsert is failed, status = " + status);
        return;
    }
    console.log("batchInsert is successful, the number of values that were inserted = " + insertNum);
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

batchInsert(deprecated)

batchInsert(table: string, values: Array<ValuesBucket>):Promise<number>

向目标表中插入一组数据，使用Promise异步回调。

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用batchInsert替代。

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

参数：

参数名 类型 必填 说明
table string 是 指定的目标表名。
values Array<ValuesBucket> 是 表示要插入到表中的一组数据。

返回值：

类型 说明
Promise<number> Promise对象。如果操作成功，返回插入的数据个数，否则返回-1。

示例：

const valueBucket1 = {
    "NAME": "Lisa",
    "AGE": 18,
    "SALARY": 100.5,
    "CODES": new Uint8Array([1, 2, 3, 4, 5])
}
const valueBucket2 = {
    "NAME": "Jack",
    "AGE": 19,
    "SALARY": 101.5,
    "CODES": new Uint8Array([6, 7, 8, 9, 10])
}
const valueBucket3 = {
    "NAME": "Tom",
    "AGE": 20,
    "SALARY": 102.5,
    "CODES": new Uint8Array([11, 12, 13, 14, 15])
}

let valueBuckets = new Array(valueBucket1, valueBucket2, valueBucket3);
let promise = rdbStore.batchInsert("EMPLOYEE", valueBuckets);
promise.then((insertNum) => {
    console.log("batchInsert is successful, the number of values that were inserted = " + insertNum);
}).catch((status) => {
    console.log("batchInsert is failed, status = " + status);
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

update(deprecated)

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

根据RdbPredicates的指定实例对象更新数据库中的数据，使用callback异步回调。

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用update替代。

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

参数：

参数名 类型 必填 说明
values ValuesBucket 是 values指示数据库中要更新的数据行。键值对与数据库表的列名相关联。
predicates RdbPredicates 是 RdbPredicates的实例对象指定的更新条件。
callback AsyncCallback<number> 是 指定的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)
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

update(deprecated)

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

根据RdbPredicates的指定实例对象更新数据库中的数据，使用Promise异步回调。

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用update替代。

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

参数：

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

返回值：

类型 说明
Promise<number> 指定的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)
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14

delete(deprecated)

delete(predicates: RdbPredicates, callback: AsyncCallback<number>):void

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

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用delete替代。

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

参数：

参数名 类型 必填 说明
predicates RdbPredicates 是 RdbPredicates的实例对象指定的删除条件。
callback AsyncCallback<number> 是 指定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)
})
1
2
3
4
5
6
7
8
9

delete(deprecated)

delete(predicates: RdbPredicates):Promise<number>

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

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用delete替代。

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

参数：

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

返回值：

类型 说明
Promise<number> 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)
})
1
2
3
4
5
6
7
8

query(deprecated)

query(predicates: RdbPredicates, columns: Array<string>, callback: AsyncCallback<ResultSet>):void

根据指定条件查询数据库中的数据，使用callback异步回调。

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用query替代。

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

参数：

参数名 类型 必填 说明
predicates RdbPredicates 是 RdbPredicates的实例对象指定的查询条件。
columns Array<string> 是 表示要查询的列。如果值为空，则查询应用于所有列。
callback AsyncCallback<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)
})
1
2
3
4
5
6
7
8
9
10

query(deprecated)

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

根据指定条件查询数据库中的数据，使用Promise异步回调。

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用query替代。

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

参数：

参数名 类型 必填 说明
predicates RdbPredicates 是 RdbPredicates的实例对象指定的查询条件。
columns Array<string> 否 表示要查询的列。如果值为空，则查询应用于所有列。

返回值：

类型 说明
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)
})
1
2
3
4
5
6
7
8
9

querySql(deprecated)

querySql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallback<ResultSet>):void

根据指定SQL语句查询数据库中的数据，使用callback异步回调。

说明：

从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用querySql替代。

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

参数：

参数名 类型 必填 说明
sql string 是 指定要执行的SQL语句。
bindArgs Array<ValueType> 是 SQL语句中参数的值。
callback AsyncCallback<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)
})
1
2
3
4
5
6
7
8

querySql(deprecated)

querySql(sql: string, bindArgs?: Array<ValueType>):Promise<ResultSet>

根据指定SQL语句查询数据库中的数据，使用Promise异步回调。

说明：

从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用querySql替代。

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

参数：

参数名 类型 必填 说明
sql string 是 指定要执行的SQL语句。
bindArgs Array<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)
})
1
2
3
4
5
6
7

executeSql(deprecated)

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

执行包含指定参数但不返回值的SQL语句，使用callback异步回调。

说明：

从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用executeSql替代。

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

参数：

参数名 类型 必填 说明
sql string 是 指定要执行的SQL语句。
bindArgs Array<ValueType> 是 SQL语句中参数的值。
callback AsyncCallback<void> 是 指定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.')
})
1
2
3
4
5
6
7
8

executeSql(deprecated)

executeSql(sql: string, bindArgs?: Array<ValueType>):Promise<void>

执行包含指定参数但不返回值的SQL语句，使用Promise异步回调。

说明：

从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用executeSql替代。

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

参数：

参数名 类型 必填 说明
sql string 是 指定要执行的SQL语句。
bindArgs Array<ValueType> 否 SQL语句中参数的值。

返回值：

类型 说明
Promise<void> 无返回结果的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)
})
1
2
3
4
5
6
7

beginTransaction(deprecated)

beginTransaction():void

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

说明：

从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用beginTransaction替代。

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

示例：

import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
const STORE_CONFIG = { name: "RdbTest.db"}
data_rdb.getRdbStore(context, STORE_CONFIG, 1, async function (err, rdbStore) {
    rdbStore.beginTransaction()
	const valueBucket = {
		"name": "lisi",
		"age": 18,
		"salary": 100.5,
		"blobType": new Uint8Array([1, 2, 3]),
	}
	await rdbStore.insert("test", valueBucket)
	rdbStore.commit()
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14

commit(deprecated)

commit():void

提交已执行的SQL语句。

说明：

从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用commit替代。

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

示例：

import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
const STORE_CONFIG = { name: "RdbTest.db"}
data_rdb.getRdbStore(context, STORE_CONFIG, 1, async function (err, rdbStore) {
    rdbStore.beginTransaction()
	const valueBucket = {
		"name": "lisi",
		"age": 18,
		"salary": 100.5,
		"blobType": new Uint8Array([1, 2, 3]),
	}
	await rdbStore.insert("test", valueBucket)
	rdbStore.commit()
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14

rollBack(deprecated)

rollBack():void

回滚已经执行的SQL语句。

说明：

从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用rollBack替代。

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

示例：

import featureAbility from '@ohos.ability.featureAbility'
let context = featureAbility.getContext()
const STORE_CONFIG = { name: "RdbTest.db"}
data_rdb.getRdbStore(context, STORE_CONFIG, 1, async function (err, rdbStore) {
    try {
		rdbStore.beginTransaction()
		const valueBucket = {
			"id": 1,
			"name": "lisi",
			"age": 18,
			"salary": 100.5,
			"blobType": new Uint8Array([1, 2, 3]),
		}
		await rdbStore.insert("test", valueBucket)
		rdbStore.commit()
	} catch (e) {
		rdbStore.rollBack()
	}
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

setDistributedTables(deprecated)

setDistributedTables(tables: Array<string>, callback: AsyncCallback<void>): void

设置分布式列表，使用callback异步回调。

说明：

从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用setDistributedTables替代。

需要权限： ohos.permission.DISTRIBUTED_DATASYNC

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

参数：

参数名 类型 必填 说明
tables Array<string> 是 要设置的分布式列表表名
callback AsyncCallback<void> 是 指定callback回调函数。

示例：

rdbStore.setDistributedTables(["EMPLOYEE"], function (err) {
    if (err) {
        console.info('SetDistributedTables failed, err: ' + err)
        return
    }
    console.info('SetDistributedTables successfully.')
})
1
2
3
4
5
6
7

setDistributedTables(deprecated)

setDistributedTables(tables: Array<string>): Promise<void>

设置分布式列表，使用Promise异步回调。

说明：

从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用setDistributedTables替代。

需要权限： ohos.permission.DISTRIBUTED_DATASYNC

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

参数：

参数名 类型 必填 说明
tables Array<string> 是 要设置的分布式列表表名。

返回值：

类型 说明
Promise<void> 无返回结果的Promise对象。

示例：

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

obtainDistributedTableName(deprecated)

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

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

说明：

从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用obtainDistributedTableName替代。

需要权限： ohos.permission.DISTRIBUTED_DATASYNC

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

参数：

参数名 类型 必填 说明
device string 是 远程设备 。
table string 是 本地表名。
callback AsyncCallback<string> 是 指定的callback回调函数。如果操作成功，返回远程设备的分布式表名。

示例：

rdbStore.obtainDistributedTableName("12345678abcde", "EMPLOYEE", function (err, tableName) {
    if (err) {
        console.info('ObtainDistributedTableName failed, err: ' + err)
        return
    }
    console.info('ObtainDistributedTableName successfully, tableName=.' + tableName)
})
1
2
3
4
5
6
7

obtainDistributedTableName(deprecated)

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

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

说明：

从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用obtainDistributedTableName替代。

需要权限： ohos.permission.DISTRIBUTED_DATASYNC

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

参数：

参数名 类型 必填 说明
device string 是 远程设备。
table string 是 本地表名。

返回值：

类型 说明
Promise<string> Promise对象。如果操作成功，返回远程设备的分布式表名。

示例：

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

sync(deprecated)

sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback<Array<[string, number]>>): void

在设备之间同步数据, 使用callback异步回调。

说明：

从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用sync替代。

需要权限： ohos.permission.DISTRIBUTED_DATASYNC

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

参数：

参数名 类型 必填 说明
mode SyncMode 是 指同步模式。该值可以是推、拉。
predicates RdbPredicates 是 约束同步数据和设备。
callback AsyncCallback<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])
    }
})
1
2
3
4
5
6
7
8
9
10
11
12

sync(deprecated)

sync(mode: SyncMode, predicates: RdbPredicates): Promise<Array<[string, number]>>

在设备之间同步数据，使用Promise异步回调。

说明：

从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用sync替代。

需要权限： 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')
})
1
2
3
4
5
6
7
8
9
10
11

on('dataChange')(deprecated)

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

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

说明：

从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用on替代。

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

参数：

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

示例：

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')
}
1
2
3
4
5
6
7
8
9
10

off('dataChange')(deprecated)

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

从数据库中删除指定类型的指定观察者, 使用callback异步回调。

说明：

从 API Version 8开始支持，从 API Version 9 开始废弃，建议使用off替代。

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

参数：

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

示例：

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')
}
1
2
3
4
5
6
7
8
9
10

StoreConfig(deprecated)

管理关系数据库配置。

说明：

从 API Version 7开始支持，从 API Version 9 开始废弃，建议使用StoreConfigV9替代。

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

名称 类型 必填 说明
name string 是 数据库文件名。