未验证 提交 fb4a626d 编写于 作者: O openharmony_ci 提交者: Gitee

!7957 master:数据共享相关模块添加systemapi说明/删除3个接口 + dataSharePredicates描述整改优化:需同步翻译

Merge pull request !7957 from 葛亚芳/master
......@@ -4,7 +4,7 @@
DataShare即数据共享模块,用于应用管理其自身数据,也提供了向其他应用共享以及管理其数据的方法。目前仅支持同个设备上应用之间的数据共享。
在许多应用场景中都需要用到数据共享,比如将电话簿、短信、媒体库中的数据共享给其他应用等。当然,不是所有的数据都允许其他应用访问,比如帐号、密码等;有些数据也只允许其他应用查询而不允许其删改,比如短信等。所以对于各种数据共享场景,DataSahre这样一个安全、便捷的可以跨设备、跨应用的数据共享机制是十分必需的。
在许多应用场景中都需要用到数据共享,比如将电话簿、短信、媒体库中的数据共享给其他应用等。当然,不是所有的数据都允许其他应用访问,比如帐号、密码等;有些数据也只允许其他应用查询而不允许其删改,比如短信等。所以对于各种数据共享场景,DataSahre这样一个安全、便捷的可以跨应用的数据共享机制是十分必需的。
对于数据提供者来说,无需进行繁琐的封装,可直接使用DataShare框架实现向其他应用共享数据;对于数据访问方来说,因DataShare的访问方式不会因数据提供的方式而不同,所以只需要学习和使用一套接口即可,大大减少了学习时间和开发难度。
......
......@@ -4,11 +4,11 @@
>**说明:**
>
>本模块首批接口从API version 9开始支持,后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块首批接口从API version 9开始支持,后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
>本模块接口为系统接口。
> 本模块接口为系统接口。
>
>本模块接口仅可在Stage模型下使用。
> 本模块接口仅可在Stage模型下使用。
## 导入模块
......@@ -70,62 +70,6 @@ export default class DataShareExtAbility extends DataShareExtensionAbility {
};
```
## getFileTypes
getFileTypes?(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array<string>>): void
获取支持文件的MIME类型时服务端回调此接口,该方法可以选择性重写。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Provider
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| -------------- | ---------------------------------------- | ---- | ---------------------------------- |
| uri | string | 是 | 指示要获取的文件的路径。 |
| mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 |
| callback | AsyncCallback<Array<string>> | 是 | 回调函数。返回匹配的MIME类型数组。 |
**示例:**
```ts
export default class DataShareExtAbility extends DataShareExtensionAbility {
getFileTypes(uri, mimeTypeFilter, callback) {
let err = {"code":0};
let ret = new Array("type01", "type02", "type03");
callback(err, ret);
}
};
```
## openFile
openFile?(uri: string, mode: string, callback: AsyncCallback<number>): void
在打开文件时服务端回调此接口,该方法可以选择性重写。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Provider
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| -------- | --------------------- | ---- | ------------------------------------------ |
| uri | string | 是 | 指示要打开的文件的路径。 |
| mode | string | 是 | 指示文件打开模式,包括只读模式,读写模式。 |
| callback | AsyncCallback<number> | 是 | 回调函数。返回文件描述符。 |
**示例:**
```ts
export default class DataShareExtAbility extends DataShareExtensionAbility {
openFile(uri, mode, callback) {
let err = {"code":0};
let fd = 0;
callback(err,fd);
}
};
```
## insert
insert?(uri: string, valueBucket: ValuesBucket, callback: AsyncCallback<number>): void
......@@ -301,33 +245,6 @@ export default class DataShareExtAbility extends DataShareExtensionAbility {
};
```
## getType
getType?(uri: string, callback: AsyncCallback<string>): void
获取给定URI对应的MIME类型时服务端回调此接口,该方法可以选择性重写。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Provider
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| uri | string | 是 | 指示要获取MIME类型的数据的路径。 |
| callback | AsyncCallback<string> | 是 | 回调函数。返回与URI指定的数据匹配的MIME类型。 |
**示例:**
```ts
export default class DataShareExtAbility extends DataShareExtensionAbility {
getType(uri, callback) {
let err = {"code":0};
let ret = "image";
callback(err, ret);
}
};
```
## batchInsert
batchInsert?(uri: string, valueBuckets: Array<ValuesBucket>, callback: AsyncCallback<number>): void
......
......@@ -2,9 +2,11 @@
**结果集(DataShareResultSet)** 可提供访问由查询数据库生成的结果集的相关方法,根据提供的行数,查询相应的值,也可查询指定数据类型的值。
>**说明:**
> **说明:**
>
>本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> 本模块接口为系统接口。
## 导入模块
......
......@@ -2,9 +2,11 @@
**数据集(ValuesBucket)** 是开发者向数据库插入的数据集合,数据集以键-值对的形式进行传输。
>**说明:**
> **说明:**
>
>本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> 本模块接口为系统接口。
## 导入模块
......
......@@ -2,9 +2,13 @@
**DataShare**用于应用管理其自身数据,同时支持同个设备上不同应用间的数据共享。
>**说明:**
> **说明:**
>
>本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> 本模块接口为系统接口。
>
> 本模块接口仅可在Stage模型下使用。
## 导入模块
......
......@@ -2,9 +2,11 @@
**谓词(DataSharePredicates)** 是用户通过DataShare查询数据库中的数据所使用的筛选条件,经常被应用在更新数据([update](js-apis-data-dataShare.md#update))、删除数据([delete](js-apis-data-dataShare.md#delete))和查询数据([query](js-apis-data-dataShare.md#query))中。
>**说明:**
> **说明:**
>
>本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> 本模块接口为系统接口。
## 导入模块
......@@ -20,7 +22,7 @@ import dataSharePredicates from '@ohos.data.dataSharePredicates';
equalTo(field: string, value: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType且值等于指定值的字段。
该接口用于配置谓词以匹配值等于指定值的字段。
目前仅RDB及KVDB(schema)支持该谓词。
......@@ -50,7 +52,7 @@ predicates.equalTo("NAME", "Rose")
notEqualTo(field: string, value: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType且值不等于指定值的字段。
该接口用于配置谓词以匹配值不等于指定值的字段。
目前仅RDB及KVDB(schema)支持该谓词。
......@@ -80,7 +82,9 @@ predicates.notEqualTo("NAME", "Rose")
beginWrap(): DataSharePredicates
该接口用于向谓词添加左括号。目前仅RDB支持该谓词。
该接口用于向谓词添加左括号。
目前仅RDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......@@ -106,7 +110,9 @@ predicates.equalTo("NAME", "lisi")
endWrap(): DataSharePredicates
该接口用于向谓词添加右括号。目前仅RDB支持该谓词。
该接口用于向谓词添加右括号。
目前仅RDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......@@ -182,7 +188,9 @@ predicates.equalTo("NAME", "lisi")
contains(field: string, value: string): DataSharePredicates
该接口用于配置谓词以匹配数据类型为string且值包含指定的字段。目前仅RDB支持该谓词。
该接口用于配置谓词以匹配值包含指定字段的字段。
目前仅RDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......@@ -210,7 +218,9 @@ predicates.contains("NAME", "os")
beginsWith(field: string, value: string): DataSharePredicates
该接口用于配置谓词以匹配数据类型为string且值以指定字符串起始的字段。目前仅RDB支持该谓词。
该接口用于配置谓词以匹配值以指定字符串起始的字段。
目前仅RDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......@@ -238,7 +248,9 @@ predicates.beginsWith("NAME", "os")
endsWith(field: string, value: string): DataSharePredicates
该接口用于配置谓词以匹配数据类型为string且值以指定字符串结尾的字段。目前仅RDB支持该谓词。
该接口用于配置谓词以匹配值以指定字符串结尾的字段。
目前仅RDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......@@ -295,7 +307,7 @@ predicates.isNull("NAME")
isNotNull(field: string): DataSharePredicates
该接口用于配置谓词以匹配值不为null的指定字段。
该接口用于配置谓词以匹配值不为null的字段。
目前仅RDB及KVDB(schema)支持该谓词。
......@@ -324,7 +336,7 @@ predicates.isNotNull("NAME")
like(field: string, value: string): DataSharePredicates
该接口用于配置谓词以匹配数据类型为string且值类似于指定字符串的字段。
该接口用于配置谓词以匹配值类似于指定字符串的字段。
目前仅RDB及KVDB(schema)支持该谓词。
......@@ -354,7 +366,7 @@ predicates.like("NAME", "%os%")
unlike(field: string, value: string): DataSharePredicates
该接口用于配置谓词以匹配数据类型为string且值不类似于指定字符串的字段。
该接口用于配置谓词以匹配值不类似于指定字符串的字段。
目前仅RDB及KVDB(schema)支持该谓词。
......@@ -384,7 +396,9 @@ predicates.unlike("NAME", "%os%")
glob(field: string, value: string): DataSharePredicates
该接口用于配置谓词匹配数据类型为string的指定字段。目前仅RDB支持该谓词。
该接口用于配置谓词匹配数据类型为string的指定字段。
目前仅RDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......@@ -412,7 +426,9 @@ predicates.glob("NAME", "?h*g")
between(field: string, low: ValueType, high: ValueType): DataSharePredicates
该接口用于将谓词配置为匹配数据类型为ValueType且值在指定范围内的指定字段。目前仅RDB支持该谓词。
该接口用于配置谓词以匹配值在指定范围内的字段。
目前仅RDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......@@ -441,7 +457,9 @@ predicates.between("AGE", 10, 50)
notBetween(field: string, low: ValueType, high: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType且值超出给定范围的指定字段。目前仅RDB支持该谓词。
该接口用于配置谓词以匹配值超出指定范围的字段。
目前仅RDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......@@ -470,7 +488,7 @@ predicates.notBetween("AGE", 10, 50)
greaterThan(field: string, value: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType且值大于指定值的字段。
该接口用于配置谓词以匹配值大于指定值的字段。
目前仅RDB及KVDB(schema)支持该谓词。
......@@ -500,7 +518,7 @@ predicates.greaterThan("AGE", 10)
lessThan(field: string, value: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType且值小于指定值的字段。
该接口用于配置谓词以匹配值小于指定值的字段。
目前仅RDB及KVDB(schema)支持该谓词。
......@@ -530,7 +548,7 @@ predicates.lessThan("AGE", 50)
greaterThanOrEqualTo(field: string, value: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType且值大于或等于指定值的字段。
该接口用于配置谓词以匹配值大于或等于指定值的字段。
目前仅RDB及KVDB(schema)支持该谓词。
......@@ -560,7 +578,7 @@ predicates.greaterThanOrEqualTo("AGE", 10)
lessThanOrEqualTo(field: string, value: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType且值小于或等于指定值的字段。
该接口用于配置谓词以匹配值小于或等于指定值的字段。
目前仅RDB及KVDB(schema)支持该谓词。
......@@ -648,7 +666,9 @@ predicates.orderByDesc("AGE")
distinct(): DataSharePredicates
该接口用于配置谓词以过滤重复记录并仅保留其中一个。目前仅RDB支持该谓词。
该接口用于配置谓词以过滤重复记录并仅保留其中一个。
目前仅RDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......@@ -699,7 +719,9 @@ predicates.equalTo("NAME", "Rose").limit(10, 3)
groupBy(fields: Array<string>): DataSharePredicates
该接口用于配置谓词按指定列分组查询结果。目前仅RDB支持该谓词。
该接口用于配置谓词按指定列分组查询结果。
目前仅RDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......@@ -726,7 +748,9 @@ predicates.groupBy(["AGE", "NAME"])
indexedBy(field: string): DataSharePredicates
该接口用于配置谓词按指定索引列查询结果。目前仅RDB支持该谓词。
该接口用于配置谓词按指定索引列查询结果。
目前仅RDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......@@ -753,7 +777,7 @@ predicates.indexedBy("SALARY_INDEX")
in(field: string, value: Array<ValueType>): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType数组且值在给定范围内的指定字段。
该接口用于配置谓词以匹配值在指范围内的字段。
目前仅RDB及KVDB(schema)支持该谓词。
......@@ -783,7 +807,7 @@ predicates.in("AGE", [18, 20])
notIn(field: string, value: Array<ValueType>): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType数组且值不在给定范围内的指定字段。
该接口用于配置谓词以匹配值不在指定范围内的字段。
目前仅RDB及KVDB(schema)支持该谓词。
......@@ -813,7 +837,9 @@ predicates.notIn("NAME", ["Lisa", "Rose"])
prefixKey(prefix: string): DataSharePredicates
该接口用于配置谓词以匹配键前缀的指定字段。目前仅KVDB支持该谓词。
该接口用于配置谓词以匹配键前缀的指定字段。
目前仅KVDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......@@ -840,7 +866,9 @@ predicates.prefixKey("NAME")
inKeys(keys: Array<string>): DataSharePredicates
该接口用于配置谓词以匹配键在给定范围内的指定字段。目前仅KVDB支持该谓词。
该接口用于配置谓词以匹配键在指定范围内的字段。
目前仅KVDB支持该谓词。
**系统能力:** SystemCapability.DistributedDataManager.DataShare.Core
......@@ -848,7 +876,7 @@ inKeys(keys: Array<string>): DataSharePredicates
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------- | ---- | ------------------ |
| inKeys | Array<string> | 是 | 定范围的键数组。 |
| inKeys | Array<string> | 是 | 定范围的键数组。 |
**返回值:**
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册