js-apis-data-dataShare.md 31.3 KB
Newer Older
S
songruirui 已提交
1
# 数据共享
S
songruirui 已提交
2

S
songruirui 已提交
3
**DataShare**用于应用管理其自身数据,同时支持同个设备上不同应用间的数据共享。
S
songruirui 已提交
4

5
> **说明:** 
S
songruirui 已提交
6
>
7 8 9 10 11
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
> 本模块接口为系统接口。
>
> 本模块接口仅可在Stage模型下使用。
S
songruirui 已提交
12 13 14 15


## 导入模块

S
songruirui 已提交
16
```ts
S
songruirui 已提交
17 18 19 20 21 22
import dataShare from '@ohos.data.dataShare'
```


## dataShare.createDataShareHelper

S
songruirui 已提交
23
createDataShareHelper(context: Context, uri: string, callback: AsyncCallback<DataShareHelper>): void
S
songruirui 已提交
24

S
songruirui 已提交
25
创建DataShareHelper实例。使用callback异步回调。
S
songruirui 已提交
26

S
songruirui 已提交
27
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
28 29 30

**参数:**

S
songruirui 已提交
31 32 33 34
| 参数名   | 参数类型                                                 | 必填 | 说明                                                         |
| -------- | -------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| context  | [Context](js-apis-application-context.md#context)        | 是   | 应用的上下文环境。                                           |
| uri      | string                                                   | 是   | 指示要连接的服务端应用的路径。                               |
S
songruirui 已提交
35
| callback | AsyncCallback<[DataShareHelper](#datasharehelper)> | 是   | 回调函数。当创建DataShareHelper实例成功,err为undefined,data为获取到的DataShareHelper实例;否则为错误对象。 |
S
songruirui 已提交
36 37 38

**示例:**

S
songruirui 已提交
39
```ts
40
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
41

S
修改  
songruirui 已提交
42 43 44
let uri = ("datashare:///com.samples.datasharetest.DataShare");
let dataShareHelper;
dataShare.createDataShareHelper(this.context, uri, (err, data) => {
S
songruirui 已提交
45
    if (err != undefined) {
S
songruirui 已提交
46
        console.info("createDataShareHelper failed, error message : " + err);
S
songruirui 已提交
47
    } else {
S
songruirui 已提交
48
        console.info("createDataShareHelper succeed, data : " + data);
S
修改  
songruirui 已提交
49
        dataShareHelper = data;
S
songruirui 已提交
50 51 52 53
    }
});
```

S
songruirui 已提交
54 55 56 57
## dataShare.createDataShareHelper

createDataShareHelper(context: Context, uri: string): Promise<DataShareHelper>

S
songruirui 已提交
58
创建DataShareHelper实例。使用Promise异步回调。
S
songruirui 已提交
59 60 61 62 63

**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer

**参数:**

S
songruirui 已提交
64 65 66 67
| 参数名  | 参数类型                                          | 必填 | 说明                           |
| ------- | ------------------------------------------------- | ---- | ------------------------------ |
| context | [Context](js-apis-application-context.md#context) | 是   | 应用的上下文环境。             |
| uri     | string                                            | 是   | 指示要连接的服务端应用的路径。 |
S
songruirui 已提交
68 69 70

**返回值:**

S
songruirui 已提交
71 72 73
| 类型                                               | 说明                                   |
| -------------------------------------------------- | -------------------------------------- |
| Promise<[DataShareHelper](#datasharehelper)> | Promise对象。返回DataShareHelper实例。 |
S
songruirui 已提交
74 75 76 77

**示例:**

```ts
78
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
79

S
修改  
songruirui 已提交
80 81 82
let uri = ("datashare:///com.samples.datasharetest.DataShare");
let dataShareHelper;
dataShare.createDataShareHelper(this.context, uri).then((data) => {
S
songruirui 已提交
83
    console.info("createDataShareHelper succeed, data : " + data);
S
修改  
songruirui 已提交
84
    dataShareHelper = data;
S
songruirui 已提交
85
}).catch((err) => {
S
songruirui 已提交
86
	console.info("createDataShareHelper failed, error message : " + err); 
S
songruirui 已提交
87 88 89
})
```

S
songruirui 已提交
90 91
## DataShareHelper

S
修改  
songruirui 已提交
92
DataShare管理工具实例,可使用此实例访问或管理服务端的数据。在调用DataShareHelper提供的方法前,需要先通过[createDataShareHelper](#datasharecreatedatasharehelper)构建一个实例。
S
songruirui 已提交
93

S
songruirui 已提交
94 95
### on('dataChange')

S
songruirui 已提交
96
on(type: 'dataChange', uri: string, callback: AsyncCallback<void>): void
S
songruirui 已提交
97

S
songruirui 已提交
98 99
订阅指定URI对应数据的数据变更事件。若用户(订阅者)已注册了观察者,当有其他用户触发了变更通知时(调用了下文中的notifyChange方法),订阅者将会接收到callback通知。使用callback异步回调。

S
songruirui 已提交
100
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
101 102 103 104 105

**参数:**

| 名称     | 类型                 | 必填 | 描述                     |
| -------- | -------------------- | ---- | ------------------------ |
S
songruirui 已提交
106 107
| type     | string               | 是   | 订阅的事件/回调类型,支持的事件为'dataChange',当数据更改时,触发该事件。 |
| uri      | string               | 是   | 表示指定的数据路径。 |
S
songruirui 已提交
108
| callback | AsyncCallback<void> | 是   | 回调函数。当有其他用户触发了变更通知时调用,err为undefined;否则不被触发或为错误对象。 |
S
songruirui 已提交
109 110 111

**示例:**

S
songruirui 已提交
112
```ts
113
import Ability from '@ohos.application.Ability'
S
修改  
songruirui 已提交
114
function onCallback() {
S
songruirui 已提交
115 116
    console.info("**** Observer on callback ****");
}
S
songruirui 已提交
117
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
修改  
songruirui 已提交
118
dataShareHelper.on("dataChange", uri, onCallback);
S
songruirui 已提交
119 120 121 122
```

### off('dataChange')

S
songruirui 已提交
123
off(type: 'dataChange', uri: string, callback?: AsyncCallback<void>): void
S
songruirui 已提交
124

S
songruirui 已提交
125
取消订阅指定URI对应的数据资源的变更通知。使用callback异步回调。
S
songruirui 已提交
126

S
songruirui 已提交
127
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
128

S
songruirui 已提交
129 130 131 132
**参数:**

| 名称     | 类型                 | 必填 | 描述                     |
| -------- | -------------------- | ---- | ------------------------ |
S
songruirui 已提交
133 134
| type     | string               | 是   | 取消订阅的事件/回调类型,支持的事件为'dataChange'。 |
| uri      | string               | 是   | 表示指定的数据路径。 |
S
songruirui 已提交
135
| callback | AsyncCallback<void> | 否   | 回调函数。当取消订阅指定URI对应的数据资源的变更通知成功,err为undefined;否则为错误对象。 |
S
songruirui 已提交
136 137 138

**示例:**

S
songruirui 已提交
139
```ts
140
import Ability from '@ohos.application.Ability'
S
修改  
songruirui 已提交
141
function offCallback() {
S
songruirui 已提交
142 143
    console.info("**** Observer off callback ****");
}
S
songruirui 已提交
144
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
修改  
songruirui 已提交
145
dataShareHelper.off("dataChange", uri, offCallback);
S
songruirui 已提交
146 147
```

S
songruirui 已提交
148
### insert
S
songruirui 已提交
149

S
songruirui 已提交
150
insert(uri: string, value: ValuesBucket, callback: AsyncCallback<number>): void
S
songruirui 已提交
151

S
songruirui 已提交
152
将单条数据插入数据库。使用callback异步回调。
S
songruirui 已提交
153

S
songruirui 已提交
154
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
155 156 157

**参数:**

S
songruirui 已提交
158 159 160 161 162
| 名称     | 类型                                                      | 必填 | 描述                                                         |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| uri      | string                                                    | 是   | 指示要插入的数据的路径。                                     |
| value    | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是   | 指示要插入的数据。如果此参数为空,将插入一个空行。           |
| callback | AsyncCallback&lt;number&gt;                               | 是   | 回调函数。当将单条数据插入数据库成功,err为undefined,data为获取到的插入数据记录的索引;否则为错误对象。<br />因部分数据库(如KVDB)的相应接口并不支持返回索引,故若服务端使用了不支持索引的数据库,则此callback也无法返回索引值。 |
S
songruirui 已提交
163 164 165 166

**示例:**

```ts
167
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
168
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
169 170 171 172 173 174 175 176 177 178 179
const valueBucket = {
    "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);
    }
S
songruirui 已提交
180 181 182
});
```

S
songruirui 已提交
183
### insert
S
songruirui 已提交
184

S
songruirui 已提交
185
insert(uri: string, value: ValuesBucket): Promise&lt;number&gt;
S
songruirui 已提交
186

S
songruirui 已提交
187
将单条数据插入数据库。使用Promise异步回调。
S
songruirui 已提交
188

S
songruirui 已提交
189
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
190 191 192

**参数:**

S
songruirui 已提交
193 194 195 196
| 名称  | 类型                                                      | 必填 | 描述                                               |
| ----- | --------------------------------------------------------- | ---- | -------------------------------------------------- |
| uri   | string                                                    | 是   | 指示要插入的数据的路径。                           |
| value | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是   | 指示要插入的数据。如果此参数为空,将插入一个空行。 |
S
songruirui 已提交
197 198 199

**返回值:**

S
songruirui 已提交
200 201 202
| 类型             | 说明                                                         |
| ---------------- | ------------------------------------------------------------ |
| Promise&lt;number&gt; | Promise对象。返回插入数据记录的索引。<br />因部分数据库(如KVDB)的相应接口并不支持返回索引,故若服务端使用了不支持索引的数据库,则此Promise也无法返回索引值。 |
S
songruirui 已提交
203 204 205 206

**示例:**

```ts
207
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
208
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
209 210 211 212 213 214 215 216 217 218
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);
});
S
songruirui 已提交
219 220
```

S
songruirui 已提交
221
### delete
S
songruirui 已提交
222

S
songruirui 已提交
223
delete(uri: string, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback&lt;number&gt;): void
S
songruirui 已提交
224

S
songruirui 已提交
225
从数据库中删除一条或多条数据记录。使用callback异步回调。
S
songruirui 已提交
226

S
songruirui 已提交
227
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
228 229 230

**参数:**

S
songruirui 已提交
231 232 233
| 名称       | 类型                                                         | 必填 | 描述                                                         |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri        | string                                                       | 是   | 指示要删除的数据的路径。                                     |
234
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是   | 指示筛选条件。<br />delete接口所支持的谓词方法取决于服务端所选用的数据库,如KVDB的删除目前仅支持inKeys谓词。 |
S
songruirui 已提交
235
| callback   | AsyncCallback&lt;number&gt;                                  | 是   | 回调函数。当从数据库中删除一条或多条数据记录成功,err为undefined,data为获取到的已删除的数据记录数;否则为错误对象。<br />因部分数据库(如KVDB)的相应接口并不提供相应支持,故若服务端使用此数据库,则此callback也无法返回删除的数据记录数。 |
S
songruirui 已提交
236 237 238

**示例:**

S
songruirui 已提交
239
```ts
240
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
241 242
import dataSharePredicates from '@ohos.data.dataSharePredicates'

S
songruirui 已提交
243
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
244 245 246
let da = new dataSharePredicates.DataSharePredicates();
da.equalTo("name", "ZhangSan");
dataShareHelper.delete(uri, da, (err, data) => {
S
songruirui 已提交
247
    if (err != undefined) {
S
songruirui 已提交
248
        console.log("delete failed, error message : " + err);
S
songruirui 已提交
249
    }else{
S
songruirui 已提交
250
        console.log("delete succeed, data : " + data);
S
修改  
songruirui 已提交
251
    }
S
songruirui 已提交
252 253 254
});
```

S
songruirui 已提交
255
### delete
S
songruirui 已提交
256

S
songruirui 已提交
257
delete(uri: string, predicates: dataSharePredicates.DataSharePredicates): Promise&lt;number&gt;
S
songruirui 已提交
258

S
songruirui 已提交
259
从数据库中删除一条或多条数据记录。使用Promise异步回调。
S
songruirui 已提交
260

S
songruirui 已提交
261
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
262 263 264

**参数:**

S
songruirui 已提交
265 266 267
| 名称       | 类型                                                         | 必填 | 描述                                                         |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri        | string                                                       | 是   | 指示要删除的数据的路径。                                     |
268
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是   | 指示筛选条件。<br />delete接口所支持的谓词方法取决于服务端所选用的数据库,如KVDB的删除目前仅支持inKeys谓词。 |
S
songruirui 已提交
269 270 271

**返回值:**

S
songruirui 已提交
272 273 274
| 类型             | 说明                                                         |
| ---------------- | ------------------------------------------------------------ |
| Promise&lt;number&gt; | Promise对象。返回已删除的数据记录数。<br />因部分数据库(如KVDB)的相应接口并不提供相应支持,故若服务端使用此数据库,则此Promise也无法返回删除的数据记录数。 |
S
songruirui 已提交
275 276 277

**示例:**

S
songruirui 已提交
278
```ts
279
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
280 281
import dataSharePredicates from '@ohos.data.dataSharePredicates'

S
songruirui 已提交
282
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
283 284 285 286
let da = new dataSharePredicates.DataSharePredicates();
da.equalTo("name", "ZhangSan");
dataShareHelper.delete(uri, da).then((data) => {
    console.log("delete succeed, data : " + data);
S
songruirui 已提交
287
}).catch((err) => {
S
songruirui 已提交
288
    console.log("delete failed, error message : " + err);
S
songruirui 已提交
289 290 291
});
```

S
songruirui 已提交
292
### query
S
songruirui 已提交
293

S
songruirui 已提交
294
query(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array&lt;string&gt;, callback: AsyncCallback&lt;DataShareResultSet&gt;): void
S
songruirui 已提交
295

S
songruirui 已提交
296
查询数据库中的数据。使用callback异步回调。
S
songruirui 已提交
297

S
songruirui 已提交
298
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
299

S
songruirui 已提交
300 301
**参数:**

S
songruirui 已提交
302 303 304
| 名称       | 类型                                                         | 必填 | 描述                                                         |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri        | string                                                       | 是   | 指示要查询的数据的路径。                                     |
305
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是   | 指示筛选条件。<br />query接口所支持的谓词方法取决于服务端所选用的数据库,如KVDB目前仅支持inKeys和prefixKey。 |
S
songruirui 已提交
306 307
| columns    | Array&lt;string&gt;                                          | 是   | 指示要查询的列。如果此参数为空,则查询所有列。               |
| callback   | AsyncCallback&lt;[DataShareResultSet](js-apis-data-DataShareResultSet.md#datashareresultset)&gt; | 是   | 回调函数。当查询数据库中的数据成功,err为undefined,data为获取到的查询到的结果集;否则为错误对象。 |
S
songruirui 已提交
308 309 310

**示例:**

S
songruirui 已提交
311
```ts
312
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
313 314
import dataSharePredicates from '@ohos.data.dataSharePredicates'

S
songruirui 已提交
315
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
316 317 318 319
let columns = ["*"];
let da = new dataSharePredicates.DataSharePredicates();
da.equalTo("name", "ZhangSan");
dataShareHelper.query(uri, da, columns, (err, data) => {
S
songruirui 已提交
320
    if (err != undefined) {
S
songruirui 已提交
321
        console.log("query failed, error message : " + err);
S
songruirui 已提交
322
    }else{
S
songruirui 已提交
323
        console.log("query succeed, rowCount : " + data.rowCount);
S
songruirui 已提交
324
    }
S
songruirui 已提交
325 326 327
});
```

S
songruirui 已提交
328
### query
S
songruirui 已提交
329

S
songruirui 已提交
330
query(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array&lt;string&gt;): Promise&lt;DataShareResultSet&gt;
S
songruirui 已提交
331

S
songruirui 已提交
332
查询数据库中的数据。使用Promise异步回调。
S
songruirui 已提交
333

S
songruirui 已提交
334
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
335

S
songruirui 已提交
336 337
**参数:**

S
songruirui 已提交
338 339 340
| 名称       | 类型                                                         | 必填 | 描述                                                         |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri        | string                                                       | 是   | 指示要查询的数据的路径。                                     |
341
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是   | 指示筛选条件。<br />query接口所支持的谓词方法取决于服务端所选用的数据库,如KVDB目前仅支持inKeys和prefixKey。 |
S
songruirui 已提交
342
| columns    | Array&lt;string&gt;                                          | 是   | 指示要查询的列。如果此参数为空,则查询所有列。               |
S
songruirui 已提交
343 344 345

**返回值:**

S
songruirui 已提交
346 347 348
| 类型                                                         | 说明                              |
| ------------------------------------------------------------ | --------------------------------- |
| Promise&lt;[DataShareResultSet](js-apis-data-DataShareResultSet.md#datashareresultset)&gt; | Promise对象。返回查询到的结果集。 |
S
songruirui 已提交
349 350 351

**示例:**

S
songruirui 已提交
352
```ts
353
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
354 355
import dataSharePredicates from '@ohos.data.dataSharePredicates'

S
songruirui 已提交
356
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
357 358 359 360 361
let columns = ["*"];
let da = new dataSharePredicates.DataSharePredicates();
da.equalTo("name", "ZhangSan");
dataShareHelper.query(uri, da, columns).then((data) => {
    console.log("query succeed, rowCount : " + data.rowCount);
S
songruirui 已提交
362
}).catch((err) => {
S
songruirui 已提交
363
    console.log("query failed, error message : " + err);
S
songruirui 已提交
364 365 366
});
```

S
songruirui 已提交
367
### update
S
songruirui 已提交
368

S
songruirui 已提交
369
update(uri: string, predicates: dataSharePredicates.DataSharePredicates, value: ValuesBucket, callback: AsyncCallback&lt;number&gt;): void
S
songruirui 已提交
370

S
songruirui 已提交
371
更新数据库中的数据记录。使用callback异步回调。
S
songruirui 已提交
372

S
songruirui 已提交
373
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
374 375 376

**参数:**

S
songruirui 已提交
377 378 379
| 名称       | 类型                                                         | 必填 | 描述                                                         |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri        | string                                                       | 是   | 指示要更新的数据的路径。                                     |
380
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是   | 指示筛选条件。<br />update接口是否支持谓词筛选条件取决于服务端所选用的数据库,如KVDB目前并不支持谓词筛选条件,仅RDB支持。 |
S
songruirui 已提交
381 382
| value      | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)    | 是   | 指示要更新的数据。                                           |
| callback   | AsyncCallback&lt;number&gt;                                  | 是   | 回调函数。当更新数据库中的数据记录成功,err为undefined,data为获取到的更新的数据记录数;否则为错误对象。<br />因部分数据库(如KVDB)的相应接口并不提供相应支持,故若服务端使用此数据库,则此callback也无法返回更新的数据记录数。 |
S
songruirui 已提交
383 384 385

**示例:**

S
songruirui 已提交
386
```ts
387
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
388 389
import dataSharePredicates from '@ohos.data.dataSharePredicates'

S
songruirui 已提交
390
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
391 392 393 394 395 396 397 398 399
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) => {
S
songruirui 已提交
400
    if (err != undefined) {
S
songruirui 已提交
401
        console.log("update failed, error message : " + err);
S
songruirui 已提交
402
    }else{
S
songruirui 已提交
403
        console.log("update succeed, data : " + data);
S
songruirui 已提交
404
    }
S
songruirui 已提交
405 406 407
});
```

S
songruirui 已提交
408
### update
S
songruirui 已提交
409

S
songruirui 已提交
410
update(uri: string, predicates: dataSharePredicates.DataSharePredicates, value: ValuesBucket): Promise&lt;number&gt;
S
songruirui 已提交
411

S
songruirui 已提交
412
更新数据库中的数据记录。使用Promise异步回调。
S
songruirui 已提交
413

S
songruirui 已提交
414
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
415 416 417

**参数:**

S
songruirui 已提交
418 419 420
| 名称       | 类型                                                         | 必填 | 描述                                                         |
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri        | string                                                       | 是   | 指示要更新的数据的路径。                                     |
421
| predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是   | 指示筛选条件。<br />update接口是否支持谓词筛选条件取决于服务端所选用的数据库,如KVDB目前并不支持谓词筛选条件,仅RDB支持。 |
S
songruirui 已提交
422
| value      | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)    | 是   | 指示要更新的数据。                                           |
S
songruirui 已提交
423 424 425

**返回值:**

S
songruirui 已提交
426 427 428
| 类型             | 说明                                                         |
| ---------------- | ------------------------------------------------------------ |
| Promise&lt;number&gt; | Promise对象。返回更新的数据记录数。<br />因部分数据库(如KVDB)的相应接口并不提供相应支持,故若服务端使用此数据库,则此Promise也无法返回更新的数据记录数。 |
S
songruirui 已提交
429 430 431

**示例:**

S
songruirui 已提交
432
```ts
433
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
434 435
import dataSharePredicates from '@ohos.data.dataSharePredicates'

S
songruirui 已提交
436
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
437 438 439 440 441 442 443 444 445 446
let da = new dataSharePredicates.DataSharePredicates();
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);
S
songruirui 已提交
447
}).catch((err) => {
S
songruirui 已提交
448
    console.log("update failed, error message : " + err);
S
songruirui 已提交
449 450 451
});
```

S
songruirui 已提交
452
### batchInsert
S
songruirui 已提交
453

S
songruirui 已提交
454
batchInsert(uri: string, values: Array&lt;ValuesBucket&gt;, callback: AsyncCallback&lt;number&gt;): void
S
songruirui 已提交
455

S
songruirui 已提交
456
将批量数据插入数据库。使用callback异步回调。
S
songruirui 已提交
457

S
songruirui 已提交
458
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
459 460 461

**参数:**

S
songruirui 已提交
462 463 464 465 466
| 名称     | 类型                                                         | 必填 | 描述                                                         |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri      | string                                                       | 是   | 指示要插入的数据的路径。                                     |
| values   | Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是   | 指示要插入的数据。                                           |
| callback | AsyncCallback&lt;number&gt;                                  | 是   | 回调函数。当将批量数据插入数据库成功,err为undefined,data为获取到的插入的数据记录数;否则为错误对象。<br />因部分数据库(如KVDB)的相应接口并不提供相应支持,故若服务端使用此数据库,则此Promise也无法返回插入的数据记录数。 |
S
songruirui 已提交
467 468 469

**示例:**

S
songruirui 已提交
470
```ts
471
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
472
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
473 474 475 476
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) => {
S
songruirui 已提交
477
    if (err != undefined) {
S
songruirui 已提交
478
        console.log("batchInsert failed, error message : " + err);
S
songruirui 已提交
479
    }else{
S
songruirui 已提交
480
        console.log("batchInsert succeed, data : " + data);
S
songruirui 已提交
481
    }
S
songruirui 已提交
482 483 484
});
```

S
songruirui 已提交
485
### batchInsert
S
songruirui 已提交
486

S
songruirui 已提交
487
batchInsert(uri: string, values: Array&lt;ValuesBucket&gt;): Promise&lt;number&gt;
S
songruirui 已提交
488

S
songruirui 已提交
489
将批量数据插入数据库。使用Promise异步回调。
S
songruirui 已提交
490

S
songruirui 已提交
491
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
492 493 494

**参数:**

S
songruirui 已提交
495 496 497 498
| 名称   | 类型                                                         | 必填 | 描述                     |
| ------ | ------------------------------------------------------------ | ---- | ------------------------ |
| uri    | string                                                       | 是   | 指示要插入的数据的路径。 |
| values | Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是   | 指示要插入的数据。       |
S
songruirui 已提交
499 500 501

**返回值:**

S
songruirui 已提交
502 503 504
| 类型             | 说明                                                         |
| ---------------- | ------------------------------------------------------------ |
| Promise&lt;number&gt; | Promise对象。返回插入的数据记录数。<br />因部分数据库(如KVDB)的相应接口并不提供相应支持,故若服务端使用此数据库,则此Promise也无法返回插入的数据记录数。 |
S
songruirui 已提交
505 506 507

**示例:**

S
songruirui 已提交
508
```ts
509
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
510
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
511 512 513 514 515
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).then((data) => {
    console.log("batchInsert succeed, data : " + data);
S
songruirui 已提交
516
}).catch((err) => {
S
songruirui 已提交
517
    console.log("batchInsert failed, error message : " + err);
S
songruirui 已提交
518 519 520
});
```

S
songruirui 已提交
521
### normalizeUri
S
songruirui 已提交
522

S
songruirui 已提交
523
normalizeUri(uri: string, callback: AsyncCallback&lt;string&gt;): void
S
songruirui 已提交
524

S
songruirui 已提交
525
将给定的DataShare URI转换为规范化URI,规范化URI可供跨设备使用,DataShare  URI仅供本地环境中使用。使用callback异步回调。
S
songruirui 已提交
526

S
songruirui 已提交
527
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
528 529 530

**参数:**

S
songruirui 已提交
531 532 533 534
| 名称     | 类型                   | 必填 | 描述                                                     |
| -------- | ---------------------- | ---- | -------------------------------------------------------- |
| uri      | string                 | 是   | 指示要规范化的[URI](js-apis-uri.md#uri)。      |
| callback | AsyncCallback&lt;string&gt; | 是   | 回调函数。当将给定的DataShare URI转换为规范化URI成功,err为undefined,data为获取到的规范化URI(如果支持URI规范化,则返回规范化URI,否则返回空);否则为错误对象。 |
S
songruirui 已提交
535 536 537

**示例:**

S
songruirui 已提交
538
```ts
539
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
540
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
541
dataShareHelper.normalizeUri(uri, (err, data) => {
S
songruirui 已提交
542
    if (err != undefined) {
S
songruirui 已提交
543
        console.log("normalizeUri failed, error message : " + err);
S
songruirui 已提交
544
    }else{
S
songruirui 已提交
545
        console.log("normalizeUri = " + data);
S
songruirui 已提交
546
    }
S
songruirui 已提交
547 548 549
});
```

S
songruirui 已提交
550
### normalizeUri
S
songruirui 已提交
551

S
songruirui 已提交
552
normalizeUri(uri: string): Promise&lt;string&gt;
S
songruirui 已提交
553

S
songruirui 已提交
554
将给定的DataShare URI转换为规范化URI,规范化URI可供跨设备使用,DataShare  URI仅供本地环境中使用。使用Promise异步回调。
S
songruirui 已提交
555

S
songruirui 已提交
556
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
557 558 559

**参数:**

S
songruirui 已提交
560 561 562
| 名称 | 类型   | 必填 | 描述                                      |
| ---- | ------ | ---- | ----------------------------------------- |
| uri  | string | 是   | 指示要规范化的[URI](js-apis-uri.md#uri)。 |
S
songruirui 已提交
563 564 565

**返回值:**

S
songruirui 已提交
566 567 568
| 类型             | 说明                                           |
| ---------------- | ---------------------------------------------- |
| Promise&lt;string&gt; | Promise对象。如果支持URI规范化,则返回规范化URI,否则返回空。 |
S
songruirui 已提交
569 570 571

**示例:**

S
songruirui 已提交
572
```ts
573
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
574
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
575 576
dataShareHelper.normalizeUri(uri).then((data) => {
    console.log("normalizeUri = " + data);
S
songruirui 已提交
577
}).catch((err) => {
S
songruirui 已提交
578
    console.log("normalizeUri failed, error message : " + err);
S
songruirui 已提交
579 580 581
});
```

S
songruirui 已提交
582
### denormalizeUri
S
songruirui 已提交
583

S
songruirui 已提交
584
denormalizeUri(uri: string, callback: AsyncCallback&lt;string&gt;): void
S
songruirui 已提交
585

S
songruirui 已提交
586
将指定的URI转换为非规范化URI。使用callback异步回调。
S
songruirui 已提交
587

S
songruirui 已提交
588
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
589

S
songruirui 已提交
590 591
**参数:**

S
songruirui 已提交
592 593 594 595
| 名称     | 类型                   | 必填 | 描述                                                |
| -------- | ---------------------- | ---- | --------------------------------------------------- |
| uri      | string                 | 是   | 指示要反规范化的[URI](js-apis-uri.md#uri)。 |
| callback | AsyncCallback&lt;string&gt; | 是   | 回调函数。当将指定的URI转换为非规范化URI,err为undefined,data为获取到的反规范化URI(如果反规范化成功,则返回反规范化的URI;如果无需进行反规范化,则返回原始URI;若不支持则返回空);否则为错误对象。 |
S
songruirui 已提交
596 597 598

**示例:**

S
songruirui 已提交
599
```ts
600
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
601
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
602
dataShareHelper.denormalizeUri(uri, (err, data) => {
S
songruirui 已提交
603
    if (err != undefined) {
S
songruirui 已提交
604
        console.log("denormalizeUri failed, error message : " + err);
S
songruirui 已提交
605
    }else{
S
songruirui 已提交
606
        console.log("denormalizeUri = " + data);
S
songruirui 已提交
607
    }
S
songruirui 已提交
608 609 610
});
```

S
songruirui 已提交
611
### denormalizeUri
S
songruirui 已提交
612

S
songruirui 已提交
613
denormalizeUri(uri: string): Promise&lt;string&gt;
S
songruirui 已提交
614

S
songruirui 已提交
615
将指定的URI转换为非规范化URI。使用Promise异步回调。
S
songruirui 已提交
616

S
songruirui 已提交
617
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
618

S
songruirui 已提交
619 620
**参数:**

S
songruirui 已提交
621 622 623
| 名称 | 类型   | 必填 | 描述                                        |
| ---- | ------ | ---- | ------------------------------------------- |
| uri  | string | 是   | 指示要反规范化的[URI](js-apis-uri.md#uri)。 |
S
songruirui 已提交
624 625 626

**返回值:**

S
songruirui 已提交
627 628 629
| 类型             | 说明                                      |
| ---------------- | ----------------------------------------- |
| Promise&lt;string&gt; | Promise对象。如果反规范化成功,则返回反规范化的URI;如果无需执行任何操作,则返回原始URI;若不支持则返回空。 |
S
songruirui 已提交
630 631 632

**示例:**

S
songruirui 已提交
633
```ts
634
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
635
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
636 637
dataShareHelper.denormalizeUri(uri).then((data) => {
    console.log("denormalizeUri = " + data);
S
songruirui 已提交
638
}).catch((err) => {
S
songruirui 已提交
639
    console.log("denormalizeUri failed, error message : " + err);
S
songruirui 已提交
640 641 642
});
```

S
songruirui 已提交
643
### notifyChange
S
songruirui 已提交
644

S
songruirui 已提交
645
notifyChange(uri: string, callback: AsyncCallback&lt;void&gt;): void
S
songruirui 已提交
646

S
songruirui 已提交
647
通知已注册的观察者指定URI对应的数据资源已发生变更。使用callback异步回调。
S
songruirui 已提交
648

S
songruirui 已提交
649
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
650

S
songruirui 已提交
651 652
**参数:**

S
songruirui 已提交
653 654 655 656
| 名称     | 类型                 | 必填 | 描述                     |
| -------- | -------------------- | ---- | ------------------------ |
| uri      | string               | 是   | 表示指定的数据路径。 |
| callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。当通知已注册的观察者指定URI对应的数据资源已发生变更成功,err为undefined;否则为错误对象。 |
S
songruirui 已提交
657 658 659

**示例:**

S
songruirui 已提交
660
```ts
661
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
662
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
663 664
dataShareHelper.notifyChange(uri, () => {
    console.log("***** notifyChange *****");
S
songruirui 已提交
665 666 667
});
```

S
songruirui 已提交
668
### notifyChange
S
songruirui 已提交
669

S
songruirui 已提交
670
notifyChange(uri: string): Promise&lt;void&gt;
S
songruirui 已提交
671

S
songruirui 已提交
672
通知已注册的观察者指定URI对应的数据资源已发生变更。使用Promise异步回调。
S
songruirui 已提交
673

S
songruirui 已提交
674
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
675

S
songruirui 已提交
676 677
**参数:**

S
songruirui 已提交
678 679 680
| 名称 | 类型   | 必填 | 描述                 |
| ---- | ------ | ---- | -------------------- |
| uri  | string | 是   | 表示指定的数据路径。 |
S
songruirui 已提交
681 682 683

**返回值:**

S
songruirui 已提交
684 685 686
| 类型           | 说明                  |
| -------------- | --------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
S
songruirui 已提交
687 688 689

**示例:**

S
songruirui 已提交
690
```ts
691
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
692
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
693
dataShareHelper.notifyChange(uri);
S
songruirui 已提交
694
```