Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
“3edd833174478b5e5b8521307cc29043d48fdd6b”上不存在“paddle/platform/git@gitcode.net:Crayonxin2000/Paddle.git”
提交 02927b62 编写于 作者: S songruirui
浏览文件
操作

顺序修改 

Signed-off-by: Nsongruirui <songruirui1@huawei.com>
上级 b7a385a7
隐藏空白更改
内联 并排
Showing with 390 addition and 390 deletion
zh-cn/application-dev/reference/apis/js-apis-application-DataShareExtensionAbility.md
浏览文件 @ 02927b62
...@@ -60,6 +60,58 @@ onCreate(want: Want, callback: AsyncCallback<void>) { ...@@ -60,6 +60,58 @@ onCreate(want: Want, callback: AsyncCallback<void>) {
} }
``` ```
## getFileTypes
getFileTypes?(uri: string, mimeTypeFilter: string, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void
获取支持文件的MIME类型时服务端回调此接口，该方法可以选择性重写。
**系统能力：** SystemCapability.DistributedDataManager.DataShare.Provider
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| -------------- | ---------------------------------------- | ---- | ---------------------------------- |
| uri | string | 是 | 指示要获取的文件的路径。 |
| mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 回调函数。返回匹配的MIME类型数组。 |
**示例：**
```ts
getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array<string>>) {
let err = {"code":0};
let ret = new Array("type01", "type02", "type03");
callback(err, ret);
}
```
## openFile
openFile?(uri: string, mode: string, callback: AsyncCallback&lt;number&gt;): void
在打开文件时服务端回调此接口，该方法可以选择性重写。
**系统能力：** SystemCapability.DistributedDataManager.DataShare.Provider
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| -------- | --------------------- | ---- | ------------------------------------------ |
| uri | string | 是 | 指示要打开的文件的路径。 |
| mode | string | 是 | 指示文件打开模式，包括只读模式，读写模式。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。返回文件描述符。 |
**示例：**
```ts
openFile(uri: string, mode: string, callback: AsyncCallback<number>) {
let err = {"code":0};
let fd = 0;
callback(err,fd);
}
```
## insert ## insert
insert?(uri: string, valueBucket: ValuesBucket, callback: AsyncCallback&lt;number&gt;): void insert?(uri: string, valueBucket: ValuesBucket, callback: AsyncCallback&lt;number&gt;): void
...@@ -125,41 +177,6 @@ update(uri: string, predicates: dataSharePredicates.DataSharePredicates, valueBu ...@@ -125,41 +177,6 @@ update(uri: string, predicates: dataSharePredicates.DataSharePredicates, valueBu
} }
``` ```
## query
query?(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array&lt;string&gt;, callback: AsyncCallback&lt;Object&gt;): void
在查询数据库时服务端回调此接口，该方法可以选择性重写。
**系统能力：** SystemCapability.DistributedDataManager.DataShare.Provider
**参数：**
| 名称 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| uri | string | 是 | 指示要查询的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。 |
| columns | Array&lt;string&gt; | 是 | 指示要查询的列。如果此参数为空，则查询所有列。 |
| callback | AsyncCallback&lt;Object&gt; | 是 | 回调函数。返回查询到的结果集。 |
**示例：**
```ts
query(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array<string>, callback: AsyncCallback<Object>) {
if (predicates == null || predicates == undefined) {
return;
}
rdbStore.query(TBL_NAME, predicates, columns, function (err, resultSet) {
if (resultSet != undefined) {
console.info('resultSet.rowCount: ' + resultSet.rowCount);
}
if (callback != undefined) {
callback(err, resultSet);
}
});
}
```
## delete ## delete
delete?(uri: string, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback&lt;number&gt;): void delete?(uri: string, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback&lt;number&gt;): void
...@@ -191,37 +208,37 @@ delete(uri: string, predicates: dataSharePredicates.DataSharePredicates, callbac ...@@ -191,37 +208,37 @@ delete(uri: string, predicates: dataSharePredicates.DataSharePredicates, callbac
} }
``` ```
## BatchInsert ## query
BatchInsert?(uri: string, valueBuckets: Array&lt;ValuesBucket&gt;, callback: AsyncCallback&lt;number&gt;): void query?(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array&lt;string&gt;, callback: AsyncCallback&lt;Object&gt;): void
在数据库批量插入时服务端回调此接口，该方法可以选择性重写。 在查询数据库时服务端回调此接口，该方法可以选择性重写。
**系统能力：** SystemCapability.DistributedDataManager.DataShare.Provider **系统能力：** SystemCapability.DistributedDataManager.DataShare.Provider
**参数：** **参数：**
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| ------------ | ------------------------------------------------------------ | ---- | -------------------------------- | | ----- | ------ | ------ | ------ |
| uri | string | 是 | 指示要批量插入的数据的路径。 | | uri | string | 是 | 指示要查询的数据的路径。 |
| valueBuckets | Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是 | 指示要批量插入的数据。 | | predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。返回插入的数据记录数。 | | columns | Array&lt;string&gt; | 是 | 指示要查询的列。如果此参数为空，则查询所有列。 |
| callback | AsyncCallback&lt;Object&gt; | 是 | 回调函数。返回查询到的结果集。 |
**示例：** **示例：**
```ts ```ts
batchInsert(uri: string, valueBuckets: Array<ValuesBucket>, callback: AsyncCallback<number>) { query(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array<string>, callback: AsyncCallback<Object>) {
if (valueBuckets == null || valueBuckets.length == undefined) { if (predicates == null || predicates == undefined) {
console.info('invalid valueBuckets');
return; return;
} }
let resultNum = valueBuckets.length rdbStore.query(TBL_NAME, predicates, columns, function (err, resultSet) {
valueBuckets.forEach(vb => { if (resultSet != undefined) {
rdbStore.insert(TBL_NAME, vb, function (err, ret) { console.info('resultSet.rowCount: ' + resultSet.rowCount);
if (callback != undefined) { }
callback(err, resultNum); if (callback != undefined) {
} callback(err, resultSet);
}); }
}); });
} }
``` ```
...@@ -251,29 +268,38 @@ getType(uri: string, callback: AsyncCallback<string>) { ...@@ -251,29 +268,38 @@ getType(uri: string, callback: AsyncCallback<string>) {
} }
``` ```
## getFileTypes ## BatchInsert
getFileTypes?(uri: string, mimeTypeFilter: string, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void BatchInsert?(uri: string, valueBuckets: Array&lt;ValuesBucket&gt;, callback: AsyncCallback&lt;number&gt;): void
获取支持文件的MIME类型时服务端回调此接口，该方法可以选择性重写。 在数据库批量插入时服务端回调此接口，该方法可以选择性重写。
**系统能力：** SystemCapability.DistributedDataManager.DataShare.Provider **系统能力：** SystemCapability.DistributedDataManager.DataShare.Provider
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 参数类型 | 必填 | 说明 |
| -------------- | ---------------------------------------- | ---- | ---------------------------------- | | ------------ | ------------------------------------------------------------ | ---- | -------------------------------- |
| uri | string | 是 | 指示要获取的文件的路径。 | | uri | string | 是 | 指示要批量插入的数据的路径。 |
| mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 | | valueBuckets | Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是 | 指示要批量插入的数据。 |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 回调函数。返回匹配的MIME类型数组。 | | callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。返回插入的数据记录数。 |
**示例：** **示例：**
```ts ```ts
getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array<string>>) { batchInsert(uri: string, valueBuckets: Array<ValuesBucket>, callback: AsyncCallback<number>) {
let err = {"code":0}; if (valueBuckets == null || valueBuckets.length == undefined) {
let ret = new Array("type01", "type02", "type03"); console.info('invalid valueBuckets');
callback(err, ret); return;
}
let resultNum = valueBuckets.length
valueBuckets.forEach(vb => {
rdbStore.insert(TBL_NAME, vb, function (err, ret) {
if (callback != undefined) {
callback(err, resultNum);
}
});
});
} }
``` ```
...@@ -326,29 +352,3 @@ denormalizeUri(uri: string, callback: AsyncCallback<string>) { ...@@ -326,29 +352,3 @@ denormalizeUri(uri: string, callback: AsyncCallback<string>) {
callback(err, ret); callback(err, ret);
} }
``` ```
## openFile
openFile?(uri: string, mode: string, callback: AsyncCallback&lt;number&gt;): void
在打开文件时服务端回调此接口，该方法可以选择性重写。
**系统能力：** SystemCapability.DistributedDataManager.DataShare.Provider
**参数：**
| 名称 | 类型 | 必填 | 描述 |
| -------- | --------------------- | ---- | ------------------------------------------ |
| uri | string | 是 | 指示要打开的文件的路径。 |
| mode | string | 是 | 指示文件打开模式，包括只读模式，读写模式。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。返回文件描述符。 |
**示例：**
```ts
openFile(uri: string, mode: string, callback: AsyncCallback<number>) {
let err = {"code":0};
let fd = 0;
callback(err,fd);
}
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-data-dataShare.md
浏览文件 @ 02927b62
...@@ -29,7 +29,7 @@ createDataShareHelper(context: Context, uri: string, callback: AsyncCallback&lt; ...@@ -29,7 +29,7 @@ createDataShareHelper(context: Context, uri: string, callback: AsyncCallback&lt;
| -------- | -------------------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | -------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context | [Context](js-apis-application-context.md#context) | 是 | 应用的上下文环境。 | | context | [Context](js-apis-application-context.md#context) | 是 | 应用的上下文环境。 |
| uri | string | 是 | 指示要连接的服务端应用的路径。 | | uri | string | 是 | 指示要连接的服务端应用的路径。 |
| callback | AsyncCallback&lt;[DataShareHelper](#datasharehelper)&gt; | 是 | 回调函数。当具体的操作（视具体接口功能描述）成功，err为undefined，data为获取到的DataShareHelper实例；否则为错误对象。 | | callback | AsyncCallback&lt;[DataShareHelper](#datasharehelper)&gt; | 是 | 回调函数。当创建DataShareHelper实例成功，err为undefined，data为获取到的DataShareHelper实例；否则为错误对象。 |
**示例：** **示例：**
...@@ -104,7 +104,7 @@ openFile(uri: string, mode: string, callback: AsyncCallback&lt;number&gt;): void ...@@ -104,7 +104,7 @@ openFile(uri: string, mode: string, callback: AsyncCallback&lt;number&gt;): void
| -------- | --------------------- | ---- | ---------------------------------- | | -------- | --------------------- | ---- | ---------------------------------- |
| uri | string | 是 | 指示要打开的文件的路径。 | | uri | string | 是 | 指示要打开的文件的路径。 |
| mode | string | 是 | 指示文件打开模式，如“r”表示只读访问，“w”表示只写访问（擦除文件中当前的任何数据），“wa”表示附加到任何现有数据的写访问，“rw”表示对任何现有数据的读写访问。 | | mode | string | 是 | 指示文件打开模式，如“r”表示只读访问，“w”表示只写访问（擦除文件中当前的任何数据），“wa”表示附加到任何现有数据的写访问，“rw”表示对任何现有数据的读写访问。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。当具体的操作（视具体接口功能描述）成功，err为undefined，data为获取到的文件描述符；否则为错误对象。 | | callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。当打开指定路径的文件成功，err为undefined，data为获取到的文件描述符；否则为错误对象。 |
**示例：** **示例：**
...@@ -171,7 +171,7 @@ on(type: 'dataChange', uri: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -171,7 +171,7 @@ on(type: 'dataChange', uri: string, callback: AsyncCallback&lt;void&gt;): void
| -------- | -------------------- | ---- | ------------------------ | | -------- | -------------------- | ---- | ------------------------ |
| type | string | 是 | 订阅的事件/回调类型，支持的事件为'dataChange'，当数据更改时，触发该事件。 | | type | string | 是 | 订阅的事件/回调类型，支持的事件为'dataChange'，当数据更改时，触发该事件。 |
| uri | string | 是 | 表示指定的数据路径。 | | uri | string | 是 | 表示指定的数据路径。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当具体的操作（视具体接口功能描述）成功，err为undefined；否则为错误对象。当有其他用户触发了变更通知时调用。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当有其他用户触发了变更通知时调用，err为undefined；否则不被触发或为错误对象。 |
**示例：** **示例：**
...@@ -199,7 +199,7 @@ off(type: 'dataChange', uri: string, callback?: AsyncCallback&lt;void&gt;): void ...@@ -199,7 +199,7 @@ off(type: 'dataChange', uri: string, callback?: AsyncCallback&lt;void&gt;): void
| -------- | -------------------- | ---- | ------------------------ | | -------- | -------------------- | ---- | ------------------------ |
| type | string | 是 | 取消订阅的事件/回调类型，支持的事件为'dataChange'。 | | type | string | 是 | 取消订阅的事件/回调类型，支持的事件为'dataChange'。 |
| uri | string | 是 | 表示指定的数据路径。 | | uri | string | 是 | 表示指定的数据路径。 |
| callback | AsyncCallback&lt;void&gt; | 否 | 回调函数。当具体的操作（视具体接口功能描述）成功，err为undefined；否则为错误对象。 | | callback | AsyncCallback&lt;void&gt; | 否 | 回调函数。当取消订阅指定URI对应的数据资源的变更通知成功，err为undefined；否则为错误对象。 |
**示例：** **示例：**
...@@ -211,11 +211,11 @@ let uri = ("datashare:///com.samples.datasharetest.DataShare"); ...@@ -211,11 +211,11 @@ let uri = ("datashare:///com.samples.datasharetest.DataShare");
dataShareHelper.off("dataChange", uri, offCallback); dataShareHelper.off("dataChange", uri, offCallback);
``` ```
### notifyChange ### insert
notifyChange(uri: string, callback: AsyncCallback&lt;void&gt;): void insert(uri: string, value: ValuesBucket, callback: AsyncCallback&lt;number&gt;): void
通知已注册的观察者指定URI对应的数据资源已发生变更。使用callback异步回调。 将单条数据插入数据库。使用callback异步回调。
此接口仅可在Stage模型下使用。 此接口仅可在Stage模型下使用。
...@@ -223,25 +223,35 @@ notifyChange(uri: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -223,25 +223,35 @@ notifyChange(uri: string, callback: AsyncCallback&lt;void&gt;): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | ------------------------ | | -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 表示指定的数据路径。 | | uri | string | 是 | 指示要插入的数据的路径。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当具体的操作（视具体接口功能描述）成功，err为undefined；否则为错误对象。 | | value | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要插入的数据。如果此参数为空，将插入一个空行。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。当将单条数据插入数据库成功，err为undefined，data为获取到的插入数据记录的索引；否则为错误对象。<br />因部分数据库（如KVDB）的相应接口并不支持返回索引，故若服务端使用了不支持索引的数据库，则此callback也无法返回索引值。 |
**示例：** **示例：**
```ts ```ts
let uri = ("datashare:///com.samples.datasharetest.DataShare"); let uri = ("datashare:///com.samples.datasharetest.DataShare");
dataShareHelper.notifyChange(uri, () => { const valueBucket = {
console.log("***** notifyChange *****"); "name": "rose",
"age": 22,
"salary": 200.5,
}
dataShareHelper.insert(uri, valueBucket, (err, data) => {
if (err != undefined) {
console.log("insert failed, error message : " + err);
}else{
console.log("insert succeed, data : " + data);
}
}); });
``` ```
### notifyChange ### insert
notifyChange(uri: string): Promise&lt;void&gt; insert(uri: string, value: ValuesBucket): Promise&lt;number&gt;
通知已注册的观察者指定URI对应的数据资源已发生变更。使用Promise异步回调。 将单条数据插入数据库。使用Promise异步回调。
此接口仅可在Stage模型下使用。 此接口仅可在Stage模型下使用。
...@@ -249,28 +259,38 @@ notifyChange(uri: string): Promise&lt;void&gt; ...@@ -249,28 +259,38 @@ notifyChange(uri: string): Promise&lt;void&gt;
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | -------------------- | | ----- | --------------------------------------------------------- | ---- | -------------------------------------------------- |
| uri | string | 是 | 表示指定的数据路径。 | | uri | string | 是 | 指示要插入的数据的路径。 |
| value | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要插入的数据。如果此参数为空，将插入一个空行。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | --------------------- | | ---------------- | ------------------------------------------------------------ |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 | | Promise&lt;number&gt; | Promise对象。返回插入数据记录的索引。<br />因部分数据库（如KVDB）的相应接口并不支持返回索引，故若服务端使用了不支持索引的数据库，则此Promise也无法返回索引值。 |
**示例：** **示例：**
```ts ```ts
let uri = ("datashare:///com.samples.datasharetest.DataShare"); let uri = ("datashare:///com.samples.datasharetest.DataShare");
dataShareHelper.notifyChange(uri); const valueBucket = {
"name": "rose1",
"age": 221,
"salary": 20.5,
}
dataShareHelper.insert(uri, valueBucket).then((data) => {
console.log("insert succeed, data : " + data);
}).catch((err) => {
console.log("insert failed, error message : " + err);
});
``` ```
### getType ### delete
getType(uri: string, callback: AsyncCallback&lt;string&gt;): void delete(uri: string, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback&lt;number&gt;): void
获取URI所指定的数据的MIME类型。使用callback异步回调。 从数据库中删除一条或多条数据记录。使用callback异步回调。
此接口仅可在Stage模型下使用。 此接口仅可在Stage模型下使用。
...@@ -278,30 +298,34 @@ getType(uri: string, callback: AsyncCallback&lt;string&gt;): void ...@@ -278,30 +298,34 @@ getType(uri: string, callback: AsyncCallback&lt;string&gt;): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | --------------------------------------------- | | ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 表示指定的数据路径。 | | uri | string | 是 | 指示要删除的数据的路径。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。当具体的操作（视具体接口功能描述）成功，err为undefined，data为获取到的与URI指定的数据匹配的MIME类型；否则为错误对象。 | | predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。<br />delete接口所支持的谓词方法取决于服务端所选用的数据库，如KVDB的删除目前仅支持inKeys谓词。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。当从数据库中删除一条或多条数据记录成功，err为undefined，data为获取到的已删除的数据记录数；否则为错误对象。<br />因部分数据库（如KVDB）的相应接口并不提供相应支持，故若服务端使用此数据库，则此callback也无法返回删除的数据记录数。 |
**示例：** **示例：**
```ts ```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates'
let uri = ("datashare:///com.samples.datasharetest.DataShare"); let uri = ("datashare:///com.samples.datasharetest.DataShare");
dataShareHelper.getType(uri, (err, data)=>{ let da = new dataSharePredicates.DataSharePredicates();
da.equalTo("name", "ZhangSan");
dataShareHelper.delete(uri, da, (err, data) => {
if (err != undefined) { if (err != undefined) {
console.log("getType failed, error message : " + err); console.log("delete failed, error message : " + err);
}else{ }else{
console.log("getType succeed, data : " + data); console.log("delete succeed, data : " + data);
let result = data;
} }
}); });
``` ```
### getType ### delete
getType(uri: string): Promise&lt;string&gt; delete(uri: string, predicates: dataSharePredicates.DataSharePredicates): Promise&lt;number&gt;
获取URI所指定数据的MIME类型。使用Promise异步回调。 从数据库中删除一条或多条数据记录。使用Promise异步回调。
此接口仅可在Stage模型下使用。 此接口仅可在Stage模型下使用。
...@@ -309,32 +333,37 @@ getType(uri: string): Promise&lt;string&gt; ...@@ -309,32 +333,37 @@ getType(uri: string): Promise&lt;string&gt;
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | -------------------- | | ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 表示指定的数据路径。 | | uri | string | 是 | 指示要删除的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。<br />delete接口所支持的谓词方法取决于服务端所选用的数据库，如KVDB的删除目前仅支持inKeys谓词。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ----------------------------------- | | ---------------- | ------------------------------------------------------------ |
| Promise&lt;string&gt; | Promise对象。返回与URI指定的数据匹配的MIME类型。 | | Promise&lt;number&gt; | Promise对象。返回已删除的数据记录数。<br />因部分数据库（如KVDB）的相应接口并不提供相应支持，故若服务端使用此数据库，则此Promise也无法返回删除的数据记录数。 |
**示例：** **示例：**
```ts ```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates'
let uri = ("datashare:///com.samples.datasharetest.DataShare"); let uri = ("datashare:///com.samples.datasharetest.DataShare");
dataShareHelper.getType(uri).then((data) => { let da = new dataSharePredicates.DataSharePredicates();
console.log("getType succeed, data : " + data); da.equalTo("name", "ZhangSan");
dataShareHelper.delete(uri, da).then((data) => {
console.log("delete succeed, data : " + data);
}).catch((err) => { }).catch((err) => {
console.log("getType failed, error message : " + err); console.log("delete failed, error message : " + err);
}); });
``` ```
### getFileTypes ### query
getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void query(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array&lt;string&gt;, callback: AsyncCallback&lt;DataShareResultSet&gt;): void
获取支持的文件的MIME类型。使用callback异步回调。 查询数据库中的数据。使用callback异步回调。
此接口仅可在Stage模型下使用。 此接口仅可在Stage模型下使用。
...@@ -342,31 +371,36 @@ getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback&lt;Arr ...@@ -342,31 +371,36 @@ getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback&lt;Arr
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 指示要获取的文件的路径。 | | uri | string | 是 | 指示要查询的数据的路径。 |
| mimeTypeFilter | string | 是 | 指示要筛选的MIME类型。例如：<br />“\*/\*”：获取支持的所有类型。<br/>“image/\*”：获取主类型image，子类型为任何类型的MIME。<br />”\*/jpg”：获取子类型为jpg，主类型为任何类型的MIME。 | | predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。<br />query接口所支持的谓词方法取决于服务端所选用的数据库，如KVDB目前仅支持inKeys和prefixKey。 |
| callback | openFile(uri: string, mode: string, callback: AsyncCallback<number>) {    let err = {"code":0};    let fd = 0;    callback(err,fd);}ts | 是 | 回调函数。当具体的操作（视具体接口功能描述）成功，err为undefined，data为获取到的匹配的MIME类型数组；否则为错误对象。 | | columns | Array&lt;string&gt; | 是 | 指示要查询的列。如果此参数为空，则查询所有列。 |
| callback | AsyncCallback&lt;[DataShareResultSet](js-apis-data-DataShareResultSet.md#datashareresultset)&gt; | 是 | 回调函数。当查询数据库中的数据成功，err为undefined，data为获取到的查询到的结果集；否则为错误对象。 |
**示例：** **示例：**
```ts ```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates'
let uri = ("datashare:///com.samples.datasharetest.DataShare"); let uri = ("datashare:///com.samples.datasharetest.DataShare");
let mimeTypeFilter = "image/*"; let columns = ["*"];
dataShareHelper.getFileTypes(uri, mimeTypeFilter, (err,data) => { let da = new dataSharePredicates.DataSharePredicates();
da.equalTo("name", "ZhangSan");
dataShareHelper.query(uri, da, columns, (err, data) => {
if (err != undefined) { if (err != undefined) {
console.log("getFileTypes failed, error message : " + err); console.log("query failed, error message : " + err);
}else{ }else{
console.log("getFileTypes succeed, data : " + data); console.log("query succeed, rowCount : " + data.rowCount);
} }
}); });
``` ```
### getFileTypes ### query
getFileTypes(uri: string, mimeTypeFilter: string): Promise&lt;Array&lt;string&gt;&gt; query(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array&lt;string&gt;): Promise&lt;DataShareResultSet&gt;
获取支持的文件的MIME类型。使用Promise异步回调。 查询数据库中的数据。使用Promise异步回调。
此接口仅可在Stage模型下使用。 此接口仅可在Stage模型下使用。
...@@ -374,34 +408,39 @@ getFileTypes(uri: string, mimeTypeFilter: string): Promise&lt;Array&lt;string&gt ...@@ -374,34 +408,39 @@ getFileTypes(uri: string, mimeTypeFilter: string): Promise&lt;Array&lt;string&gt
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------------- | ------ | ---- | ------------------------------------------------------------ | | ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 指示要获取的文件的路径。 | | uri | string | 是 | 指示要查询的数据的路径。 |
| mimeTypeFilter | string | 是 | 指示要筛选的MIME类型。例如：<br />“\*/\*”：获取支持的所有类型。<br/>“image/\*”：获取主类型image，子类型为任何类型的MIME。<br />”\*/jpg”：获取子类型为jpg，主类型为任何类型的MIME。 | | predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。<br />query接口所支持的谓词方法取决于服务端所选用的数据库，如KVDB目前仅支持inKeys和prefixKey。 |
| columns | Array&lt;string&gt; | 是 | 指示要查询的列。如果此参数为空，则查询所有列。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------ | ------------------------ | | ------------------------------------------------------------ | --------------------------------- |
| Promise&lt;Array&lt;string&gt;&gt; | Promise对象。返回匹配的MIME类型数组。 | | Promise&lt;[DataShareResultSet](js-apis-data-DataShareResultSet.md#datashareresultset)&gt; | Promise对象。返回查询到的结果集。 |
**示例：** **示例：**
```ts ```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates'
let uri = ("datashare:///com.samples.datasharetest.DataShare"); let uri = ("datashare:///com.samples.datasharetest.DataShare");
let mimeTypeFilter = "image/*"; let columns = ["*"];
dataShareHelper.getFileTypes(uri, mimeTypeFilter).then((data) => { let da = new dataSharePredicates.DataSharePredicates();
console.log("getFileTypes succeed, data : " + data); da.equalTo("name", "ZhangSan");
dataShareHelper.query(uri, da, columns).then((data) => {
console.log("query succeed, rowCount : " + data.rowCount);
}).catch((err) => { }).catch((err) => {
console.log("getFileTypes failed, error message : " + err); console.log("query failed, error message : " + err);
}); });
``` ```
### normalizeUri ### update
normalizeUri(uri: string, callback: AsyncCallback&lt;string&gt;): void update(uri: string, predicates: dataSharePredicates.DataSharePredicates, value: ValuesBucket, callback: AsyncCallback&lt;number&gt;): void
将给定的DataShare URI转换为规范化URI，规范化URI可供跨设备使用，DataShare URI仅供本地环境中使用。使用callback异步回调。 更新数据库中的数据记录。使用callback异步回调。
此接口仅可在Stage模型下使用。 此接口仅可在Stage模型下使用。
...@@ -409,29 +448,41 @@ normalizeUri(uri: string, callback: AsyncCallback&lt;string&gt;): void ...@@ -409,29 +448,41 @@ normalizeUri(uri: string, callback: AsyncCallback&lt;string&gt;): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | -------------------------------------------------------- | | ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 指示要规范化的[URI](js-apis-uri.md#uri)。 | | uri | string | 是 | 指示要更新的数据的路径。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。当具体的操作（视具体接口功能描述）成功，err为undefined，data为获取到的规范化URI（如果支持URI规范化，则返回规范化URI，否则返回空）；否则为错误对象。 | | predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。<br />update接口是否支持谓词筛选条件取决于服务端所选用的数据库，如KVDB目前并不支持谓词筛选条件，仅RDB支持。 |
| value | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要更新的数据。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。当更新数据库中的数据记录成功，err为undefined，data为获取到的更新的数据记录数；否则为错误对象。<br />因部分数据库（如KVDB）的相应接口并不提供相应支持，故若服务端使用此数据库，则此callback也无法返回更新的数据记录数。 |
**示例：** **示例：**
```ts ```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates'
let uri = ("datashare:///com.samples.datasharetest.DataShare"); let uri = ("datashare:///com.samples.datasharetest.DataShare");
dataShareHelper.normalizeUri(uri, (err, data) => { let da = new dataSharePredicates.DataSharePredicates();
da.equalTo("name", "ZhangSan");
const va = {
"name": "roe1",
"age": 21,
"salary": 20.5,
}
dataShareHelper.update(uri, da, va, (err, data) => {
if (err != undefined) { if (err != undefined) {
console.log("normalizeUri failed, error message : " + err); console.log("update failed, error message : " + err);
}else{ }else{
console.log("normalizeUri = " + data); console.log("update succeed, data : " + data);
} }
}); });
``` ```
### normalizeUri ### update
normalizeUri(uri: string): Promise&lt;string&gt; update(uri: string, predicates: dataSharePredicates.DataSharePredicates, value: ValuesBucket): Promise&lt;number&gt;
将给定的DataShare URI转换为规范化URI，规范化URI可供跨设备使用，DataShare URI仅供本地环境中使用。使用Promise异步回调。 更新数据库中的数据记录。使用Promise异步回调。
此接口仅可在Stage模型下使用。 此接口仅可在Stage模型下使用。
...@@ -439,32 +490,44 @@ normalizeUri(uri: string): Promise&lt;string&gt; ...@@ -439,32 +490,44 @@ normalizeUri(uri: string): Promise&lt;string&gt;
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | ----------------------------------------- | | ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 指示要规范化的[URI](js-apis-uri.md#uri)。 | | uri | string | 是 | 指示要更新的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。<br />update接口是否支持谓词筛选条件取决于服务端所选用的数据库，如KVDB目前并不支持谓词筛选条件，仅RDB支持。 |
| value | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要更新的数据。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ---------------------------------------------- | | ---------------- | ------------------------------------------------------------ |
| Promise&lt;string&gt; | Promise对象。如果支持URI规范化，则返回规范化URI，否则返回空。 | | Promise&lt;number&gt; | Promise对象。返回更新的数据记录数。<br />因部分数据库（如KVDB）的相应接口并不提供相应支持，故若服务端使用此数据库，则此Promise也无法返回更新的数据记录数。 |
**示例：** **示例：**
```ts ```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates'
let uri = ("datashare:///com.samples.datasharetest.DataShare"); let uri = ("datashare:///com.samples.datasharetest.DataShare");
dataShareHelper.normalizeUri(uri).then((data) => { let da = new dataSharePredicates.DataSharePredicates();
console.log("normalizeUri = " + data); da.equalTo("name", "ZhangSan");
const va = {
"name": "roe1",
"age": 21,
"salary": 20.5,
}
dataShareHelper.update(uri, da, va).then((data) => {
console.log("update succeed, data : " + data);
}).catch((err) => { }).catch((err) => {
console.log("normalizeUri failed, error message : " + err); console.log("update failed, error message : " + err);
}); });
``` ```
### denormalizeUri ### batchInsert
denormalizeUri(uri: string, callback: AsyncCallback&lt;string&gt;): void batchInsert(uri: string, values: Array&lt;ValuesBucket&gt;, callback: AsyncCallback&lt;number&gt;): void
将指定的URI转换为非规范化URI。使用callback异步回调。 将批量数据插入数据库。使用callback异步回调。
此接口仅可在Stage模型下使用。 此接口仅可在Stage模型下使用。
...@@ -472,29 +535,33 @@ denormalizeUri(uri: string, callback: AsyncCallback&lt;string&gt;): void ...@@ -472,29 +535,33 @@ denormalizeUri(uri: string, callback: AsyncCallback&lt;string&gt;): void
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | --------------------------------------------------- | | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 指示要反规范化的[URI](js-apis-uri.md#uri)。 | | uri | string | 是 | 指示要插入的数据的路径。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。当具体的操作（视具体接口功能描述）成功，err为undefined，data为获取到的反规范化URI（如果反规范化成功，则返回反规范化的URI；如果无需进行反规范化，则返回原始URI；若不支持则返回空）；否则为错误对象。 | | values | Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是 | 指示要插入的数据。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。当将批量数据插入数据库成功，err为undefined，data为获取到的插入的数据记录数；否则为错误对象。<br />因部分数据库（如KVDB）的相应接口并不提供相应支持，故若服务端使用此数据库，则此Promise也无法返回插入的数据记录数。 |
**示例：** **示例：**
```ts ```ts
let uri = ("datashare:///com.samples.datasharetest.DataShare"); let uri = ("datashare:///com.samples.datasharetest.DataShare");
dataShareHelper.denormalizeUri(uri, (err, data) => { let vbs = new Array({"name": "roe11", "age": 21, "salary": 20.5,},
{"name": "roe12", "age": 21, "salary": 20.5,},
{"name": "roe13", "age": 21, "salary": 20.5,})
dataShareHelper.batchInsert(uri, vbs, (err, data) => {
if (err != undefined) { if (err != undefined) {
console.log("denormalizeUri failed, error message : " + err); console.log("batchInsert failed, error message : " + err);
}else{ }else{
console.log("denormalizeUri = " + data); console.log("batchInsert succeed, data : " + data);
} }
}); });
``` ```
### denormalizeUri ### batchInsert
denormalizeUri(uri: string): Promise&lt;string&gt; batchInsert(uri: string, values: Array&lt;ValuesBucket&gt;): Promise&lt;number&gt;
将指定的URI转换为非规范化URI。使用Promise异步回调。 将批量数据插入数据库。使用Promise异步回调。
此接口仅可在Stage模型下使用。 此接口仅可在Stage模型下使用。
...@@ -502,32 +569,36 @@ denormalizeUri(uri: string): Promise&lt;string&gt; ...@@ -502,32 +569,36 @@ denormalizeUri(uri: string): Promise&lt;string&gt;
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | ------------------------------------------- | | ------ | ------------------------------------------------------------ | ---- | ------------------------ |
| uri | string | 是 | 指示要反规范化的[URI](js-apis-uri.md#uri)。 | | uri | string | 是 | 指示要插入的数据的路径。 |
| values | Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是 | 指示要插入的数据。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ----------------------------------------- | | ---------------- | ------------------------------------------------------------ |
| Promise&lt;string&gt; | Promise对象。如果反规范化成功，则返回反规范化的URI；如果无需执行任何操作，则返回原始URI；若不支持则返回空。 | | Promise&lt;number&gt; | Promise对象。返回插入的数据记录数。<br />因部分数据库（如KVDB）的相应接口并不提供相应支持，故若服务端使用此数据库，则此Promise也无法返回插入的数据记录数。 |
**示例：** **示例：**
```ts ```ts
let uri = ("datashare:///com.samples.datasharetest.DataShare"); let uri = ("datashare:///com.samples.datasharetest.DataShare");
dataShareHelper.denormalizeUri(uri).then((data) => { let vbs = new Array({"name": "roe11", "age": 21, "salary": 20.5,},
console.log("denormalizeUri = " + data); {"name": "roe12", "age": 21, "salary": 20.5,},
{"name": "roe13", "age": 21, "salary": 20.5,})
dataShareHelper.batchInsert(uri, vbs).then((data) => {
console.log("batchInsert succeed, data : " + data);
}).catch((err) => { }).catch((err) => {
console.log("denormalizeUri failed, error message : " + err); console.log("batchInsert failed, error message : " + err);
}); });
``` ```
### insert ### getType
insert(uri: string, value: ValuesBucket, callback: AsyncCallback&lt;number&gt;): void getType(uri: string, callback: AsyncCallback&lt;string&gt;): void
将单条数据插入数据库。使用callback异步回调。 获取URI所指定的数据的MIME类型。使用callback异步回调。
此接口仅可在Stage模型下使用。 此接口仅可在Stage模型下使用。
...@@ -535,35 +606,30 @@ insert(uri: string, value: ValuesBucket, callback: AsyncCallback&lt;number&gt;): ...@@ -535,35 +606,30 @@ insert(uri: string, value: ValuesBucket, callback: AsyncCallback&lt;number&gt;):
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ | | -------- | ---------------------- | ---- | --------------------------------------------- |
| uri | string | 是 | 指示要插入的数据的路径。 | | uri | string | 是 | 表示指定的数据路径。 |
| value | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要插入的数据。如果此参数为空，将插入一个空行。 | | callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。当获取URI所指定的数据的MIME类型成功，err为undefined，data为获取到的与URI指定的数据匹配的MIME类型；否则为错误对象。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。当具体的操作（视具体接口功能描述）成功，err为undefined，data为获取到的插入数据记录的索引；否则为错误对象。<br />因部分数据库（如KVDB）的相应接口并不支持返回索引，故若服务端使用了不支持索引的数据库，则此callback也无法返回索引值。 |
**示例：** **示例：**
```ts ```ts
let uri = ("datashare:///com.samples.datasharetest.DataShare"); let uri = ("datashare:///com.samples.datasharetest.DataShare");
const valueBucket = { dataShareHelper.getType(uri, (err, data)=>{
"name": "rose",
"age": 22,
"salary": 200.5,
}
dataShareHelper.insert(uri, valueBucket, (err, data) => {
if (err != undefined) { if (err != undefined) {
console.log("insert failed, error message : " + err); console.log("getType failed, error message : " + err);
}else{ }else{
console.log("insert succeed, data : " + data); console.log("getType succeed, data : " + data);
let result = data;
} }
}); });
``` ```
### insert ### getType
insert(uri: string, value: ValuesBucket): Promise&lt;number&gt; getType(uri: string): Promise&lt;string&gt;
将单条数据插入数据库。使用Promise异步回调。 获取URI所指定数据的MIME类型。使用Promise异步回调。
此接口仅可在Stage模型下使用。 此接口仅可在Stage模型下使用。
...@@ -571,38 +637,32 @@ insert(uri: string, value: ValuesBucket): Promise&lt;number&gt; ...@@ -571,38 +637,32 @@ insert(uri: string, value: ValuesBucket): Promise&lt;number&gt;
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----- | --------------------------------------------------------- | ---- | -------------------------------------------------- | | ---- | ------ | ---- | -------------------- |
| uri | string | 是 | 指示要插入的数据的路径。 | | uri | string | 是 | 表示指定的数据路径。 |
| value | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要插入的数据。如果此参数为空，将插入一个空行。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ------------------------------------------------------------ | | ---------------- | ----------------------------------- |
| Promise&lt;number&gt; | Promise对象。返回插入数据记录的索引。<br />因部分数据库（如KVDB）的相应接口并不支持返回索引，故若服务端使用了不支持索引的数据库，则此Promise也无法返回索引值。 | | Promise&lt;string&gt; | Promise对象。返回与URI指定的数据匹配的MIME类型。 |
**示例：** **示例：**
```ts ```ts
let uri = ("datashare:///com.samples.datasharetest.DataShare"); let uri = ("datashare:///com.samples.datasharetest.DataShare");
const valueBucket = { dataShareHelper.getType(uri).then((data) => {
"name": "rose1", console.log("getType succeed, data : " + data);
"age": 221,
"salary": 20.5,
}
dataShareHelper.insert(uri, valueBucket).then((data) => {
console.log("insert succeed, data : " + data);
}).catch((err) => { }).catch((err) => {
console.log("insert failed, error message : " + err); console.log("getType failed, error message : " + err);
}); });
``` ```
### batchInsert ### getFileTypes
batchInsert(uri: string, values: Array&lt;ValuesBucket&gt;, callback: AsyncCallback&lt;number&gt;): void getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void
将批量数据插入数据库。使用callback异步回调。 获取支持的文件的MIME类型。使用callback异步回调。
此接口仅可在Stage模型下使用。 此接口仅可在Stage模型下使用。
...@@ -610,33 +670,31 @@ batchInsert(uri: string, values: Array&lt;ValuesBucket&gt;, callback: AsyncCallb ...@@ -610,33 +670,31 @@ batchInsert(uri: string, values: Array&lt;ValuesBucket&gt;, callback: AsyncCallb
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 指示要插入的数据的路径。 | | uri | string | 是 | 指示要获取的文件的路径。 |
| values | Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是 | 指示要插入的数据。 | | mimeTypeFilter | string | 是 | 指示要筛选的MIME类型。例如：<br />“\*/\*”：获取支持的所有类型。<br/>“image/\*”：获取主类型image，子类型为任何类型的MIME。<br />”\*/jpg”：获取子类型为jpg，主类型为任何类型的MIME。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。当具体的操作（视具体接口功能描述）成功，err为undefined，data为获取到的插入的数据记录数；否则为错误对象。<br />因部分数据库（如KVDB）的相应接口并不提供相应支持，故若服务端使用此数据库，则此Promise也无法返回插入的数据记录数。 | | callback | openFile(uri: string, mode: string, callback: AsyncCallback<number>) {    let err = {"code":0};    let fd = 0;    callback(err,fd);}ts | 是 | 回调函数。当获取支持的文件的MIME类型成功，err为undefined，data为获取到的匹配的MIME类型数组；否则为错误对象。 |
**示例：** **示例：**
```ts ```ts
let uri = ("datashare:///com.samples.datasharetest.DataShare"); let uri = ("datashare:///com.samples.datasharetest.DataShare");
let vbs = new Array({"name": "roe11", "age": 21, "salary": 20.5,}, let mimeTypeFilter = "image/*";
{"name": "roe12", "age": 21, "salary": 20.5,}, dataShareHelper.getFileTypes(uri, mimeTypeFilter, (err,data) => {
{"name": "roe13", "age": 21, "salary": 20.5,})
dataShareHelper.batchInsert(uri, vbs, (err, data) => {
if (err != undefined) { if (err != undefined) {
console.log("batchInsert failed, error message : " + err); console.log("getFileTypes failed, error message : " + err);
}else{ }else{
console.log("batchInsert succeed, data : " + data); console.log("getFileTypes succeed, data : " + data);
} }
}); });
``` ```
### batchInsert ### getFileTypes
batchInsert(uri: string, values: Array&lt;ValuesBucket&gt;): Promise&lt;number&gt; getFileTypes(uri: string, mimeTypeFilter: string): Promise&lt;Array&lt;string&gt;&gt;
将批量数据插入数据库。使用Promise异步回调。 获取支持的文件的MIME类型。使用Promise异步回调。
此接口仅可在Stage模型下使用。 此接口仅可在Stage模型下使用。
...@@ -644,36 +702,34 @@ batchInsert(uri: string, values: Array&lt;ValuesBucket&gt;): Promise&lt;number&g ...@@ -644,36 +702,34 @@ batchInsert(uri: string, values: Array&lt;ValuesBucket&gt;): Promise&lt;number&g
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ------ | ------------------------------------------------------------ | ---- | ------------------------ | | -------------- | ------ | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 指示要插入的数据的路径。 | | uri | string | 是 | 指示要获取的文件的路径。 |
| values | Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是 | 指示要插入的数据。 | | mimeTypeFilter | string | 是 | 指示要筛选的MIME类型。例如：<br />“\*/\*”：获取支持的所有类型。<br/>“image/\*”：获取主类型image，子类型为任何类型的MIME。<br />”\*/jpg”：获取子类型为jpg，主类型为任何类型的MIME。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ------------------------------------------------------------ | | ------------------------ | ------------------------ |
| Promise&lt;number&gt; | Promise对象。返回插入的数据记录数。<br />因部分数据库（如KVDB）的相应接口并不提供相应支持，故若服务端使用此数据库，则此Promise也无法返回插入的数据记录数。 | | Promise&lt;Array&lt;string&gt;&gt; | Promise对象。返回匹配的MIME类型数组。 |
**示例：** **示例：**
```ts ```ts
let uri = ("datashare:///com.samples.datasharetest.DataShare"); let uri = ("datashare:///com.samples.datasharetest.DataShare");
let vbs = new Array({"name": "roe11", "age": 21, "salary": 20.5,}, let mimeTypeFilter = "image/*";
{"name": "roe12", "age": 21, "salary": 20.5,}, dataShareHelper.getFileTypes(uri, mimeTypeFilter).then((data) => {
{"name": "roe13", "age": 21, "salary": 20.5,}) console.log("getFileTypes succeed, data : " + data);
dataShareHelper.batchInsert(uri, vbs).then((data) => {
console.log("batchInsert succeed, data : " + data);
}).catch((err) => { }).catch((err) => {
console.log("batchInsert failed, error message : " + err); console.log("getFileTypes failed, error message : " + err);
}); });
``` ```
### delete ### normalizeUri
delete(uri: string, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback&lt;number&gt;): void normalizeUri(uri: string, callback: AsyncCallback&lt;string&gt;): void
从数据库中删除一条或多条数据记录。使用callback异步回调。 将给定的DataShare URI转换为规范化URI，规范化URI可供跨设备使用，DataShare URI仅供本地环境中使用。使用callback异步回调。
此接口仅可在Stage模型下使用。 此接口仅可在Stage模型下使用。
...@@ -681,34 +737,29 @@ delete(uri: string, predicates: dataSharePredicates.DataSharePredicates, callbac ...@@ -681,34 +737,29 @@ delete(uri: string, predicates: dataSharePredicates.DataSharePredicates, callbac
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ---------------------- | ---- | -------------------------------------------------------- |
| uri | string | 是 | 指示要删除的数据的路径。 | | uri | string | 是 | 指示要规范化的[URI](js-apis-uri.md#uri)。 |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。<br />delete接口所支持的谓词方法取决于服务端所选用的数据库，如KVDB的删除目前仅支持inKeys谓词。 | | callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。当将给定的DataShare URI转换为规范化URI成功，err为undefined，data为获取到的规范化URI（如果支持URI规范化，则返回规范化URI，否则返回空）；否则为错误对象。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。当具体的操作（视具体接口功能描述）成功，err为undefined，data为获取到的已删除的数据记录数；否则为错误对象。<br />因部分数据库（如KVDB）的相应接口并不提供相应支持，故若服务端使用此数据库，则此callback也无法返回删除的数据记录数。 |
**示例：** **示例：**
```ts ```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates'
let uri = ("datashare:///com.samples.datasharetest.DataShare"); let uri = ("datashare:///com.samples.datasharetest.DataShare");
let da = new dataSharePredicates.DataSharePredicates(); dataShareHelper.normalizeUri(uri, (err, data) => {
da.equalTo("name", "ZhangSan");
dataShareHelper.delete(uri, da, (err, data) => {
if (err != undefined) { if (err != undefined) {
console.log("delete failed, error message : " + err); console.log("normalizeUri failed, error message : " + err);
}else{ }else{
console.log("delete succeed, data : " + data); console.log("normalizeUri = " + data);
} }
}); });
``` ```
### delete ### normalizeUri
delete(uri: string, predicates: dataSharePredicates.DataSharePredicates): Promise&lt;number&gt; normalizeUri(uri: string): Promise&lt;string&gt;
从数据库中删除一条或多条数据记录。使用Promise异步回调。 将给定的DataShare URI转换为规范化URI，规范化URI可供跨设备使用，DataShare URI仅供本地环境中使用。使用Promise异步回调。
此接口仅可在Stage模型下使用。 此接口仅可在Stage模型下使用。
...@@ -716,37 +767,32 @@ delete(uri: string, predicates: dataSharePredicates.DataSharePredicates): Promis ...@@ -716,37 +767,32 @@ delete(uri: string, predicates: dataSharePredicates.DataSharePredicates): Promis
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | ---- | ------ | ---- | ----------------------------------------- |
| uri | string | 是 | 指示要删除的数据的路径。 | | uri | string | 是 | 指示要规范化的[URI](js-apis-uri.md#uri)。 |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。<br />delete接口所支持的谓词方法取决于服务端所选用的数据库，如KVDB的删除目前仅支持inKeys谓词。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ------------------------------------------------------------ | | ---------------- | ---------------------------------------------- |
| Promise&lt;number&gt; | Promise对象。返回已删除的数据记录数。<br />因部分数据库（如KVDB）的相应接口并不提供相应支持，故若服务端使用此数据库，则此Promise也无法返回删除的数据记录数。 | | Promise&lt;string&gt; | Promise对象。如果支持URI规范化，则返回规范化URI，否则返回空。 |
**示例：** **示例：**
```ts ```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates'
let uri = ("datashare:///com.samples.datasharetest.DataShare"); let uri = ("datashare:///com.samples.datasharetest.DataShare");
let da = new dataSharePredicates.DataSharePredicates(); dataShareHelper.normalizeUri(uri).then((data) => {
da.equalTo("name", "ZhangSan"); console.log("normalizeUri = " + data);
dataShareHelper.delete(uri, da).then((data) => {
console.log("delete succeed, data : " + data);
}).catch((err) => { }).catch((err) => {
console.log("delete failed, error message : " + err); console.log("normalizeUri failed, error message : " + err);
}); });
``` ```
### update ### denormalizeUri
update(uri: string, predicates: dataSharePredicates.DataSharePredicates, value: ValuesBucket, callback: AsyncCallback&lt;number&gt;): void denormalizeUri(uri: string, callback: AsyncCallback&lt;string&gt;): void
更新数据库中的数据记录。使用callback异步回调。 将指定的URI转换为非规范化URI。使用callback异步回调。
此接口仅可在Stage模型下使用。 此接口仅可在Stage模型下使用。
...@@ -754,41 +800,29 @@ update(uri: string, predicates: dataSharePredicates.DataSharePredicates, value: ...@@ -754,41 +800,29 @@ update(uri: string, predicates: dataSharePredicates.DataSharePredicates, value:
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | ---------------------- | ---- | --------------------------------------------------- |
| uri | string | 是 | 指示要更新的数据的路径。 | | uri | string | 是 | 指示要反规范化的[URI](js-apis-uri.md#uri)。 |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。<br />update接口是否支持谓词筛选条件取决于服务端所选用的数据库，如KVDB目前并不支持谓词筛选条件，仅RDB支持。 | | callback | AsyncCallback&lt;string&gt; | 是 | 回调函数。当将指定的URI转换为非规范化URI，err为undefined，data为获取到的反规范化URI（如果反规范化成功，则返回反规范化的URI；如果无需进行反规范化，则返回原始URI；若不支持则返回空）；否则为错误对象。 |
| value | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要更新的数据。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。当具体的操作（视具体接口功能描述）成功，err为undefined，data为获取到的更新的数据记录数；否则为错误对象。<br />因部分数据库（如KVDB）的相应接口并不提供相应支持，故若服务端使用此数据库，则此callback也无法返回更新的数据记录数。 |
**示例：** **示例：**
```ts ```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates'
let uri = ("datashare:///com.samples.datasharetest.DataShare"); let uri = ("datashare:///com.samples.datasharetest.DataShare");
let da = new dataSharePredicates.DataSharePredicates(); dataShareHelper.denormalizeUri(uri, (err, data) => {
da.equalTo("name", "ZhangSan");
const va = {
"name": "roe1",
"age": 21,
"salary": 20.5,
}
dataShareHelper.update(uri, da, va, (err, data) => {
if (err != undefined) { if (err != undefined) {
console.log("update failed, error message : " + err); console.log("denormalizeUri failed, error message : " + err);
}else{ }else{
console.log("update succeed, data : " + data); console.log("denormalizeUri = " + data);
} }
}); });
``` ```
### update ### denormalizeUri
update(uri: string, predicates: dataSharePredicates.DataSharePredicates, value: ValuesBucket): Promise&lt;number&gt; denormalizeUri(uri: string): Promise&lt;string&gt;
更新数据库中的数据记录。使用Promise异步回调。 将指定的URI转换为非规范化URI。使用Promise异步回调。
此接口仅可在Stage模型下使用。 此接口仅可在Stage模型下使用。
...@@ -796,44 +830,32 @@ update(uri: string, predicates: dataSharePredicates.DataSharePredicates, value: ...@@ -796,44 +830,32 @@ update(uri: string, predicates: dataSharePredicates.DataSharePredicates, value:
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | ---- | ------ | ---- | ------------------------------------------- |
| uri | string | 是 | 指示要更新的数据的路径。 | | uri | string | 是 | 指示要反规范化的[URI](js-apis-uri.md#uri)。 |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。<br />update接口是否支持谓词筛选条件取决于服务端所选用的数据库，如KVDB目前并不支持谓词筛选条件，仅RDB支持。 |
| value | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要更新的数据。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ------------------------------------------------------------ | | ---------------- | ----------------------------------------- |
| Promise&lt;number&gt; | Promise对象。返回更新的数据记录数。<br />因部分数据库（如KVDB）的相应接口并不提供相应支持，故若服务端使用此数据库，则此Promise也无法返回更新的数据记录数。 | | Promise&lt;string&gt; | Promise对象。如果反规范化成功，则返回反规范化的URI；如果无需执行任何操作，则返回原始URI；若不支持则返回空。 |
**示例：** **示例：**
```ts ```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates'
let uri = ("datashare:///com.samples.datasharetest.DataShare"); let uri = ("datashare:///com.samples.datasharetest.DataShare");
let da = new dataSharePredicates.DataSharePredicates(); dataShareHelper.denormalizeUri(uri).then((data) => {
da.equalTo("name", "ZhangSan"); console.log("denormalizeUri = " + data);
const va = {
"name": "roe1",
"age": 21,
"salary": 20.5,
}
dataShareHelper.update(uri, da, va).then((data) => {
console.log("update succeed, data : " + data);
}).catch((err) => { }).catch((err) => {
console.log("update failed, error message : " + err); console.log("denormalizeUri failed, error message : " + err);
}); });
``` ```
### query ### notifyChange
query(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array&lt;string&gt;, callback: AsyncCallback&lt;DataShareResultSet&gt;): void notifyChange(uri: string, callback: AsyncCallback&lt;void&gt;): void
查询数据库中的数据。使用callback异步回调。 通知已注册的观察者指定URI对应的数据资源已发生变更。使用callback异步回调。
此接口仅可在Stage模型下使用。 此接口仅可在Stage模型下使用。
...@@ -841,36 +863,25 @@ query(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns: ...@@ -841,36 +863,25 @@ query(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns:
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | -------------------- | ---- | ------------------------ |
| uri | string | 是 | 指示要查询的数据的路径。 | | uri | string | 是 | 表示指定的数据路径。 |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。<br />query接口所支持的谓词方法取决于服务端所选用的数据库，如KVDB目前仅支持inKeys和prefixKey。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当通知已注册的观察者指定URI对应的数据资源已发生变更成功，err为undefined；否则为错误对象。 |
| columns | Array&lt;string&gt; | 是 | 指示要查询的列。如果此参数为空，则查询所有列。 |
| callback | AsyncCallback&lt;[DataShareResultSet](js-apis-data-DataShareResultSet.md#datashareresultset)&gt; | 是 | 回调函数。当具体的操作（视具体接口功能描述）成功，err为undefined，data为获取到的查询到的结果集；否则为错误对象。 |
**示例：** **示例：**
```ts ```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates'
let uri = ("datashare:///com.samples.datasharetest.DataShare"); let uri = ("datashare:///com.samples.datasharetest.DataShare");
let columns = ["*"]; dataShareHelper.notifyChange(uri, () => {
let da = new dataSharePredicates.DataSharePredicates(); console.log("***** notifyChange *****");
da.equalTo("name", "ZhangSan");
dataShareHelper.query(uri, da, columns, (err, data) => {
if (err != undefined) {
console.log("query failed, error message : " + err);
}else{
console.log("query succeed, rowCount : " + data.rowCount);
}
}); });
``` ```
### query ### notifyChange
query(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array&lt;string&gt;): Promise&lt;DataShareResultSet&gt; notifyChange(uri: string): Promise&lt;void&gt;
查询数据库中的数据。使用Promise异步回调。 通知已注册的观察者指定URI对应的数据资源已发生变更。使用Promise异步回调。
此接口仅可在Stage模型下使用。 此接口仅可在Stage模型下使用。
...@@ -878,30 +889,19 @@ query(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns: ...@@ -878,30 +889,19 @@ query(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns:
**参数：** **参数：**
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | ---- | ------ | ---- | -------------------- |
| uri | string | 是 | 指示要查询的数据的路径。 | | uri | string | 是 | 表示指定的数据路径。 |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。<br />query接口所支持的谓词方法取决于服务端所选用的数据库，如KVDB目前仅支持inKeys和prefixKey。 |
| columns | Array&lt;string&gt; | 是 | 指示要查询的列。如果此参数为空，则查询所有列。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------------------------------ | --------------------------------- | | -------------- | --------------------- |
| Promise&lt;[DataShareResultSet](js-apis-data-DataShareResultSet.md#datashareresultset)&gt; | Promise对象。返回查询到的结果集。 | | Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
**示例：** **示例：**
```ts ```ts
import dataSharePredicates from '@ohos.data.dataSharePredicates'
let uri = ("datashare:///com.samples.datasharetest.DataShare"); let uri = ("datashare:///com.samples.datasharetest.DataShare");
let columns = ["*"]; dataShareHelper.notifyChange(uri);
let da = new dataSharePredicates.DataSharePredicates();
da.equalTo("name", "ZhangSan");
dataShareHelper.query(uri, da, columns).then((data) => {
console.log("query succeed, rowCount : " + data.rowCount);
}).catch((err) => {
console.log("query failed, error message : " + err);
});
``` ```
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或