js-apis-data-dataShare.md 34.8 KB
Newer Older
Z
zengyawen 已提交
1
# @ohos.data.dataShare (数据共享)
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

M
m00512953 已提交
27 28
使用规则:
 - 调用方应用位于后台时,使用该接口访问DataShareExtension需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
M
m00512953 已提交
29
 - 跨应用场景下,目标DataShareExtension的visible属性若配置为false,调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
M
m00512953 已提交
30 31
 - 组件启动规则详见:[组件启动规则(Stage模型)](../../application-models/component-startup-rules.md)

S
songruirui 已提交
32
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
33 34 35

**参数:**

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

N
niudongyao 已提交
42 43 44 45 46 47 48 49
**错误码:**

以下错误码的详细介绍请参见[数据共享错误码](../errorcodes/errorcode-datashare.md)

| 错误码ID | 错误信息                                             |
| -------- | ---------------------------------------------------- |
| 15700010 | The dataShareHelper is not initialized successfully. |

S
songruirui 已提交
50 51
**示例:**

S
songruirui 已提交
52
```ts
53
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
54

S
修改  
songruirui 已提交
55 56
let uri = ("datashare:///com.samples.datasharetest.DataShare");
let dataShareHelper;
N
niudongyao 已提交
57 58 59
try {
    dataShare.createDataShareHelper(this.context, uri, (err, data) => {
        if (err != undefined) {
N
niudongyao 已提交
60
            console.error(`createDataShareHelper error: code: ${err.code}, message: ${err.message} `);
N
niudongyao 已提交
61 62
            return;
        }
S
songruirui 已提交
63
        console.info("createDataShareHelper succeed, data : " + data);
S
修改  
songruirui 已提交
64
        dataShareHelper = data;
N
niudongyao 已提交
65 66
    });
} catch (err) {
N
niudongyao 已提交
67
    console.error(`createDataShareHelper error: code: ${err.code}, message: ${err.message} `);
N
niudongyao 已提交
68
};
S
songruirui 已提交
69 70
```

S
songruirui 已提交
71 72 73 74
## dataShare.createDataShareHelper

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

S
songruirui 已提交
75
创建DataShareHelper实例。使用Promise异步回调。
S
songruirui 已提交
76

M
m00512953 已提交
77 78
使用规则:
 - 调用方应用位于后台时,使用该接口访问DataShareExtension需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
M
m00512953 已提交
79
 - 跨应用场景下,目标DataShareExtension的visible属性若配置为false,调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
M
m00512953 已提交
80 81
 - 组件启动规则详见:[组件启动规则(Stage模型)](../../application-models/component-startup-rules.md)

S
songruirui 已提交
82 83 84 85
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer

**参数:**

86
| 参数名  | 类型                                          | 必填 | 说明                           |
S
songruirui 已提交
87 88 89
| ------- | ------------------------------------------------- | ---- | ------------------------------ |
| context | [Context](js-apis-application-context.md#context) | 是   | 应用的上下文环境。             |
| uri     | string                                            | 是   | 指示要连接的服务端应用的路径。 |
S
songruirui 已提交
90 91 92

**返回值:**

S
songruirui 已提交
93 94 95
| 类型                                               | 说明                                   |
| -------------------------------------------------- | -------------------------------------- |
| Promise<[DataShareHelper](#datasharehelper)> | Promise对象。返回DataShareHelper实例。 |
S
songruirui 已提交
96

N
niudongyao 已提交
97 98 99 100 101 102 103 104
**错误码:**

以下错误码的详细介绍请参见[数据共享错误码](../errorcodes/errorcode-datashare.md)

| 错误码ID | 错误信息                                             |
| -------- | ---------------------------------------------------- |
| 15700010 | The dataShareHelper is not initialized successfully. |

S
songruirui 已提交
105 106 107
**示例:**

```ts
108
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
109

S
修改  
songruirui 已提交
110 111
let uri = ("datashare:///com.samples.datasharetest.DataShare");
let dataShareHelper;
N
niudongyao 已提交
112 113 114 115 116
try {
    dataShare.createDataShareHelper(this.context, uri).then((data) => {
        console.info("createDataShareHelper succeed, data : " + data);
        dataShareHelper = data;
    }). catch((err) => {
N
niudongyao 已提交
117
        console.error(`createDataShareHelper error: code: ${err.code}, message: ${err.message} `);
N
niudongyao 已提交
118 119
    });
} catch (err) {
N
niudongyao 已提交
120
    console.error(`createDataShareHelper error: code: ${err.code}, message: ${err.message} `);
N
niudongyao 已提交
121
};
S
songruirui 已提交
122 123
```

S
songruirui 已提交
124 125
## DataShareHelper

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

S
songruirui 已提交
128 129
### on('dataChange')

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

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

S
songruirui 已提交
134
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
135 136 137

**参数:**

138
| 参数名     | 类型                 | 必填 | 说明                    |
S
songruirui 已提交
139
| -------- | -------------------- | ---- | ------------------------ |
S
songruirui 已提交
140 141
| type     | string               | 是   | 订阅的事件/回调类型,支持的事件为'dataChange',当数据更改时,触发该事件。 |
| uri      | string               | 是   | 表示指定的数据路径。 |
S
songruirui 已提交
142
| callback | AsyncCallback<void> | 是   | 回调函数。当有其他用户触发了变更通知时调用,err为undefined;否则不被触发或为错误对象。 |
S
songruirui 已提交
143 144 145

**示例:**

S
songruirui 已提交
146
```ts
147
import Ability from '@ohos.application.Ability'
S
修改  
songruirui 已提交
148
function onCallback() {
S
songruirui 已提交
149 150
    console.info("**** Observer on callback ****");
}
S
songruirui 已提交
151
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
修改  
songruirui 已提交
152
dataShareHelper.on("dataChange", uri, onCallback);
S
songruirui 已提交
153 154 155 156
```

### off('dataChange')

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

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

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

S
songruirui 已提交
163 164
**参数:**

165
| 参数名     | 类型                 | 必填 | 说明                    |
S
songruirui 已提交
166
| -------- | -------------------- | ---- | ------------------------ |
S
songruirui 已提交
167 168
| type     | string               | 是   | 取消订阅的事件/回调类型,支持的事件为'dataChange'。 |
| uri      | string               | 是   | 表示指定的数据路径。 |
S
songruirui 已提交
169
| callback | AsyncCallback<void> | 否   | 回调函数。当取消订阅指定URI对应的数据资源的变更通知成功,err为undefined;否则为错误对象。 |
S
songruirui 已提交
170 171 172

**示例:**

S
songruirui 已提交
173
```ts
174
import Ability from '@ohos.application.Ability'
S
修改  
songruirui 已提交
175
function offCallback() {
S
songruirui 已提交
176 177
    console.info("**** Observer off callback ****");
}
S
songruirui 已提交
178
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
修改  
songruirui 已提交
179
dataShareHelper.off("dataChange", uri, offCallback);
S
songruirui 已提交
180 181
```

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

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

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

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

**参数:**

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

**示例:**

```ts
201
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
202
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
203 204 205 206 207
const valueBucket = {
    "name": "rose",
    "age": 22,
    "salary": 200.5,
}
N
niudongyao 已提交
208 209 210
try {
    dataShareHelper.insert(uri, valueBucket, (err, data) => {
        if (err != undefined) {
N
niudongyao 已提交
211
            console.error(`insert error: code: ${err.code}, message: ${err.message} `);
N
niudongyao 已提交
212 213 214 215 216
            return;
        }
        console.info("insert succeed, data : " + data);
    });
} catch (err) {
N
niudongyao 已提交
217
    console.error(`insert error: code: ${err.code}, message: ${err.message} `);
N
niudongyao 已提交
218
};
S
songruirui 已提交
219 220
```

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

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

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

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

**参数:**

231
| 参数名  | 类型                                                      | 必填 | 说明                                               |
S
songruirui 已提交
232 233
| ----- | --------------------------------------------------------- | ---- | -------------------------------------------------- |
| uri   | string                                                    | 是   | 指示要插入的数据的路径。                           |
Z
zhongjianfei 已提交
234
| value | [ValuesBucket](js-apis-data-valuesBucket.md#valuesbucket) | 是   | 指示要插入的数据。如果此参数为空,将插入一个空行。 |
S
songruirui 已提交
235 236 237

**返回值:**

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

**示例:**

```ts
245
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
246
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
247 248 249 250 251
const valueBucket = {
    "name": "rose1",
    "age": 221,
    "salary": 20.5,
}
N
niudongyao 已提交
252 253 254 255
try {
    dataShareHelper.insert(uri, valueBucket).then((data) => {
        console.log("insert succeed, data : " + data);
    }). catch((err) => {
N
niudongyao 已提交
256
        console.error(`insert error: code: ${err.code}, message: ${err.message} `);
N
niudongyao 已提交
257 258
    });
} catch (err) {
N
niudongyao 已提交
259
    console.error(`insert error: code: ${err.code}, message: ${err.message} `);
N
niudongyao 已提交
260
};
S
songruirui 已提交
261 262
```

S
songruirui 已提交
263
### delete
S
songruirui 已提交
264

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

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

S
songruirui 已提交
269
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
270 271 272

**参数:**

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

**示例:**

S
songruirui 已提交
281
```ts
282
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
283 284
import dataSharePredicates from '@ohos.data.dataSharePredicates'

S
songruirui 已提交
285
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
286 287
let da = new dataSharePredicates.DataSharePredicates();
da.equalTo("name", "ZhangSan");
N
niudongyao 已提交
288 289 290
try {
    dataShareHelper.delete(uri, da, (err, data) => {
        if (err != undefined) {
N
niudongyao 已提交
291
            console.error(`delete error: code: ${err.code}, message: ${err.message} `);
N
niudongyao 已提交
292 293 294 295 296
            return;
        }
        console.info("delete succeed, data : " + data);
    });
} catch (err) {
N
niudongyao 已提交
297
    console.error(`delete error: code: ${err.code}, message: ${err.message} `);
N
niudongyao 已提交
298
};
S
songruirui 已提交
299 300
```

S
songruirui 已提交
301
### delete
S
songruirui 已提交
302

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

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

S
songruirui 已提交
307
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
308 309 310

**参数:**

311
| 参数名       | 类型                                                         | 必填 | 说明                                                         |
S
songruirui 已提交
312 313
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri        | string                                                       | 是   | 指示要删除的数据的路径。                                     |
314
| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是   | 指示筛选条件。<br />delete接口所支持的谓词方法取决于服务端所选用的数据库,如KVDB的删除目前仅支持inKeys谓词。 |
S
songruirui 已提交
315 316 317

**返回值:**

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

**示例:**

S
songruirui 已提交
324
```ts
325
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
326 327
import dataSharePredicates from '@ohos.data.dataSharePredicates'

S
songruirui 已提交
328
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
329 330
let da = new dataSharePredicates.DataSharePredicates();
da.equalTo("name", "ZhangSan");
N
niudongyao 已提交
331 332 333 334
try {
    dataShareHelper.delete(uri, da).then((data) =>  {
        console.log("delete succeed, data : " + data);
    }). catch((err) => {
N
niudongyao 已提交
335
        console.error(`delete error: code: ${err.code}, message: ${err.message} `);
N
niudongyao 已提交
336 337
    });
} catch (err) {
N
niudongyao 已提交
338
    console.error(`delete error: code: ${err.code}, message: ${err.message} `);
N
niudongyao 已提交
339
};
S
songruirui 已提交
340 341
```

S
songruirui 已提交
342
### query
S
songruirui 已提交
343

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

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

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

S
songruirui 已提交
350 351
**参数:**

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

**示例:**

S
songruirui 已提交
361
```ts
362
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
363 364
import dataSharePredicates from '@ohos.data.dataSharePredicates'

S
songruirui 已提交
365
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
366 367 368
let columns = ["*"];
let da = new dataSharePredicates.DataSharePredicates();
da.equalTo("name", "ZhangSan");
N
niudongyao 已提交
369 370 371
try {
    dataShareHelper.query(uri, da, columns, (err, data) => {
        if (err != undefined) {
N
niudongyao 已提交
372
            console.error(`query error: code: ${err.code}, message: ${err.message} `);
N
niudongyao 已提交
373 374
            return;
        }
S
songruirui 已提交
375
        console.log("query succeed, rowCount : " + data.rowCount);
N
niudongyao 已提交
376 377
    });
} catch (err) {
N
niudongyao 已提交
378
    console.error(`query error: code: ${err.code}, message: ${err.message} `);
N
niudongyao 已提交
379
};
S
songruirui 已提交
380 381
```

S
songruirui 已提交
382
### query
S
songruirui 已提交
383

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

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

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

S
songruirui 已提交
390 391
**参数:**

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

**返回值:**

S
songruirui 已提交
400 401 402
| 类型                                                         | 说明                              |
| ------------------------------------------------------------ | --------------------------------- |
| Promise&lt;[DataShareResultSet](js-apis-data-DataShareResultSet.md#datashareresultset)&gt; | Promise对象。返回查询到的结果集。 |
S
songruirui 已提交
403 404 405

**示例:**

S
songruirui 已提交
406
```ts
407
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
408 409
import dataSharePredicates from '@ohos.data.dataSharePredicates'

S
songruirui 已提交
410
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
411 412 413
let columns = ["*"];
let da = new dataSharePredicates.DataSharePredicates();
da.equalTo("name", "ZhangSan");
N
niudongyao 已提交
414 415 416 417
try {
    dataShareHelper.query(uri, da, columns).then((data) =>  {
        console.log("query succeed, rowCount : " + data.rowCount);
    }). catch((err) => {
N
niudongyao 已提交
418
        console.error(`query error: code: ${err.code}, message: ${err.message} `);
N
niudongyao 已提交
419 420
    });
} catch (err) {
N
niudongyao 已提交
421
    console.error(`query error: code: ${err.code}, message: ${err.message} `);
N
niudongyao 已提交
422
};
S
songruirui 已提交
423 424
```

S
songruirui 已提交
425
### update
S
songruirui 已提交
426

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

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

S
songruirui 已提交
431
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
432 433 434

**参数:**

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

**示例:**

S
songruirui 已提交
444
```ts
445
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
446 447
import dataSharePredicates from '@ohos.data.dataSharePredicates'

S
songruirui 已提交
448
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
449 450 451 452 453 454 455 456
let da = new dataSharePredicates.DataSharePredicates();
da.equalTo("name", "ZhangSan");
const va = {
    "name": "roe1",
    "age": 21,
    "salary": 20.5,
   
}
N
niudongyao 已提交
457 458 459
try {
    dataShareHelper.update(uri, da, va, (err, data) => {
        if (err != undefined) {
N
niudongyao 已提交
460
            console.error(`update error: code: ${err.code}, message: ${err.message} `);
N
niudongyao 已提交
461 462
            return;
        }
S
songruirui 已提交
463
        console.log("update succeed, data : " + data);
N
niudongyao 已提交
464 465
    });
} catch (err) {
N
niudongyao 已提交
466
    console.error(`update error: code: ${err.code}, message: ${err.message} `);
N
niudongyao 已提交
467
};
S
songruirui 已提交
468 469
```

S
songruirui 已提交
470
### update
S
songruirui 已提交
471

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

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

S
songruirui 已提交
476
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
477 478 479

**参数:**

480
| 参数名       | 类型                                                         | 必填 | 说明                                                         |
S
songruirui 已提交
481 482
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri        | string                                                       | 是   | 指示要更新的数据的路径。                                     |
483
| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | 是   | 指示筛选条件。<br />update接口是否支持谓词筛选条件取决于服务端所选用的数据库,如KVDB目前并不支持谓词筛选条件,仅RDB支持。 |
Z
zhongjianfei 已提交
484
| value      | [ValuesBucket](js-apis-data-valuesBucket.md#valuesbucket)    | 是   | 指示要更新的数据。                                           |
S
songruirui 已提交
485 486 487

**返回值:**

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

**示例:**

S
songruirui 已提交
494
```ts
495
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
496 497
import dataSharePredicates from '@ohos.data.dataSharePredicates'

S
songruirui 已提交
498
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
499 500 501 502 503 504 505 506
let da = new dataSharePredicates.DataSharePredicates();
da.equalTo("name", "ZhangSan");
const va = {
    "name": "roe1",
    "age": 21,
    "salary": 20.5,
   
}
N
niudongyao 已提交
507 508 509 510
try {
    dataShareHelper.update(uri, da, va).then((data) =>  {
        console.log("update succeed, data : " + data);
    }). catch((err) => {
N
niudongyao 已提交
511
        console.error(`update error: code: ${err.code}, message: ${err.message} `);
N
niudongyao 已提交
512 513
    });
} catch (err) {
N
niudongyao 已提交
514
    console.error(`update error: code: ${err.code}, message: ${err.message} `);
N
niudongyao 已提交
515
};
S
songruirui 已提交
516 517
```

S
songruirui 已提交
518
### batchInsert
S
songruirui 已提交
519

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

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

S
songruirui 已提交
524
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
525 526 527

**参数:**

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

**示例:**

S
songruirui 已提交
536
```ts
537
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
538
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
539 540 541
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,})
N
niudongyao 已提交
542 543 544
try {
    dataShareHelper.batchInsert(uri, vbs, (err, data) => {
        if (err != undefined) {
N
niudongyao 已提交
545
            console.error(`batchInsert error: code: ${err.code}, message: ${err.message} `);
N
niudongyao 已提交
546 547
            return;
        }
S
songruirui 已提交
548
        console.log("batchInsert succeed, data : " + data);
N
niudongyao 已提交
549 550
    });
} catch (err) {
N
niudongyao 已提交
551
    console.error(`batchInsert error: code: ${err.code}, message: ${err.message} `);
N
niudongyao 已提交
552
};
S
songruirui 已提交
553 554
```

S
songruirui 已提交
555
### batchInsert
S
songruirui 已提交
556

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

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

S
songruirui 已提交
561
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
562 563 564

**参数:**

565
| 参数名   | 类型                                                         | 必填 | 说明                     |
S
songruirui 已提交
566 567
| ------ | ------------------------------------------------------------ | ---- | ------------------------ |
| uri    | string                                                       | 是   | 指示要插入的数据的路径。 |
Z
zhongjianfei 已提交
568
| values | Array&lt;[ValuesBucket](js-apis-data-valuesBucket.md#valuesbucket)&gt; | 是   | 指示要插入的数据。       |
S
songruirui 已提交
569 570 571

**返回值:**

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

**示例:**

S
songruirui 已提交
578
```ts
579
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
580
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
581 582 583
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,})
N
niudongyao 已提交
584 585 586 587
try {
    dataShareHelper.batchInsert(uri, vbs).then((data) =>  {
        console.log("batchInsert succeed, data : " + data);
    }). catch((err) => {
N
niudongyao 已提交
588
        console.error(`batchInsert error: code: ${err.code}, message: ${err.message} `);
N
niudongyao 已提交
589 590
    });
} catch (err) {
N
niudongyao 已提交
591
    console.error(`batchInsert error: code: ${err.code}, message: ${err.message} `);
N
niudongyao 已提交
592
};
S
songruirui 已提交
593 594
```

S
songruirui 已提交
595
### normalizeUri
S
songruirui 已提交
596

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

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

S
songruirui 已提交
601
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
602 603 604

**参数:**

605
| 参数名     | 类型                   | 必填 | 说明                                                     |
S
songruirui 已提交
606 607 608
| -------- | ---------------------- | ---- | -------------------------------------------------------- |
| uri      | string                 | 是   | 指示要规范化的[URI](js-apis-uri.md#uri)。      |
| callback | AsyncCallback&lt;string&gt; | 是   | 回调函数。当将给定的DataShare URI转换为规范化URI成功,err为undefined,data为获取到的规范化URI(如果支持URI规范化,则返回规范化URI,否则返回空);否则为错误对象。 |
S
songruirui 已提交
609 610 611

**示例:**

S
songruirui 已提交
612
```ts
613
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
614
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
615
dataShareHelper.normalizeUri(uri, (err, data) => {
S
songruirui 已提交
616
    if (err != undefined) {
S
songruirui 已提交
617
        console.log("normalizeUri failed, error message : " + err);
S
songruirui 已提交
618
    }else{
S
songruirui 已提交
619
        console.log("normalizeUri = " + data);
S
songruirui 已提交
620
    }
S
songruirui 已提交
621 622 623
});
```

S
songruirui 已提交
624
### normalizeUri
S
songruirui 已提交
625

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

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

S
songruirui 已提交
630
**系统能力:**  SystemCapability.DistributedDataManager.DataShare.Consumer
S
songruirui 已提交
631 632 633

**参数:**

634
| 参数名 | 类型   | 必填 | 说明                                      |
S
songruirui 已提交
635 636
| ---- | ------ | ---- | ----------------------------------------- |
| uri  | string | 是   | 指示要规范化的[URI](js-apis-uri.md#uri)。 |
S
songruirui 已提交
637 638 639

**返回值:**

S
songruirui 已提交
640 641 642
| 类型             | 说明                                           |
| ---------------- | ---------------------------------------------- |
| Promise&lt;string&gt; | Promise对象。如果支持URI规范化,则返回规范化URI,否则返回空。 |
S
songruirui 已提交
643 644 645

**示例:**

S
songruirui 已提交
646
```ts
647
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
648
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
649 650
dataShareHelper.normalizeUri(uri).then((data) => {
    console.log("normalizeUri = " + data);
S
songruirui 已提交
651
}).catch((err) => {
S
songruirui 已提交
652
    console.log("normalizeUri failed, error message : " + err);
S
songruirui 已提交
653 654 655
});
```

S
songruirui 已提交
656
### denormalizeUri
S
songruirui 已提交
657

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

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

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

S
songruirui 已提交
664 665
**参数:**

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

**示例:**

S
songruirui 已提交
673
```ts
674
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
675
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
676
dataShareHelper.denormalizeUri(uri, (err, data) => {
S
songruirui 已提交
677
    if (err != undefined) {
S
songruirui 已提交
678
        console.log("denormalizeUri failed, error message : " + err);
S
songruirui 已提交
679
    }else{
S
songruirui 已提交
680
        console.log("denormalizeUri = " + data);
S
songruirui 已提交
681
    }
S
songruirui 已提交
682 683 684
});
```

S
songruirui 已提交
685
### denormalizeUri
S
songruirui 已提交
686

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

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

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

S
songruirui 已提交
693 694
**参数:**

695
| 参数名 | 类型   | 必填 | 说明                                        |
S
songruirui 已提交
696 697
| ---- | ------ | ---- | ------------------------------------------- |
| uri  | string | 是   | 指示要反规范化的[URI](js-apis-uri.md#uri)。 |
S
songruirui 已提交
698 699 700

**返回值:**

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

**示例:**

S
songruirui 已提交
707
```ts
708
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
709
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
710 711
dataShareHelper.denormalizeUri(uri).then((data) => {
    console.log("denormalizeUri = " + data);
S
songruirui 已提交
712
}).catch((err) => {
S
songruirui 已提交
713
    console.log("denormalizeUri failed, error message : " + err);
S
songruirui 已提交
714 715 716
});
```

S
songruirui 已提交
717
### notifyChange
S
songruirui 已提交
718

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

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

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

S
songruirui 已提交
725 726
**参数:**

727
| 参数名    | 类型                 | 必填 | 说明                     |
S
songruirui 已提交
728 729 730
| -------- | -------------------- | ---- | ------------------------ |
| uri      | string               | 是   | 表示指定的数据路径。 |
| callback | AsyncCallback&lt;void&gt; | 是   | 回调函数。当通知已注册的观察者指定URI对应的数据资源已发生变更成功,err为undefined;否则为错误对象。 |
S
songruirui 已提交
731 732 733

**示例:**

S
songruirui 已提交
734
```ts
735
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
736
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
737 738
dataShareHelper.notifyChange(uri, () => {
    console.log("***** notifyChange *****");
S
songruirui 已提交
739 740 741
});
```

S
songruirui 已提交
742
### notifyChange
S
songruirui 已提交
743

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

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

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

S
songruirui 已提交
750 751
**参数:**

752
| 参数名 | 类型   | 必填 | 说明                 |
S
songruirui 已提交
753 754
| ---- | ------ | ---- | -------------------- |
| uri  | string | 是   | 表示指定的数据路径。 |
S
songruirui 已提交
755 756 757

**返回值:**

S
songruirui 已提交
758 759 760
| 类型           | 说明                  |
| -------------- | --------------------- |
| Promise&lt;void&gt; | Promise对象。无返回结果的Promise对象。 |
S
songruirui 已提交
761 762 763

**示例:**

S
songruirui 已提交
764
```ts
765
import Ability from '@ohos.application.Ability'
S
songruirui 已提交
766
let uri = ("datashare:///com.samples.datasharetest.DataShare");
S
songruirui 已提交
767
dataShareHelper.notifyChange(uri);
N
niudongyao 已提交
768
```