Skip to content

D
Docs

CDL_LuFei / Docs
与 Fork 源项目一致

Fork自 OpenHarmony / Docs

通知 1
Star 0
Fork 0
D
Docs

前往新版Gitcode，体验更适合开发者的 AI 搜索 >>

未验证 提交 963e8a44 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!1616 RDB资料更新 

Merge pull request !1616 from swx1134512/master
上级 88457c8b 64d41d7b
展开全部 隐藏空白更改
内联 并排
Showing with 2794 addition and 60 deletion
zh-cn/application-dev/database/database-relational-guidelines.md
浏览文件 @ 963e8a44
......@@ -76,6 +76,8 @@
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| RdbPredicates |inDevices(devices: Array<string>): RdbPredicates | 同步分布式数据库时指定组网内的远程设备。<br/>-&nbsp;devices：组网内指定的远程设备ID。<br/>-&nbsp;RdbPredicates：返回与指定字段匹配的谓词。 |
| RdbPredicates |inAllDevices(): RdbPredicates | 同步分布式数据库时连接到组网内的所有远程设备。<br/>-&nbsp;RdbPredicates：返回与指定字段匹配的谓词。 |
| RdbPredicates | equalTo(field:&nbsp;string,&nbsp;value:&nbsp;ValueType):&nbsp;RdbPredicates | 配置谓词以匹配数据字段为ValueType且值等于指定值的字段。<br/>-&nbsp;field：数据库表中的列名。<br/>-&nbsp;value：指示要与谓词匹配的值。<br/>-&nbsp;RdbPredicates：返回与指定字段匹配的谓词。 |
| RdbPredicates | notEqualTo(field:&nbsp;string,&nbsp;value:&nbsp;ValueType):&nbsp;RdbPredicates | 配置谓词以匹配数据字段为ValueType且值不等于指定值的字段。<br/>-&nbsp;field：数据库表中的列名。<br/>-&nbsp;value：指示要与谓词匹配的值。<br/>-&nbsp;RdbPredicates：返回与指定字段匹配的谓词。 |
| RdbPredicates | beginWrap():&nbsp;RdbPredicates | 向谓词添加左括号。<br/>-&nbsp;RdbPredicates：返回带有左括号的谓词。 |
......@@ -145,6 +147,54 @@
| RdbStore | changeEncryptKey(newEncryptKey:Uint8Array,&nbsp;callback:&nbsp;AsyncCallback&lt;number&gt;):void; | 数据库更改秘钥接口，通过callback&nbsp;可以异步处理返回结果。返回结果0成功，非0失败。 |
| RdbStore | changeEncryptKey(newEncryptKey:Uint8Array):&nbsp;Promise&lt;number&gt;; | 数据库更改秘钥接口，通过await&nbsp;可以同步处理返回结果。返回结果0成功，非0失败。 |
**设置分布式列表。**
用户可以对当前数据库中的列表设置为分布式列表。
**表9** 设置分布式列表
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| RdbStore | setDistributedTables(tables: Array<string>, callback: AsyncCallback<void>): void;| 设置分布式列表，结果以callback形式返回。<br/>-&nbsp;tables：要设置的分布式列表表名。<br/>-&nbsp;callback：指定callback回调函数。 |
| RdbStore | setDistributedTables(tables: Array<string>): Promise<void>; | 设置分布式列表，结果以Promise形式返回。<br/>-&nbsp;tables：要设置的分布式列表表名。 |
**根据本地表名获取指定远程设备的分布式表名。**
用户根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名。
**表10** 根据本地表名获取指定远程设备的分布式表名
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| RdbStore | obtainDistributedTableName(device: string, table: string, callback: AsyncCallback<string>): void; | 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名, 结果以callbck形式返回。<br/>-&nbsp;device：远程设备。<br/>-&nbsp;table：本地表名。<br/>-&nbsp;callback：指定的callback回调函数，如果操作成功，返回远程设备的分布式表名。 |
| RdbStore | obtainDistributedTableName(device: string, table: string): Promise<string>; | 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名，结果以Promise形式返回。<br/>-&nbsp;device：远程设备。<br/>-&nbsp;table：本地表名。 |
**在设备之间同步数据。**
**表11** 在设备之间同步数据
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| RdbStore | sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback<Array<[string, number]>>): void;| 在设备之间同步数据，结果以callback形式返回。<br/>-&nbsp;mode：指同步模式。SYNC_MODE_PUSH 表示数据从本地设备推送到远程设备；SYNC_MODE_PULL 表示数据从远程设备拉至本地设备。<br/>-&nbsp;predicates：约束同步数据和设备。<br/>-&nbsp;callback：指定的callback回调函数，string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。 |
| RdbStore | sync(mode: SyncMode, predicates: RdbPredicates): Promise<Array<[string, number]>>;| 在设备之间同步数据，结果以Promise形式返回。<br/>-&nbsp;mode：指同步模式。SYNC_MODE_PUSH 表示数据从本地设备推送到远程设备；SYNC_MODE_PULL 表示数据从远程设备拉至本地设备。<br/>-&nbsp;predicates：约束同步数据和设备。 |
**注册数据库的观察者。**
**表12** 注册数据库的观察者
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| RdbStore |on(event: 'dataChange', type: SubscribeType, observer: Callback<Array<string>>): void;| 注册数据库的观察者。当分布式数据库中的数据发生更改时，将调用回调。<br/>-&nbsp;type：指在{@code SubscribeType}中定义的订阅类型；SUBSCRIBE_TYPE_REMOTE 订阅远程数据更改。<br/>-&nbsp;observer：指分布式数据库中数据更改事件的观察者。 |
**从数据库中删除指定类型的指定观察者。**
**表13** 从数据库中删除指定类型的指定观察者
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| RdbStore |off(event:'dataChange', type: SubscribeType, observer: Callback<Array<string>>): void;| 从数据库中删除指定类型的指定观察者，结果以callbck形式返回。。<br/>-&nbsp;type：指在{@code SubscribeType}中定义的订阅类型；SUBSCRIBE_TYPE_REMOTE 订阅远程数据更改。<br/>-&nbsp;observer：指已注册的数据更改观察者。 |
## 开发步骤
......@@ -198,3 +248,69 @@
resultSet.close()
```
4. 设置分布式同步表。
1. 数据库调用接口设置分布式同步列表。
2. 判断是否设置成功。
示例代码如下：
```
let promise = rdbStore.setDistributedTables(["test"])
promise.then(() => {
console.info("setDistributedTables success.")
}).catch((err) => {
console.info("setDistributedTables failed."")
})
```
5. 分布式数据同步。
1. 构造用于同步分布式表的谓词对象，指定组网内的远程设备。
2. 调用同步数据的接口 。
3. 判断是否数据同步成功。
示例代码如下：
```
let predicate = new dataRdb.RdbPredicates('test')
predicate.inDevices(['12345678abcde'])
let promise = rdbStore.sync(rdb.SyncMode.SYNC_MODE_PUSH, predicate)
promise.then(result) {
console.log('sync done.')
for (let i = 0; i < result.length; i++) {
console.log('device=' + result[i][0] + ' status=' + result[i][1])
}
}).catch((err) => {
console.log('sync failed')
})
```
6. 分布式数据订阅。
1. 调用分布式数据订阅接口，注册数据库的观察者。
2. 当分布式数据库中的数据发生更改时，将调用回调。
示例代码如下：
```
function storeObserver(devices) {
for (let i = 0; i < devices.length; i++) {
console.log('device=' + device[i] + ' data changed')
}
}
try {
rdbStore.on('dataChange', rdb.SubscribeType.SUBSCRIBE_TYPE_REMOTE, storeObserver)
} catch (err) {
console.log('register observer failed')
}
```
7. 跨设备查询。
1. 根据本地表名获取指定远程设备的分布式表名。
2. 调用结果集接口，返回查询结果。
示例代码如下：
```
let tableName = rdbStore.obtainDistributedTableName(deviceId, "test");
let resultSet = rdbStore.querySql("SELECT * FROM " + tableName)
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/Readme-CN.md
浏览文件 @ 963e8a44
......@@ -22,7 +22,8 @@
- [用户认证](js-apis-useriam-userauth.md)
- [访问控制](js-apis-abilityAccessCtrl.md)
- 数据管理
- [轻量级存储](js-apis-data-storage.md)
- [轻量级存储](js-apis-data-preferences.md)
- [轻量级存储（废弃 since 8）](js-apis-data-storage.md)
- [分布式数据管理](js-apis-distributed-data.md)
- [关系型数据库](js-apis-data-rdb.md)
- [结果集](js-apis-data-resultset.md)
......@@ -36,6 +37,7 @@
- [应用空间统计](js-apis-storage-statistics.md)
- [卷管理](js-apis-volumemanager.md)
- 账号管理
- [系统帐号管理](js-apis-osAccount.md)
- [分布式帐号管理](js-apis-distributed-account.md)
- [应用帐号管理](js-apis-appAccount.md)
- 电话服务
......
zh-cn/application-dev/reference/apis/js-apis-data-preferences.md 0 → 100644
浏览文件 @ 963e8a44
# 轻量级存储
轻量级存储为应用提供key-value键值型的文件数据处理能力，支持应用对数据进行轻量级存储及查询。数据存储形式为键值对，键的类型为字符串型，值的存储数据类型包括数字型、字符型、布尔型。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
```
import data_Preferences from '@ohos.data.preferences'
```
## 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| MAX_KEY_LENGTH | string | 是 | 否 | key的最大长度限制，大小为80字节。<br>**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core |
| MAX_VALUE_LENGTH | string | 是 | 否 | string类型value的最大长度限制，大小为8192字节。<br>**系统能力**：SystemCapability.DistributedDataManager.Preferences.Core |
## data_Preferences.getPreferences
### 系统能力
SystemCapability.DistributedDataManager.Preferences.Core
getPreferences(context: Context, name: string, callback: AsyncCallback&lt;Preferences&gt;): void
读取指定文件，将数据加载到Preferences实例，用于数据操作，使用callback形式返回结果。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | Context | 是 | 应用程序或功能的上下文 |
| name | string | 是 | 应用程序内部数据存储名称。 |
| callback | AsyncCallback&lt;[Preferences](#preferences)&gt; | 是 | 回调函数。 |
- 示例：
```
import Ability from '@ohos.application.Ability'
import data_Preferences from '@ohos.data.preferences'
var path = await this.context.getDataBaseDir()
data_Preferences.getPreferences(this.context, 'mystore', function (err, preferences) {
if (err) {
console.info("Get the preferences failed, path: " + path + '/mystore')
return;
}
preferences.putSync('startup', 'auto')
preferences.flushSync()
})
```
## data_Preferences.getPreferences
### 系统能力
SystemCapability.DistributedDataManager.Preferences.Core
getPreferences(context: Context, name: string): Promise&lt;Preferences&gt;
读取指定文件，将数据加载到Preferences实例，用于数据操作，使用Promise方式作为异步方法。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | Context | 是 | 应用程序或功能的上下文 |
| name | string | 是 | 应用程序内部数据存储名称。 |
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;[Preferences](#preferences)&gt; | Promise实例，用于异步获取结果。 |
- 示例：
```
import Ability from '@ohos.application.Ability'
import data_Preferences from '@ohos.data.preferences'
var path = await this.context.getDataBaseDir()
let promise = data_Preferences.getPreferences(this.context, 'mystore')
promise.then((preferences) => {
preferences.putSync('startup', 'auto')
preferences.flushSync()
}).catch((err) => {
console.info("Get the preferences failed, path: " + path + '/mystore')
})
```
## data_Preferences.deletePreferences
### 系统能力
SystemCapability.DistributedDataManager.Preferences.Core
deletePreferences(context: Context, name: string, callback: AsyncCallback&lt;void&gt;)
从内存中移除指定文件对应的Preferences单实例，并删除指定文件及其备份文件、损坏文件。删除指定文件时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题，使用callback方式作为异步方法。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | Context | 是 | 应用程序或功能的上下文 |
| name | string | 是 | 应用程序内部数据存储名称。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
- 示例：
```
import Ability from '@ohos.application.Ability'
import data_Preferences from '@ohos.data.preferences'
data_Preferences.deletePreferences(this.context, 'mystore', function (err) {
if (err) {
console.info("Deleted failed with err: " + err)
return
}
console.info("Deleted successfully.")
})
```
## data_Preferences.deletePreferences
### 系统能力
SystemCapability.DistributedDataManager.Preferences.Core
deletePreferences(context: Context, name: string): Promise&lt;void&gt;
从内存中移除指定文件对应的Preferences单实例，并删除指定文件及其备份文件、损坏文件。删除指定文件时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题，使用promise方式作为异步方法。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | Context | 是 | 应用程序或功能的上下文 |
| name | string | 是 | 应用程序内部数据存储名称。 |
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | Promise实例，用于异步获取结果。 |
- 示例：
```
import Ability from '@ohos.application.Ability'
import data_Preferences from '@ohos.data.preferences'
let promise = data_Preferences.deletePreferences(this.context, 'mystore')
promise.then(() => {
console.info("Deleted successfully.")
}).catch((err) => {
console.info("Deleted failed with err: " + err)
})
```
## data_Preferences.removePreferencesFromCache
### 系统能力
SystemCapability.DistributedDataManager.Preferences.Core
removePreferencesFromCache(context: Context, name: string, callback: AsyncCallback&lt;Preferences&gt;): void
从内存中移除指定文件对应的Preferences单实例。移除Preferences单实例时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题。
此方法为异步方法。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | Context | 是 | 应用程序或功能的上下文 |
| name | string | 是 | 应用程序内部数据存储名称。 |
| callback | AsyncCallback&lt;[Preferences](#preferences)&gt; | 是 | 回调函数。 |
- 示例：
```
import Ability from '@ohos.application.Ability'
import data_Preferences from '@ohos.data.preferences'
data_Preferences.removePreferencesFromCache(this.context, 'mystore', function (err) {
if (err) {
console.info("Removed preferences from cache failed with err: " + err)
return
}
console.info("Removed preferences from cache successfully.")
})
```
## data_Preferences.removePreferencesFromCache
### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
removePreferencesFromCache(context: Context, name: string): Promise&lt;void&gt;
从内存中移除指定文件对应的Preferences单实例。移除Preferences单实例时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题。
此方法为异步方法。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | Context | 是 | 应用程序或功能的上下文 |
| name | string | 是 | 应用程序内部数据存储名称。 |
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | Promise实例，用于异步获取结果。 |
- 示例：
```
import Ability from '@ohos.application.Ability'
import data_Preferences from '@ohos.data.preferences'
let promise = data_Preferences.removePreferencesFromCache(this.context, 'mystore')
promise.then(() => {
console.info("Removed preferences from cache successfully.")
}).catch((err) => {
console.info("Removed preferences from cache failed with err: " + err)
})
```
## Preferences
提供获取和修改存储数据的接口。
### get
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
get(key: string, defValue: ValueType, callback: AsyncCallback&lt;ValueType&gt;): void
获取键对应的值，如果值为null或者非默认值类型，返回默认数据。
此方法为异步方法。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称。它不能为空。 |
| defValue | ValueType | 是 | 默认返回值。支持number、string、boolean。 |
| callback | AsyncCallback&lt;ValueType&gt; | 是 | 回调函数。 |
- 示例：
```
preferences.get('startup', 'default', function(err, value) {
if (err) {
console.info("Get the value of startup failed with err: " + err)
return
}
console.info("The value of startup is " + value)
})
```
### get
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
get(key: string, defValue: ValueType): Promise&lt;ValueType&gt;
获取键对应的值，如果值为null或者非默认值类型，返默认数据。
此方法为异步方法。
- **参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称。它不能为空。 |
| defValue | ValueType | 是 | 默认返回值。支持number、string、boolean。 |
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;ValueType&gt; | Promise实例，用于异步获取结果。 |
- 示例：
```
let promise = preferences.get('startup', 'default')
promise.then((value) => {
console.info("The value of startup is " + value)
}).catch((err) => {
console.info("Get the value of startup failed with err: " + err)
})
```
### put
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
put(key: string, value: ValueType, callback: AsyncCallback&lt;void&gt;): void
首先获取指定文件对应的Preferences实例，然后借助Preferences API将数据写入Preferences实例，通过flush或者flushSync将Preferences实例持久化。
此方法为异步方法。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要修改的存储的key。它不能为空。 |
| value | ValueType | 是 | 存储的新值。支持number、string、boolean。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
- 示例：
```
preferences.put('startup', 'auto', function (err) {
if (err) {
console.info("Put the value of startup failed with err: " + err)
return
}
console.info("Put the value of startup successfully.")
})
```
### put
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
put(key: string, value: ValueType): Promise&lt;void&gt;
首先获取指定文件对应的Preferences实例，然后借助Preferences API将数据写入Preferences实例，通过flush或者flushSync将Preferences实例持久化。
此方法为异步方法。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要修改的存储的key。它不能为空。 |
| value | ValueType | 是 | 存储的新值。支持number、string、boolean。 |
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | Promise实例，用于异步处理。 |
- 示例：
```
let promise = preferences.put('startup', 'auto')
promise.then(() => {
console.info("Put the value of startup successfully.")
}).catch((err) => {
console.info("Put the value of startup failed with err: " + err)
})
```
### has
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
has(key: string, callback: AsyncCallback&lt;boolean&gt;): boolean
检查存储对象是否包含名为给定key的存储。
此方法为异步方法。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称，不能为空。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数。 |
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| boolean | true表示存在，false表示不存在。 |
- 示例：
```
preferences.has('startup', function (err, isExist) {
if (err) {
console.info("Check the key of startup failed with err: " + err)
return
}
if (isExist) {
console.info("The key of startup is contained.")
}
})
```
### has
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
has(key: string): Promise&lt;boolean&gt;
检查存储对象是否包含名为给定key的存储。
此方法为异步方法。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称。它不能为空。 |
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;boolean&gt; | Promise实例，用于异步处理。 |
- 示例：
```
let promise = preferences.has('startup')
promise.then((isExist) => {
if (isExist) {
console.info("The key of startup is contained.")
}
}).catch((err) => {
console.info("Check the key of startup failed with err: " + err)
})
```
### delete
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
delete(key: string, callback: AsyncCallback&lt;void&gt;): void
从存储对象中删除名为给定key的存储。
此方法为异步方法。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称，不能为空。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
- 示例：
```
preferences.delete('startup', function (err) {
if (err) {
console.info("Delete startup key failed with err: " + err)
return
}
console.info("Deleted startup key successfully.")
})
```
### delete
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
delete(key: string): Promise&lt;void&gt;
从存储对象删除名为给定key的存储。
此方法为异步方法。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | string | 是 | 要获取的存储key名称。 |
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | Promise实例，用于异步处理。 |
- 示例：
```
let promise = preferences.delete('startup')
promise.then(() => {
console.info("Deleted startup key successfully.")
}).catch((err) => {
console.info("Delete startup key failed with err: " + err)
})
```
### flush
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
flush(callback: AsyncCallback&lt;void&gt;): void
将当前preferences对象中的修改保存到当前的preferences，并异步存储到文件中。
此方法为异步方法。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
- 示例：
```
preferences.flush(function (err) {
if (err) {
console.info("Flush to file failed with err: " + err)
return
}
console.info("Flushed to file successfully.")
})
```
### flush
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
flush(): Promise&lt;void&gt;
将当前preferences对象中的修改保存到当前的preferences，并异步存储到文件中。
此方法为异步方法。
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | Promise实例，用于异步处理。 |
- 示例：
```
let promise = preferences.flush()
promise.then(() => {
console.info("Flushed to file successfully.")
}).catch((err) => {
console.info("Flush to file failed with err: " + err)
})
```
### clear
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
clear(callback: AsyncCallback&lt;void&gt;): void
清除此存储对象中的所有存储。
此方法为异步方法。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
- 示例：
```
preferences.clear(function (err) {
if (err) {
console.info("Clear to file failed with err: " + err)
return
}
console.info("Cleared to file successfully.")
})
```
### clear
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
clear(): Promise&lt;void&gt;
清除此存储对象中的所有存储。
此方法为异步方法。
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | Promise实例，用于异步处理。 |
- 示例：
```
let promise = preferences.clear()
promise.then(() => {
console.info("Cleared to file successfully.")
}).catch((err) => {
console.info("Clear to file failed with err: " + err)
})
```
### on('change')
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
on(type: 'change', callback: Callback&lt;{ key : string }&gt;): void
订阅数据变更者类，订阅的key的值发生变更后，在执行flush方法后，callback方法会被回调。
- 参数：
| 参数名 | 类型 | 说明 |
| -------- | -------- | -------- |
| type | string | 事件类型，固定值'change'，表示数据变更。 |
| callback | Callback&lt;{ key : string }&gt; | 回调对象实例。 |
- 示例：
```
var observer = function (key) {
console.info("The key of " + key + " changed.")
}
preferences.on('change', observer)
preferences.put('startup', 'auto')
preferences.flush() // observer will be called.
```
### off('change')
#### 系统能力 SystemCapability.DistributedDataManager.Preferences.Core
off(type: 'change', callback: Callback&lt;{ key : string }&gt;): void
当不再进行订阅数据变更时，使用此接口取消订阅。
- 参数：
| 参数名 | 类型 | 说明 |
| -------- | -------- | -------- |
| type | string | 事件类型，固定值'change'，表示数据变更。 |
| callback | Callback&lt;{ key : string }&gt; | 需要取消的回调对象实例。 |
- 示例：
```
var observer = function (key) {
console.info("The key of " + key + " changed.")
}
preferences.off('change', observer)
```
zh-cn/application-dev/reference/apis/js-apis-data-rdb.md
浏览文件 @ 963e8a44
......@@ -152,6 +152,48 @@ constructor(name: string)
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
```
### inDevices
inDevices(devices: Array<string>): RdbPredicates;
同步分布式数据库时指定组网内的远程设备。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| devices | Array<string> | 是 | 指定的组网内的远程设备ID。 |
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
- 示例：
```
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicate.inDevices(['12345678abcde'])
```
### inAllDevices
inAllDevices(): RdbPredicates;
同步分布式数据库时连接到组网内的所有远程设备。
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| [RdbPredicates](#rdbpredicates) | 返回与指定字段匹配的谓词。 |
- 示例：
```
let predicates = new data_rdb.RdbPredicates("EMPLOYEE")
predicates.inAllDevices()
```
### equalTo
......@@ -1183,6 +1225,224 @@ executeSql(sql: string, bindArgs?: Array&lt;ValueType&gt;):Promise&lt;void&gt;
promise.then(() => {
console.info(TAG + 'delete done.')})
```
### setDistributedTables
setDistributedTables(tables: Array<string>, callback: AsyncCallback<void>): void;
设置分布式列表，结果以callbck形式返回。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| tables | Array<string> | 是 | 要设置的分布式列表表名 |
| callback | AsyncCallback&lt;void&gt; | 是 | 指定callback回调函数。 |
- 示例：
```
rdbStore.setDistributedTables(["EMPLOYEE"], function (err) {
if (err) {
console.info('setDistributedTables failed.')
return
}
console.info('setDistributedTables success.')
})
```
### setDistributedTables
setDistributedTables(tables: Array<string>): Promise<void>;
设置分布式列表，结果以Promise形式返回。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| tables | Array<string> | 是 | 要设置的分布式列表表名。 |
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 指定Promise回调函数。 |
- 示例：
```
let promise = rdbStore.setDistributedTables(["EMPLOYEE"])
promise.then(() => {
console.info("setDistributedTables success.")
}).catch((err) => {
console.info("setDistributedTables failed."")
})
```
### obtainDistributedTableName
obtainDistributedTableName(device: string, table: string, callback: AsyncCallback<string>): void;
根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名, 结果以callbck形式返回。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| device | string | 是 | 远程设备 。|
| table | string | 是 | 本地表名。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 指定的callback回调函数。如果操作成功，返回远程设备的分布式表名。 |
- 示例：
```
rdbStore.obtainDistributedTableName(deviceId, "EMPLOYEE", function (err, tableName) {
if (err) {
console.info('obtainDistributedTableName failed.')
return
}
console.info('obtainDistributedTableName success, tableName=.' + tableName)
})
```
### obtainDistributedTableName
obtainDistributedTableName(device: string, table: string): Promise<string>;
根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名，结果以Promise形式返回。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| device | string | 是 | 远程设备。 |
| table | string | 是 | 本地表名。 |
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;string&gt; | 指定Promise回调函数。如果操作成功，返回远程设备的分布式表名。 |
- 示例：
```
let promise = rdbStore.obtainDistributedTableName(deviceId, "EMPLOYEE")
promise.then((tableName) => {
console.info('obtainDistributedTableName success, tableName=' + tableName)
}).catch((err) => {
console.info('obtainDistributedTableName failed.')
})
```
### sync
sync(mode: SyncMode, predicates: RdbPredicates, callback: AsyncCallback<Array<[string, number]>>): void;
在设备之间同步数据, 结果以callbck形式返回。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| mode | SyncMode | 是 | 指同步模式。该值可以是推、拉。 |
| predicates | RdbPredicates | 是 | 约束同步数据和设备。 |
| callback | AsyncCallback&lt;Array<[string, number]>&gt; | 是 | 指定的callback回调函数，用于向调用者发送同步结果。string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。|
- 示例：
```
let predicate = new rdb.RdbPredicates('EMPLOYEE')
predicate.inDevices(['12345678abcde'])
rdbStore.sync(rdb.SyncMode.SYNC_MODE_PUSH, predicate, function (err, result) {
if (err) {
console.log('sync failed')
return
}
console.log('sync done.')
for (let i = 0; i < result.length; i++) {
console.log('device=' + result[i][0] + ' status=' + result[i][1])
}
})
```
### sync
sync(mode: SyncMode, predicates: RdbPredicates): Promise<Array<[string, number]>>;
在设备之间同步数据，结果以Promise形式返回。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| mode | SyncMode | 是 | 指同步模式。该值可以是推、拉。 |
| predicates | RdbPredicates | 是 | 约束同步数据和设备。 |
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;Array<[string, number]>&gt; | 指定Promise回调函数，用于向调用者发送同步结果。string：设备ID；number：每个设备同步状态，0表示成功，其他值表示失败。 |
- 示例：
```
let predicate = new rdb.RdbPredicates('EMPLOYEE')
predicate.inDevices(['12345678abcde'])
let promise = rdbStore.sync(rdb.SyncMode.SYNC_MODE_PUSH, predicate)
promise.then(result) {
console.log('sync done.')
for (let i = 0; i < result.length; i++) {
console.log('device=' + result[i][0] + ' status=' + result[i][1])
}
}).catch((err) => {
console.log('sync failed')
})
```
### on
on(event: 'dataChange', type: SubscribeType, observer: Callback<Array<string>>): void;
注册数据库的观察者。当分布式数据库中的数据发生更改时，将调用回调。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | SubscribeType | 是 | 指在{@code SubscribeType}中定义的订阅类型。 |
| observer | Callback<Array<string>> | 是 | 指分布式数据库中数据更改事件的观察者。 |
- 示例：
```
function storeObserver(devices) {
for (let i = 0; i < devices.length; i++) {
console.log('device=' + device[i] + ' data changed')
}
}
try {
rdbStore.on('dataChange', rdb.SubscribeType.SUBSCRIBE_TYPE_REMOTE, storeObserver)
} catch (err) {
console.log('register observer failed')
}
```
### off
off(event:'dataChange', type: SubscribeType, observer: Callback<Array<string>>): void;
从数据库中删除指定类型的指定观察者, 结果以callbck形式返回。
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | SubscribeType | 是 | 指在{@code SubscribeType}中定义的订阅类型。 |
| observer | Callback<Array<string>> | 是 | 指已注册的数据更改观察者。|
- 示例：
```
function storeObserver(devices) {
for (let i = 0; i < devices.length; i++) {
console.log('device=' + device[i] + ' data changed')
}
}
try {
rdbStore.off('dataChange', rdb.SubscribeType.SUBSCRIBE_TYPE_REMOTE, storeObserver)
} catch (err) {
console.log('unregister observer failed')
}
```
## StoreConfig
管理关系数据库配置。
......@@ -1211,3 +1471,21 @@ executeSql(sql: string, bindArgs?: Array&lt;ValueType&gt;):Promise&lt;void&gt;
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| [key:&nbsp;string] | [ValueType](#valuetype)\|&nbsp;Uint8Array&nbsp;\|&nbsp;null | 是 | 用于存储键值对。 |
## SyncMode
指数据库同步模式。
| 名称 | 说明 |
| -------- | -------- |
| SYNC_MODE_PUSH | 表示数据从本地设备推送到远程设备。 |
| SYNC_MODE_PULL | 表示数据从远程设备拉至本地设备。 |
## SubscribeType
描述订阅类型。
| 名称 | 说明 |
| -------- | -------- |
| SUBSCRIBE_TYPE_REMOTE | 订阅远程数据更改。 |
zh-cn/application-dev/reference/apis/js-apis-data-storage.md
浏览文件 @ 963e8a44
......@@ -4,7 +4,7 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 从API Version 8开始，该接口不再维护，推荐使用新接口 [@ohos.data.preferences](js-apis-data-preferences.md)
## 导入模块
......@@ -26,7 +26,7 @@ SystemCapability.DistributedDataManager.Preferences.Core
| MAX_VALUE_LENGTH | string | 是 | 否 | string类型value的最大长度限制，大小为8192字节。 |
## dataStorage.getStorageSync
## dataStorage.getStorageSync<sup>(deprecated) </sup>
getStorageSync(path: string): Storage
......@@ -46,7 +46,7 @@ getStorageSync(path: string): Storage
```
import dataStorage from '@ohos.data.storage'
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext()
var path = await context.getFilesDir()
let storage = dataStorage.getStorageSync(path + '/mystore')
......@@ -55,7 +55,7 @@ getStorageSync(path: string): Storage
```
## dataStorage.getStorage
## dataStorage.getStorage<sup>(deprecated) </sup>
getStorage(path: string, callback: AsyncCallback&lt;Storage&gt;): void
......@@ -71,7 +71,7 @@ getStorage(path: string, callback: AsyncCallback&lt;Storage&gt;): void
```
import dataStorage from '@ohos.data.storage'
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext()
var path = await context.getFilesDir()
dataStorage.getStorage(path + '/mystore', function (err, storage) {
......@@ -85,7 +85,7 @@ getStorage(path: string, callback: AsyncCallback&lt;Storage&gt;): void
```
## dataStorage.getStorage
## dataStorage.getStorage<sup>(deprecated) </sup>
getStorage(path: string): Promise&lt;Storage&gt;
......@@ -105,7 +105,7 @@ getStorage(path: string): Promise&lt;Storage&gt;
```
import dataStorage from '@ohos.data.storage'
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext()
var path = await context.getFilesDir()
let promise = dataStorage.getStorage(path + '/mystore')
......@@ -118,7 +118,7 @@ getStorage(path: string): Promise&lt;Storage&gt;
```
## dataStorage.deleteStorageSync
## dataStorage.deleteStorageSync<sup>(deprecated) </sup>
deleteStorageSync(path: string): void
......@@ -135,7 +135,7 @@ deleteStorageSync(path: string): void
```
## dataStorage.deleteStorage
## dataStorage.deleteStorage<sup>(deprecated) </sup>
deleteStorage(path: string, callback: AsyncCallback&lt;void&gt;)
......@@ -159,7 +159,7 @@ deleteStorage(path: string, callback: AsyncCallback&lt;void&gt;)
```
## dataStorage.deleteStorage
## dataStorage.deleteStorage<sup>(deprecated) </sup>
deleteStorage(path: string): Promise&lt;void&gt;
......@@ -186,7 +186,7 @@ deleteStorage(path: string): Promise&lt;void&gt;
```
## dataStorage.removeStorageFromCacheSync
## dataStorage.removeStorageFromCacheSync<sup>(deprecated) </sup>
removeStorageFromCacheSync(path: string): void
......@@ -205,7 +205,7 @@ removeStorageFromCacheSync(path: string): void
```
## dataStorage.removeStorageFromCache
## dataStorage.removeStorageFromCache<sup>(deprecated) </sup>
removeStorageFromCache(path: string, callback: AsyncCallback&lt;Storage&gt;): void
......@@ -231,7 +231,7 @@ removeStorageFromCache(path: string, callback: AsyncCallback&lt;Storage&gt;): vo
```
## dataStorage.removeStorageFromCache
## dataStorage.removeStorageFromCache<sup>(deprecated) </sup>
removeStorageFromCache(path: string): Promise&lt;void&gt;
......@@ -260,12 +260,12 @@ removeStorageFromCache(path: string): Promise&lt;void&gt;
```
## Storage
## Storage<sup>(deprecated) </sup>
提供获取和修改存储数据的接口。
### getSync
### getSync<sup>(deprecated) </sup>
getSync(key: string, defValue: ValueType): ValueType
......@@ -291,7 +291,7 @@ getSync(key: string, defValue: ValueType): ValueType
```
### get
### get<sup>(deprecated) </sup>
get(key: string, defValue: ValueType, callback: AsyncCallback&lt;ValueType&gt;): void
......@@ -318,7 +318,7 @@ get(key: string, defValue: ValueType, callback: AsyncCallback&lt;ValueType&gt;):
```
### get
### get<sup>(deprecated) </sup>
get(key: string, defValue: ValueType): Promise&lt;ValueType&gt;
......@@ -348,7 +348,7 @@ get(key: string, defValue: ValueType): Promise&lt;ValueType&gt;
```
### putSync
### putSync<sup>(deprecated) </sup>
putSync(key: string, value: ValueType): void
......@@ -368,7 +368,7 @@ putSync(key: string, value: ValueType): void
```
### put
### put<sup>(deprecated) </sup>
put(key: string, value: ValueType, callback: AsyncCallback&lt;void&gt;): void
......@@ -395,7 +395,7 @@ put(key: string, value: ValueType, callback: AsyncCallback&lt;void&gt;): void
```
### put
### put<sup>(deprecated) </sup>
put(key: string, value: ValueType): Promise&lt;void&gt;
......@@ -425,7 +425,7 @@ put(key: string, value: ValueType): Promise&lt;void&gt;
```
### hasSync
### hasSync<sup>(deprecated) </sup>
hasSync(key: string): boolean
......@@ -452,7 +452,7 @@ hasSync(key: string): boolean
```
### has
### has<sup>(deprecated) </sup>
has(key: string, callback: AsyncCallback&lt;boolean&gt;): boolean
......@@ -485,7 +485,7 @@ has(key: string, callback: AsyncCallback&lt;boolean&gt;): boolean
```
### has
### has<sup>(deprecated) </sup>
has(key: string): Promise&lt;boolean&gt;
......@@ -516,7 +516,7 @@ has(key: string): Promise&lt;boolean&gt;
```
### deleteSync
### deleteSync<sup>(deprecated) </sup>
deleteSync(key: string): void
......@@ -535,7 +535,7 @@ deleteSync(key: string): void
```
### delete
### delete<sup>(deprecated) </sup>
delete(key: string, callback: AsyncCallback&lt;void&gt;): void
......@@ -561,7 +561,7 @@ delete(key: string, callback: AsyncCallback&lt;void&gt;): void
```
### delete
### delete<sup>(deprecated) </sup>
delete(key: string): Promise&lt;void&gt;
......@@ -590,7 +590,7 @@ delete(key: string): Promise&lt;void&gt;
```
### flushSync
### flushSync<sup>(deprecated) </sup>
flushSync(): void
......@@ -604,7 +604,7 @@ flushSync(): void
```
### flush
### flush<sup>(deprecated) </sup>
flush(callback: AsyncCallback&lt;void&gt;): void
......@@ -629,7 +629,7 @@ flush(callback: AsyncCallback&lt;void&gt;): void
```
### flush
### flush<sup>(deprecated) </sup>
flush(): Promise&lt;void&gt;
......@@ -653,7 +653,7 @@ flush(): Promise&lt;void&gt;
```
### clearSync
### clearSync<sup>(deprecated) </sup>
clearSync(): void
......@@ -667,7 +667,7 @@ clearSync(): void
```
### clear
### clear<sup>(deprecated) </sup>
clear(callback: AsyncCallback&lt;void&gt;): void
......@@ -692,7 +692,7 @@ clear(callback: AsyncCallback&lt;void&gt;): void
```
### clear
### clear<sup>(deprecated) </sup>
clear(): Promise&lt;void&gt;
......@@ -716,7 +716,7 @@ clear(): Promise&lt;void&gt;
```
### on('change')
### on('change')<sup>(deprecated) </sup>
on(type: 'change', callback: Callback&lt;StorageObserver&gt;): void
......@@ -739,7 +739,7 @@ on(type: 'change', callback: Callback&lt;StorageObserver&gt;): void
```
### off('change')
### off('change')<sup>(deprecated) </sup>
off(type: 'change', callback: Callback&lt;StorageObserver&gt;): void
......@@ -760,7 +760,7 @@ off(type: 'change', callback: Callback&lt;StorageObserver&gt;): void
```
## StorageObserver
## StorageObserver<sup>(deprecated) </sup>
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
......
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-progress.md
浏览文件 @ 963e8a44
......@@ -47,7 +47,7 @@ Progress(value: {value: number, total?: number, style?: ProgressStyle})
| -------- | -------- | -------- | -------- |
| value | number | - | 设置当前进度值。 |
| color | Color | - | 设置进度条前景色。 |
| circularStyle<sup>8+</sup> | {<br/>strokeWidth？:&nbsp;Length,<br/>scaleCount？:&nbsp;number,<br/>scaleWidth？:&nbsp;Length<br/>} | - | 定义style为ProgressStyle.ScaleRing时的样式，包括：宽度，总刻度数，刻度粗细。<br/>strokeWidth:&nbsp;设置环形进度条宽度。<br/>scaleCount:&nbsp;设置环形进度条总刻度数。<br/>scaleWidth:&nbsp;设置环形进度条刻度粗细。<br/>刻度粗细大于进度条宽度时，刻度粗细为系统默认粗细。 |
| style<sup>8+</sup> | {<br/>strokeWidth？:&nbsp;Length,<br/>scaleCount？:&nbsp;number,<br/>scaleWidth？:&nbsp;Length<br/>} | - | 定义组件的样式。<br/>strokeWidth:&nbsp;设置进度条宽度。<br/>scaleCount:&nbsp;设置环形进度条总刻度数。<br/>scaleWidth:&nbsp;设置环形进度条刻度粗细。<br/>刻度粗细大于进度条宽度时，刻度粗细为系统默认粗细。 |
## 示例
......@@ -73,7 +73,7 @@ struct ProgressExample {
Progress({ value: 10, style: ProgressStyle.ScaleRing }).width(100)
Progress({ value: 20, total: 150, style: ProgressStyle.ScaleRing })
.color(Color.Grey).value(50).width(100)
.circularStyle({ strokeWidth: 15, scaleCount: 15, scaleWidth: 5 })
.style({ strokeWidth: 15, scaleCount: 15, scaleWidth: 5 })
}
Text('Ring Progress').fontSize(9).fontColor(0xCCCCCC).width('90%')
......@@ -81,7 +81,7 @@ struct ProgressExample {
Progress({ value: 10, style: ProgressStyle.Ring }).width(100)
Progress({ value: 20, total: 150, style: ProgressStyle.Ring })
.color(Color.Grey).value(50).width(100)
.circularStyle({ strokeWidth: 20, scaleCount: 30, scaleWidth: 20 })
.style({ strokeWidth: 20, scaleCount: 30, scaleWidth: 20 })
}
Text('Capsule Progress').fontSize(9).fontColor(0xCCCCCC).width('90%')
......
zh-cn/device-dev/subsystems/subsys-data-relational-database-guide.md
浏览文件 @ 963e8a44
......@@ -36,7 +36,7 @@
- RdbPredicates：开发者无需编写复杂的SQL语句，仅通过调用该类中条件相关的方法，如equalTo、notEqualTo、groupBy、orderByAsc、beginsWith等，就可自动完成SQL语句拼接，方便用户聚焦业务操作。
- RawRdbPredicates：可满足复杂SQL语句的场景，支持开发者自己设置where条件子句和whereArgs参数。不支持equalTo等条件接口的使用。
表7 数据库谓词API
表3 数据库谓词API
| 类名 | 接口名 | 描述 |
| ---- | ---- | ---- |
| RdbPredicates | AbsPredicates *EqualTo(std::string field, std::string value) | 设置谓词条件，满足field字段与value值相等。 |
......@@ -46,6 +46,9 @@
| RdbPredicates | AbsPredicates *OrderByAsc(std::string field) | 设置谓词条件，根据field字段升序排列。 |
| RdbPredicates | void SetWhereClause(std::string whereClause) | 设置where条件子句。 |
| RdbPredicates | void SetWhereArgs(std::vector\<std::string\> whereArgs) | 设置whereArgs参数，该值表示where子句中占位符的值。 |
| RdbPredicates | AbsRdbPredicates *InDevices(std::vector<std::string>& devices) | 设置谓词条件，同步分布式数据库时指定组网内的远程设备。 |
| RdbPredicates | AbsRdbPredicates *InAllDevices() | 设置谓词条件，同步分布式数据库时连接到组网内的所有远程设备。|
### 数据表的增删改查
......@@ -55,7 +58,7 @@
关系型数据库提供了插入数据的接口，通过ValuesBucket输入要存储的数据，通过返回值判断是否插入成功，插入成功时返回最新插入数据所在的行号，失败时则返回-1。
表3 数据表插入API
表4 数据表插入API
| 类名 | 接口名 | 描述 |
| ---- | ---- | ---- |
......@@ -74,7 +77,7 @@
调用更新接口，传入要更新的数据，并通过AbsRdbPredicates指定更新条件。该接口的返回值表示更新操作影响的行数。如果更新失败，则返回0。
表4 数据表更新API
表6 数据表更新API
| 类名 | 接口名 | 描述 |
| ---- | ---- | ---- |
| RdbStore | int Update(int &changedRows, const ValuesBucket &values, const AbsRdbPredicates &predicates) | 更新数据库表中符合谓词指定条件的数据。<ul><li> changedRows：更新的记录条数。 </li><li> values：以ValuesBucket存储的要更新的数据。 </li><li> predicates：指定了更新操作的表名和条件。AbsRdbPredicates的实现类有两个：RdbPredicates和RawRdbPredicates。<ul><li> RdbPredicates：支持调用谓词提供的equalTo等接口，设置更新条件。</li><li> RawRdbPredicates：仅支持设置表名、where条件子句、whereArgs三个参数，不支持equalTo等接口调用。 </li></ul></li></ul> |
......@@ -86,7 +89,7 @@
- 直接调用查询接口。使用该接口，会将包含查询条件的谓词自动拼接成完整的SQL语句进行查询操作，无需用户传入原生的SQL语句。
- 执行原生的SQL语句进行查询操作。
表6 数据表查询API
表7 数据表查询API
| 类名 | 接口名 | 描述 |
| ---- | ---- | ---- |
| RdbStore | std::unique_ptr<AbsSharedResultSet> Query(const AbsRdbPredicates &predicates, const std::vector\<std::string\> columns) | 查询数据。<ul><li> predicates：谓词，可以设置查询条件。AbsRdbPredicates的实现类有两个：RdbPredicates和RawRdbPredicates。<ul><li> RdbPredicates：支持调用谓词提供的equalTo等接口，设置更新条件。</li><li> RawRdbPredicates：仅支持设置表名、where条件子句、whereArgs三个参数，不支持equalTo等接口调用。 </li></ul> <li> columns：规定查询返回的列。</li></ul></li></ul> |
......@@ -96,22 +99,61 @@
关系型数据库提供了查询返回的结果集ResultSet，其指向查询结果中的一行数据，供用户对查询结果进行遍历和访问。ResultSet对外API如下所示。
表8 结果集API
| 类名 | 接口名 | 描述 |
| ---- | ---- | ---- |
| ResultSet | int GoTo(int offset) | 从结果集当前位置移动指定偏移量。 |
| ResultSet | int GoToRow(int position) | 将结果集移动到指定位置。 |
| ResultSet | int GoToNextRow() | 将结果集向后移动一行。 |
| ResultSet | int GoToPreviousRow() | 将结果集向前移动一行。 |
| ResultSet | int IsStarted(bool &result) | 判断结果集是否被移动过。 |
| ResultSet | int IsEnded(bool &result) | 判断结果集是否被移动到最后一行之后。 |
| ResultSet | int IsAtFirstRow(bool &result) | 判断结果集当前位置是否在第一行。 |
| ResultSet | int IsAtLastRow(bool &result) | 判断结果集当前位置是否在最后一行。 |
| ResultSet | int GetRowCount(int &count) | 获取当前结果集中的记录条数。 |
| ResultSet | int GetColumnCount(int &count) | 获取结果集中的列数。 |
| ResultSet | int GetString(int columnIndex, std::string &value) | 获取当前行指定列的值，以String类型返回。 |
| ResultSet | int GetBlob(int columnIndex, std::vector\<uint8_t\> &blob) | 获取当前行指定列的值，以字节数组形式返回。 |
| ResultSet | int GetDouble(int columnIndex, double &value) | 获取当前行指定列的值，以double型返回。 |
表8 结果集API
| 类名 | 接口名 | 描述 |
| ---- | ---- | ---- |
| ResultSet | int GoTo(int offset) | 从结果集当前位置移动指定偏移量。 |
| ResultSet | int GoToRow(int position) | 将结果集移动到指定位置。 |
| ResultSet | int GoToNextRow() | 将结果集向后移动一行。 |
| ResultSet | int GoToPreviousRow() | 将结果集向前移动一行。 |
| ResultSet | int IsStarted(bool &result) | 判断结果集是否被移动过。 |
| ResultSet | int IsEnded(bool &result) | 判断结果集是否被移动到最后一行之后。 |
| ResultSet | int IsAtFirstRow(bool &result) | 判断结果集当前位置是否在第一行。 |
| ResultSet | int IsAtLastRow(bool &result) | 判断结果集当前位置是否在最后一行。 |
| ResultSet | int GetRowCount(int &count) | 获取当前结果集中的记录条数。 |
| ResultSet | int GetColumnCount(int &count) | 获取结果集中的列数。 |
| ResultSet | int GetString(int columnIndex, std::string &value) | 获取当前行指定列的值，以String类型返回。 |
| ResultSet | int GetBlob(int columnIndex, std::vector\<uint8_t\> &blob) | 获取当前行指定列的值，以字节数组形式返回。 |
| ResultSet | int GetDouble(int columnIndex, double &value) | 获取当前行指定列的值，以double型返回。 |
### 设置分布式列表
用户可以对当前数据库中的列表设置为分布式列表。
表9 设置分布式列表
| 类名 | 接口名 | 描述 |
| ---- | ---- | ---- |
| RdbStore | bool SetDistributedTables(const std::vector<std::string>& tables) | 设置分布式列表。<ul><li> tables：要设置的分布式列表表名 </li></ul>
### 根据本地表名获取指定远程设备的分布式表名
用户根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名。
表9 根据本地表名获取指定远程设备的分布式表名
| 类名 | 接口名 | 描述 |
| ---- | ---- | ---- |
| RdbStore | std::string ObtainDistributedTableName(const std::string& device, const std::string& table) | 根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时，需要使用分布式表名。<ul><li> device：远程设备ID </li><li> table：本地表名</li></ul>
### 在设备之间同步数据
表10 在设备之间同步数据
| 类名 | 接口名 | 描述 |
| ---- | ---- | ---- |
| RdbStore | bool Sync(const SyncOption& option, const AbsRdbPredicates& predicate, const SyncCallback& callback) | 在设备之间同步数据。<ul><li> option：同步选项；mode：同步模式(PUSH表示数据从本地设备推送到远程设备/PULL表示数据从远程设备拉至本地设备)；isBlock：是否阻塞 </li><li> callback：指定的callback回调函数</li></ul>
### 注册数据库的观察者
表10 注册数据库的观察者
| 类名 | 接口名 | 描述 |
| ---- | ---- | ---- |
| RdbStore | bool Subscribe(const SubscribeOption& option, RdbStoreObserver *observer) | 注册数据库的观察者。当分布式数据库中的数据发生更改时，将调用回调。<ul><li> option：订阅类型；</li><li> observer：指分布式数据库中数据更改事件的观察者</li></ul>
### 从数据库中删除指定类型的指定观察者
表10 从数据库中删除指定类型的指定观察者
| 类名 | 接口名 | 描述 |
| ---- | ---- | ---- |
| RdbStore | bool UnSubscribe(const SubscribeOption& option, RdbStoreObserver *observer) | 从数据库中删除指定类型的指定观察者。<ul><li> option：订阅类型；</li><li> observer：指已注册的数据更改观察者</li></ul>
## 约束与限制
......@@ -189,3 +231,75 @@
resultSet.goToNextRow();
```
4. 设置分布式同步表
a. 调用接口设置分布式同步表。
示例代码如下：
```
store->SetDistributedTables("test");
```
5. 分布式数据同步
a. 定义同步模式和阻塞状态。
b. 构造用于同步分布式表的谓词对象，指定组网内的远程设备。
c. 调用接口同步数据。
示例代码如下：
```
SyncOption option;
option.mode = PUSH;
option.isBlock = true;
AbsRdbPredicates predicate("test");
predicate.InAllDevices();
store->Sync(option, predicate, []（const SyncResult& result) {
for (const auto& [device, status] : result) {
LogI("device=%s status=%d", device.c_str(), status);
}
});
```
6. 分布式数据订阅
a. 重写数据更改观察者OnChange()函数。
b. 定义分布式数据订阅类型。
c. 调用接口实现分布式数据订阅，或取消订阅。
示例代码如下：
```
class MyObserver : public RdbStoreObserver {
public:
void OnChange(const std::vector<std::string>& devices) override {
for (const auto& device : devices) {
LOGI("device=%s data change", device.c_str());
}
}
};
SubscribeOption option;
option.mode = SubscribeMode::REMOTE;
MyObserver observer;
store->Subscribe(option, &observer); // 分布式数据订阅
store->UnSubscribe(option, &observer); // 取消订阅
```
7. 跨设备查询
a. 根据本地表名获取指定远程设备的分布式表名。
b. 根据指定SQL语句查询数据库中的数据。
示例代码如下：
```
std::string tableName = store->ObtainDistributedTableName("123456789abcd", "test");
auto resultSet = store->QuerySql("SELECT * from ?;", tableName);
```
zh-cn/website-directory.md
浏览文件 @ 963e8a44
......@@ -1380,7 +1380,9 @@
——>——>——>——> 数据管理
——>——>——>——>——> [轻量级存储](application-dev/reference/apis/js-apis-data-storage.md)
——>——>——>——>——> [轻量级存储](application-dev/reference/apis/js-apis-data-preferences.md)
——>——>——>——>——> [轻量级存储（废弃 since 8）](application-dev/reference/apis/js-apis-data-storage.md)
——>——>——>——>——> [分布式数据管理](application-dev/reference/apis/js-apis-distributed-data.md)
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或