js-apis-dataAbilityHelper.md 29.5 KB
Newer Older
Z
zengyawen 已提交
1 2 3
# DataAbilityHelper模块(JS端SDK接口)

## 导入模块
X
xuchenghua09 已提交
4 5 6 7 8 9 10

```
import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataability'
import ohos_data_rdb from '@ohos.data.rdb'
```

Z
zengyawen 已提交
11
## DataAbilityHelper
X
xuchenghua09 已提交
12

Z
zengyawen 已提交
13
### openFile
X
xuchenghua09 已提交
14

Z
zengyawen 已提交
15
openFile(uri: string, mode: string, callback: AsyncCallback\<number>): void
X
xuchenghua09 已提交
16

Z
zengyawen 已提交
17
在指定的远程路径中打开文件(callback形式)。
X
xuchenghua09 已提交
18

ahjxliubao2's avatar
ahjxliubao2 已提交
19 20 21 22
**系统能力:**

SystemCapability.Ability.AbilityRuntime.FAModel

Z
zengyawen 已提交
23
**参数:**
X
xuchenghua09 已提交
24

Z
zengyawen 已提交
25 26 27 28 29
| 名称     | 类型                   | 必填 | 描述                               |
| -------- | ---------------------- | ---- | ---------------------------------- |
| uri      | string                 | 是   | 指示要打开的文件的路径。           |
| mode     | string                 | 是   | 指示文件打开模式‘rwt’。            |
| callback | AsyncCallback\<number> | 是   | 被指定的回调方法,返回文件描述符。 |
X
xuchenghua09 已提交
30

Z
zengyawen 已提交
31
**示例:**
X
xuchenghua09 已提交
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46

```javascript
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
var mode = "rwt";
DAHelper.openFile(
    "dataability:///com.example.DataAbility",
    mode,
    (err) => {
		console.info("==========================>Called=======================>");
});
```

Z
zengyawen 已提交
47
### openFile
X
xuchenghua09 已提交
48

Z
zengyawen 已提交
49
openFile(uri: string, mode: string): Promise\<number>
X
xuchenghua09 已提交
50

ahjxliubao2's avatar
ahjxliubao2 已提交
51 52 53 54
**系统能力:**

SystemCapability.Ability.AbilityRuntime.FAModel

Z
zengyawen 已提交
55
**参数:**
X
xuchenghua09 已提交
56

Z
zengyawen 已提交
57 58 59 60
| 名称 | 类型   | 必填 | 描述                     |
| ---- | ------ | ---- | ------------------------ |
| uri  | string | 是   | 指示要打开的文件的路径。 |
| mode | string | 是   | 指示文件打开模式‘rwt’。  |
X
xuchenghua09 已提交
61

Z
zengyawen 已提交
62 63 64 65
**返回值:**
| 类型             | 说明             |
| ---------------- | ---------------- |
| Promise\<number> | 返回文件描述符。 |
X
xuchenghua09 已提交
66

Z
zengyawen 已提交
67
**示例:**
X
xuchenghua09 已提交
68 69 70 71 72 73 74 75

```javascript
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
var mode = "rwt";
DAHelper.openFile(
ahjxliubao2's avatar
ahjxliubao2 已提交
76 77
    "dataability:///com.example.DataAbility",
    mode).then((data) => {
X
xuchenghua09 已提交
78 79 80 81
		console.info("==========================>openFileCallback=======================>");
});
```

Z
zengyawen 已提交
82
### on('dataChange')
X
xuchenghua09 已提交
83

Z
zengyawen 已提交
84
on(type: 'dataChange', uri: string, callback: AsyncCallback\<void>): void
X
xuchenghua09 已提交
85

Z
zengyawen 已提交
86
注册观察者以观察给定uri指定的数据callback通知。
X
xuchenghua09 已提交
87

ahjxliubao2's avatar
ahjxliubao2 已提交
88 89 90 91
**系统能力:**

SystemCapability.Ability.AbilityRuntime.FAModel

Z
zengyawen 已提交
92
**参数:**
X
xuchenghua09 已提交
93

Z
zengyawen 已提交
94 95 96 97 98
| 名称     | 类型                 | 必填 | 描述                     |
| -------- | -------------------- | ---- | ------------------------ |
| type     | string               | 是   | 数据更改。               |
| uri      | string               | 是   | 指示要操作的数据的路径。 |
| callback | AsyncCallback\<void> | 是   | 指示数据更改时的回调。   |
X
xuchenghua09 已提交
99

Z
zengyawen 已提交
100
**示例:**
X
xuchenghua09 已提交
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116

```js
import featureAbility from '@ohos.ability.featureAbility'
var helper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
function onChangeNotify() {
    console.info("==========================>onChangeNotify=======================>");
};
helper.on(
    "dataChange",
    "dataability:///com.example.DataAbility",
    onChangeNotify
)
```

Z
zengyawen 已提交
117
### off('dataChange')
X
xuchenghua09 已提交
118

Z
zengyawen 已提交
119
off(type: 'dataChange', uri: string, callback?: AsyncCallback\<void>): void
X
xuchenghua09 已提交
120

Z
zengyawen 已提交
121
注消观察者以停止观察给定uri指定的数据callback通知。
X
xuchenghua09 已提交
122

ahjxliubao2's avatar
ahjxliubao2 已提交
123 124 125 126
**系统能力:**

SystemCapability.Ability.AbilityRuntime.FAModel

Z
zengyawen 已提交
127
**参数:**
X
xuchenghua09 已提交
128

Z
zengyawen 已提交
129 130 131 132 133
| 名称     | 类型                 | 必填 | 描述                     |
| -------- | -------------------- | ---- | ------------------------ |
| type     | string               | 是   | 数据更改。               |
| uri      | string               | 是   | 指示要操作的数据的路径。 |
| callback | AsyncCallback\<void> | 否   | 指示已注册的回调。       |
X
xuchenghua09 已提交
134

Z
zengyawen 已提交
135
**示例:**
X
xuchenghua09 已提交
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155

```js
import featureAbility from '@ohos.ability.featureAbility'
var helper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
function onChangeNotify() {
    console.info("==========================>onChangeNotify=======================>");
};
helper.off(
    "dataChange",
    "dataability:///com.example.DataAbility",
)
helper.off(
    "dataChange",
    "dataability:///com.example.DataAbility",
    onChangeNotify
)
```

Z
zengyawen 已提交
156
### getType
X
xuchenghua09 已提交
157

Z
zengyawen 已提交
158
getType(uri: string, callback: AsyncCallback\<string>): void
X
xuchenghua09 已提交
159

Z
zengyawen 已提交
160
获取给定URI指定数据的MIME类型(callback形式)。
X
xuchenghua09 已提交
161

ahjxliubao2's avatar
ahjxliubao2 已提交
162 163 164 165
**系统能力:**

SystemCapability.Ability.AbilityRuntime.FAModel

Z
zengyawen 已提交
166
**参数:**
X
xuchenghua09 已提交
167

Z
zengyawen 已提交
168 169 170 171
| 名称     | 类型                   | 必填 | 描述                                          |
| -------- | ---------------------- | ---- | --------------------------------------------- |
| uri      | string                 | 是   | 指示要操作的数据的路径。                      |
| callback | AsyncCallback\<string> | 是   | 回调方法,返回与uri指定的数据匹配的MIME类型。 |
X
xuchenghua09 已提交
172

Z
zengyawen 已提交
173
**示例:**
X
xuchenghua09 已提交
174 175 176 177 178 179 180 181 182 183 184 185 186

```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.getType(
    "dataability:///com.example.DataAbility",
    (err, data) => {
		console.info("==========================>Called=======================>");
});
```

Z
zengyawen 已提交
187
### getType
X
xuchenghua09 已提交
188

Z
zengyawen 已提交
189
getType(uri: string): Promise\<string>
X
xuchenghua09 已提交
190

Z
zengyawen 已提交
191
获取给定URI指定数据的MIME类型(Promise形式)。
X
xuchenghua09 已提交
192

ahjxliubao2's avatar
ahjxliubao2 已提交
193 194 195 196
**系统能力:**

SystemCapability.Ability.AbilityRuntime.FAModel

Z
zengyawen 已提交
197
**参数:**
X
xuchenghua09 已提交
198

Z
zengyawen 已提交
199 200 201
| 名称 | 类型   | 必填 | 描述                     |
| ---- | ------ | ---- | ------------------------ |
| uri  | string | 是   | 指示要操作的数据的路径。 |
X
xuchenghua09 已提交
202

Z
zengyawen 已提交
203 204 205 206
**返回值:**
| 类型             | 说明                                |
| ---------------- | ----------------------------------- |
| Promise\<string> | 返回与uri指定的数据匹配的MIME类型。 |
X
xuchenghua09 已提交
207

Z
zengyawen 已提交
208
**示例:**
X
xuchenghua09 已提交
209 210 211 212 213 214 215 216 217 218 219 220 221

```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.getType(
    "dataability:///com.example.DataAbility"
	).then((data) => {
		console.info("==========================>getTypeCallback=======================>");
});
```

Z
zengyawen 已提交
222
### getFileTypes
X
xuchenghua09 已提交
223

Z
zengyawen 已提交
224
getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array\<string>>): void
X
xuchenghua09 已提交
225

Z
zengyawen 已提交
226
获取支持的文件的MIME类型(callback形式)。
X
xuchenghua09 已提交
227

ahjxliubao2's avatar
ahjxliubao2 已提交
228 229 230 231
**系统能力:**

SystemCapability.Ability.AbilityRuntime.FAModel

Z
zengyawen 已提交
232
**参数:**
X
xuchenghua09 已提交
233

Z
zengyawen 已提交
234 235 236 237 238
| 名称           | 类型                           | 必填 | 描述                               |
| -------------- | ------------------------------ | ---- | ---------------------------------- |
| uri            | string                         | 是   | 指示要获取的文件的路径。           |
| mimeTypeFilter | string                         | 是   | 指示要获取的文件的MIME类型。       |
| callback       | AsyncCallback\<Array\<string>> | 是   | 回调方法,返回匹配的MIME类型数组。 |
X
xuchenghua09 已提交
239

Z
zengyawen 已提交
240
**示例:**
X
xuchenghua09 已提交
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256

```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.getFileTypes(
    "dataability:///com.example.DataAbility",
    "image/*",
    (err, data) => {
		console.info("==========================>Called=======================>");
});
```



Z
zengyawen 已提交
257 258 259
### getFileTypes

getFileTypes(uri: string, mimeTypeFilter: string): Promise\<Array\<string>>
X
xuchenghua09 已提交
260

Z
zengyawen 已提交
261
获取支持的文件的MIME类型(Promise形式)。
X
xuchenghua09 已提交
262

ahjxliubao2's avatar
ahjxliubao2 已提交
263 264 265 266
**系统能力:**

SystemCapability.Ability.AbilityRuntime.FAModel

Z
zengyawen 已提交
267
**参数:**
X
xuchenghua09 已提交
268

Z
zengyawen 已提交
269 270 271 272
| 名称           | 类型   | 必填 | 描述                         |
| -------------- | ------ | ---- | ---------------------------- |
| uri            | string | 是   | 指示要获取的文件的路径。     |
| mimeTypeFilter | string | 是   | 指示要获取的文件的MIME类型。 |
X
xuchenghua09 已提交
273

Z
zengyawen 已提交
274 275 276 277
**返回值:**
| 类型                     | 说明                     |
| ------------------------ | ------------------------ |
| Promise\<Array\<string>> | 返回匹配的MIME类型数组。 |
X
xuchenghua09 已提交
278

Z
zengyawen 已提交
279
**示例:**
X
xuchenghua09 已提交
280 281 282 283 284 285 286 287 288 289 290 291 292 293

```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.getFileTypes(
    "dataability:///com.example.DataAbility",
    "image/*"
	).then((data) => {
		console.info("==========================>getFileTypesCallback=======================>");
});
```

Z
zengyawen 已提交
294
### normalizeUri
X
xuchenghua09 已提交
295

Z
zengyawen 已提交
296
normalizeUri(uri: string, callback: AsyncCallback\<string>): void
X
xuchenghua09 已提交
297

Z
zengyawen 已提交
298
将引用数据功能的给定uri转换为规范化uri(callback形式)。
X
xuchenghua09 已提交
299

ahjxliubao2's avatar
ahjxliubao2 已提交
300 301 302 303
**系统能力:**

SystemCapability.Ability.AbilityRuntime.FAModel

Z
zengyawen 已提交
304
**参数:**
X
xuchenghua09 已提交
305

Z
zengyawen 已提交
306 307 308 309
| 名称     | 类型                   | 必填 | 描述                                                         |
| -------- | ---------------------- | ---- | ------------------------------------------------------------ |
| uri      | string                 | 是   | 指示要规范化的uri对象。                                      |
| callback | AsyncCallback\<string> | 是   | 回调方法。如果数据功能支持uri规范化或null,则返回规范化uri对象。 |
X
xuchenghua09 已提交
310

Z
zengyawen 已提交
311
**示例:**
X
xuchenghua09 已提交
312 313 314 315 316 317 318 319 320 321 322 323 324

```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.normalizeUri(
    "dataability:///com.example.DataAbility",
    (err, data) => {
		console.info("==========================>Called=======================>");
});
```

Z
zengyawen 已提交
325
### normalizeUri
X
xuchenghua09 已提交
326

Z
zengyawen 已提交
327
normalizeUri(uri: string): Promise\<string>
X
xuchenghua09 已提交
328

Z
zengyawen 已提交
329
将引用数据功能的给定uri转换为规范化uri(Promise形式)。
X
xuchenghua09 已提交
330

ahjxliubao2's avatar
ahjxliubao2 已提交
331 332 333 334
**系统能力:**

SystemCapability.Ability.AbilityRuntime.FAModel

Z
zengyawen 已提交
335
**参数:**
X
xuchenghua09 已提交
336

Z
zengyawen 已提交
337 338 339
| 名称 | 类型   | 必填 | 描述                    |
| ---- | ------ | ---- | ----------------------- |
| uri  | string | 是   | 指示要规范化的uri对象。 |
X
xuchenghua09 已提交
340

Z
zengyawen 已提交
341 342 343 344
**返回值:**
| 类型             | 说明                                                   |
| ---------------- | ------------------------------------------------------ |
| Promise\<string> | 如果数据功能支持uri规范化或null,则返回规范化uri对象。 |
X
xuchenghua09 已提交
345

Z
zengyawen 已提交
346
**示例:**
X
xuchenghua09 已提交
347 348 349 350 351 352 353 354 355 356 357 358 359

```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.normalizeUri(
    "dataability:///com.example.DataAbility",
	).then((data) => {
		console.info("==========================>normalizeUriCallback=======================>");
});
```

Z
zengyawen 已提交
360
### denormalizeUri
X
xuchenghua09 已提交
361

Z
zengyawen 已提交
362
denormalizeUri(uri: string, callback: AsyncCallback\<string>): void
X
xuchenghua09 已提交
363

Z
zengyawen 已提交
364
将由normalizeUri(uri)生成的给定规范化uri转换为非规范化uri(callback形式)。
X
xuchenghua09 已提交
365

ahjxliubao2's avatar
ahjxliubao2 已提交
366 367 368 369
**系统能力:**

SystemCapability.Ability.AbilityRuntime.FAModel

Z
zengyawen 已提交
370
**参数:**
X
xuchenghua09 已提交
371

Z
zengyawen 已提交
372 373 374 375
| 名称     | 类型                   | 必填 | 描述                                                |
| -------- | ---------------------- | ---- | --------------------------------------------------- |
| uri      | string                 | 是   | 指示要规范化的uri对象。                             |
| callback | AsyncCallback\<string> | 是   | 回调方法。如果反规范化成功,则返回反规范化uri对象。 |
X
xuchenghua09 已提交
376

Z
zengyawen 已提交
377
**示例:**
X
xuchenghua09 已提交
378 379 380 381 382 383 384

```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.denormalizeUri(
ahjxliubao2's avatar
ahjxliubao2 已提交
385
    "dataability:///com.example.DataAbility",
X
xuchenghua09 已提交
386 387 388 389 390 391 392
    (err, data) => {
		console.info("==========================>Called=======================>");
});
```



Z
zengyawen 已提交
393
### denormalizeUri
X
xuchenghua09 已提交
394

Z
zengyawen 已提交
395
denormalizeUri(uri: string): Promise\<string>
X
xuchenghua09 已提交
396

Z
zengyawen 已提交
397
将由normalizeUri(uri)生成的给定规范化uri转换为非规范化uri(Promise形式)。
X
xuchenghua09 已提交
398

ahjxliubao2's avatar
ahjxliubao2 已提交
399 400 401 402
**系统能力:**

SystemCapability.Ability.AbilityRuntime.FAModel

Z
zengyawen 已提交
403
**参数:**
X
xuchenghua09 已提交
404

Z
zengyawen 已提交
405 406 407
| 名称 | 类型   | 必填 | 描述                    |
| ---- | ------ | ---- | ----------------------- |
| uri  | string | 是   | 指示要规范化的uri对象。 |
X
xuchenghua09 已提交
408

Z
zengyawen 已提交
409 410 411 412 413 414
**返回值:**
| 类型             | 说明                                      |
| ---------------- | ----------------------------------------- |
| Promise\<string> | 如果反规范化成功,则返回反规范化uri对象。 |

**示例:**
X
xuchenghua09 已提交
415 416 417 418 419 420 421 422 423 424 425 426 427

```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.denormalizeUri(
    "dataability:///com.example.DataAbility",
	).then((data) => {
		console.info("==========================>denormalizeUriCallback=======================>");
});
```

Z
zengyawen 已提交
428
### notifyChange
X
xuchenghua09 已提交
429

Z
zengyawen 已提交
430
notifyChange(uri: string, callback: AsyncCallback\<void>): void
X
xuchenghua09 已提交
431

Z
zengyawen 已提交
432
通知已注册的观察者uri指定的数据资源的更改(callback形式)。
X
xuchenghua09 已提交
433

ahjxliubao2's avatar
ahjxliubao2 已提交
434 435 436 437
**系统能力:**

SystemCapability.Ability.AbilityRuntime.FAModel

Z
zengyawen 已提交
438
**参数:**
X
xuchenghua09 已提交
439

Z
zengyawen 已提交
440 441 442 443
| 名称     | 类型                 | 必填 | 描述                     |
| -------- | -------------------- | ---- | ------------------------ |
| uri      | string               | 是   | 指示要操作的数据的路径。 |
| callback | AsyncCallback\<void> | 是   | 回调方法。               |
X
xuchenghua09 已提交
444

Z
zengyawen 已提交
445
**示例:**
X
xuchenghua09 已提交
446 447 448 449 450 451 452

```js
import featureAbility from '@ohos.ability.featureAbility'
var helper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
helper.notifyChange(
ahjxliubao2's avatar
ahjxliubao2 已提交
453
    "dataability:///com.example.DataAbility",
X
xuchenghua09 已提交
454 455 456 457 458
    (err) => {
		console.info("==========================>Called=======================>");
});
```

Z
zengyawen 已提交
459
### notifyChange
X
xuchenghua09 已提交
460

Z
zengyawen 已提交
461
notifyChange(uri: string): Promise\<void>
X
xuchenghua09 已提交
462

Z
zengyawen 已提交
463
通知已注册的观察者uri指定的数据资源的更改(Promise形式)。
X
xuchenghua09 已提交
464

ahjxliubao2's avatar
ahjxliubao2 已提交
465 466 467 468
**系统能力:**

SystemCapability.Ability.AbilityRuntime.FAModel

Z
zengyawen 已提交
469
**参数:**
X
xuchenghua09 已提交
470

Z
zengyawen 已提交
471 472 473
| 名称 | 类型   | 必填 | 描述                     |
| ---- | ------ | ---- | ------------------------ |
| uri  | string | 是   | 指示要操作的数据的路径。 |
X
xuchenghua09 已提交
474

Z
zengyawen 已提交
475 476 477 478
**返回值:**
| 类型           | 说明                  |
| -------------- | --------------------- |
| Promise\<void> | 返回值为Promise对象。 |
X
xuchenghua09 已提交
479

Z
zengyawen 已提交
480
**示例:**
X
xuchenghua09 已提交
481 482 483 484 485 486 487 488

```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
DAHelper.notifyChange(
    "dataability:///com.example.DataAbility",
ahjxliubao2's avatar
ahjxliubao2 已提交
489
	).then(() => {
X
xuchenghua09 已提交
490 491 492 493
		console.info("==========================>notifyChangeCallback=======================>");
});
```

Z
zengyawen 已提交
494
### insert
X
xuchenghua09 已提交
495

Z
zengyawen 已提交
496
insert(uri: string, valuesBucket: rdb.ValuesBucket, callback: AsyncCallback\<number>): void
X
xuchenghua09 已提交
497

Z
zengyawen 已提交
498
将单个数据记录插入数据库(callback形式)。
X
xuchenghua09 已提交
499

ahjxliubao2's avatar
ahjxliubao2 已提交
500 501 502 503
**系统能力:**

SystemCapability.Ability.AbilityRuntime.FAModel

Z
zengyawen 已提交
504
**参数:**
X
xuchenghua09 已提交
505

Z
zengyawen 已提交
506 507 508 509 510
| 名称         | 类型                   | 必填 | 描述                                                   |
| ------------ | ---------------------- | ---- | ------------------------------------------------------ |
| uri          | string                 | 是   | 指示要插入的数据的路径。                               |
| valuesBucket | rdb.ValuesBucket       | 是   | 指示要插入的数据记录。如果此参数为空,将插入一个空行。 |
| callback     | AsyncCallback\<number> | 是   | 回调方法,返回插入数据记录的索引。                     |
X
xuchenghua09 已提交
511

Z
zengyawen 已提交
512
**示例:**
X
xuchenghua09 已提交
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532

```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
const valueBucket = {
    "name": "rose",
    "age": 22,
    "salary": 200.5,
    "blobType": u8,
}
DAHelper.insert(
    "dataability:///com.example.DataAbility",
    valueBucket,
    (err, data) => {
		console.info("==========================>Called=======================>");
});
```

Z
zengyawen 已提交
533
### insert
X
xuchenghua09 已提交
534

Z
zengyawen 已提交
535
insert(uri: string, valuesBucket: rdb.ValuesBucket): Promise\<number>
X
xuchenghua09 已提交
536

Z
zengyawen 已提交
537
将单个数据记录插入数据库(Promise形式)。
X
xuchenghua09 已提交
538

ahjxliubao2's avatar
ahjxliubao2 已提交
539 540 541 542
**系统能力:**

SystemCapability.Ability.AbilityRuntime.FAModel

Z
zengyawen 已提交
543
**参数:**
X
xuchenghua09 已提交
544

Z
zengyawen 已提交
545 546 547 548
| 名称         | 类型             | 必填 | 描述                                                   |
| ------------ | ---------------- | ---- | ------------------------------------------------------ |
| uri          | string           | 是   | 指示要插入的数据的路径。                               |
| valuesBucket | rdb.ValuesBucket | 是   | 指示要插入的数据记录。如果此参数为空,将插入一个空行。 |
X
xuchenghua09 已提交
549

Z
zengyawen 已提交
550 551 552 553
**返回值:**
| 类型             | 说明                     |
| ---------------- | ------------------------ |
| Promise\<number> | 返回插入数据记录的索引。 |
X
xuchenghua09 已提交
554

Z
zengyawen 已提交
555
**示例:**
X
xuchenghua09 已提交
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575

```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
const valueBucket = {
    "name": "rose1",
    "age": 221,
    "salary": 20.5,
    "blobType": u8,
}
DAHelper.insert(
    "dataability:///com.example.DataAbility",
    valueBucket
	).then((data) => {
		console.info("==========================>insertCallback=======================>");
});
```

Z
zengyawen 已提交
576
### batchInsert
X
xuchenghua09 已提交
577

Z
zengyawen 已提交
578
batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>, callback: AsyncCallback\<number>): void
X
xuchenghua09 已提交
579

Z
zengyawen 已提交
580
插入数据库(callback形式)。
X
xuchenghua09 已提交
581

ahjxliubao2's avatar
ahjxliubao2 已提交
582 583 584 585
**系统能力:**

SystemCapability.Ability.AbilityRuntime.FAModel

Z
zengyawen 已提交
586
**参数:**
X
xuchenghua09 已提交
587

Z
zengyawen 已提交
588 589 590 591 592
| 名称         | 类型                    | 必填 | 描述                             |
| ------------ | ----------------------- | ---- | -------------------------------- |
| uri          | string                  | 是   | 指示要插入的数据的路径。         |
| valuesBucket | Array<rdb.ValuesBucket> | 是   | 指示要插入的数据记录。           |
| callback     | AsyncCallback\<number>  | 是   | 回调方法。返回插入的数据记录数。 |
X
xuchenghua09 已提交
593

Z
zengyawen 已提交
594
**示例:**
X
xuchenghua09 已提交
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611

```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
var cars = new Array({"name": "roe11", "age": 21, "salary": 20.5, "blobType": u8,},
                     {"name": "roe12", "age": 21, "salary": 20.5, "blobType": u8,},
                     {"name": "roe13", "age": 21, "salary": 20.5, "blobType": u8,})
DAHelper.batchInsert(
    "dataability:///com.example.DataAbility",
    cars,
    (err, data) => {
		console.info("==========================>Called=======================>");
});
```

Z
zengyawen 已提交
612
### batchInsert
X
xuchenghua09 已提交
613

Z
zengyawen 已提交
614
batchInsert(uri: string, valuesBuckets: Array<rdb.ValuesBucket>): Promise\<number>
X
xuchenghua09 已提交
615

Z
zengyawen 已提交
616
将多个数据记录插入数据库(Promise形式)。
X
xuchenghua09 已提交
617

ahjxliubao2's avatar
ahjxliubao2 已提交
618 619 620 621
**系统能力:**

SystemCapability.Ability.AbilityRuntime.FAModel

Z
zengyawen 已提交
622
**参数:**
X
xuchenghua09 已提交
623

Z
zengyawen 已提交
624 625 626 627
| 名称         | 类型                    | 必填 | 描述                     |
| ------------ | ----------------------- | ---- | ------------------------ |
| uri          | string                  | 是   | 指示要插入的数据的路径。 |
| valuesBucket | Array<rdb.ValuesBucket> | 是   | 指示要插入的数据记录。   |
X
xuchenghua09 已提交
628

Z
zengyawen 已提交
629 630 631 632
**返回值:**
| 类型             | 说明                   |
| ---------------- | ---------------------- |
| Promise\<number> | 返回插入的数据记录数。 |
X
xuchenghua09 已提交
633

Z
zengyawen 已提交
634
**示例:**
X
xuchenghua09 已提交
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651

```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
var cars = new Array({"name": "roe11", "age": 21, "salary": 20.5, "blobType": u8,},
                     {"name": "roe12", "age": 21, "salary": 20.5, "blobType": u8,},
                     {"name": "roe13", "age": 21, "salary": 20.5, "blobType": u8,})
DAHelper.batchInsert(
    "dataability:///com.example.DataAbility",
    cars
	).then((data) => {
		console.info("==========================>batchInsertCallback=======================>");
});
```

Z
zengyawen 已提交
652
### delete
X
xuchenghua09 已提交
653

Z
zengyawen 已提交
654
delete(uri: string, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<number>): void
X
xuchenghua09 已提交
655

Z
zengyawen 已提交
656
从数据库中删除一个或多个数据记录(callback形式)。
X
xuchenghua09 已提交
657

ahjxliubao2's avatar
ahjxliubao2 已提交
658 659 660 661
**系统能力:**

SystemCapability.Ability.AbilityRuntime.FAModel

Z
zengyawen 已提交
662
**参数:**
X
xuchenghua09 已提交
663

Z
zengyawen 已提交
664 665 666 667 668
| 名称         | 类型                              | 必填 | 描述                                             |
| ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri          | string                            | 是   | 指示要删除的数据的路径。                         |
| valuesBucket | dataAbility.DataAbilityPredicates | 是   | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |
| callback     | AsyncCallback\<number>            | 是   | 回调方法。返回已删除的数据记录数。               |
X
xuchenghua09 已提交
669

Z
zengyawen 已提交
670
**示例:**
X
xuchenghua09 已提交
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686

```js
import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataability'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.delete(
    "dataability:///com.example.DataAbility",
    da,
    (err, data) => {
		console.info("==========================>Called=======================>");
});
```

Z
zengyawen 已提交
687
### delete
X
xuchenghua09 已提交
688

Z
zengyawen 已提交
689
delete(uri: string, predicates: dataAbility.DataAbilityPredicates): Promise\<number>
X
xuchenghua09 已提交
690

Z
zengyawen 已提交
691
从数据库中删除一个或多个数据记录(Promise形式)。
X
xuchenghua09 已提交
692

ahjxliubao2's avatar
ahjxliubao2 已提交
693 694 695 696
**系统能力:**

SystemCapability.Ability.AbilityRuntime.FAModel

Z
zengyawen 已提交
697
**参数:**
X
xuchenghua09 已提交
698

Z
zengyawen 已提交
699 700 701 702
| 名称         | 类型                              | 必填 | 描述                                             |
| ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri          | string                            | 是   | 指示要删除的数据的路径。                         |
| valuesBucket | dataAbility.DataAbilityPredicates | 是   | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |
X
xuchenghua09 已提交
703

Z
zengyawen 已提交
704 705 706 707
**返回值:**
| 类型             | 说明                     |
| ---------------- | ------------------------ |
| Promise\<number> | 返回已删除的数据记录数。 |
X
xuchenghua09 已提交
708

Z
zengyawen 已提交
709
**示例:**
X
xuchenghua09 已提交
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724

```js
import featureAbility from '@ohos.ability.featureAbility'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.delete(
    "dataability:///com.example.DataAbility",
    da
	).then((data) => {
		console.info("==========================>deleteCallback=======================>");
});
```

Z
zengyawen 已提交
725
### update
X
xuchenghua09 已提交
726

Z
zengyawen 已提交
727
update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<number>): void
X
xuchenghua09 已提交
728

Z
zengyawen 已提交
729
更新数据库中的数据记录(callback形式)。
X
xuchenghua09 已提交
730

ahjxliubao2's avatar
ahjxliubao2 已提交
731 732 733 734
**系统能力:**

SystemCapability.Ability.AbilityRuntime.FAModel

Z
zengyawen 已提交
735
**参数:**
X
xuchenghua09 已提交
736

Z
zengyawen 已提交
737 738 739 740 741 742
| 名称         | 类型                              | 必填 | 描述                                             |
| ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri          | string                            | 是   | 指示要更新的数据的路径。                         |
| valuesBucket | rdb.ValuesBucket                  | 是   | 指示要更新的数据。                               |
| predicates   | dataAbility.DataAbilityPredicates | 是   | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |
| callback     | AsyncCallback\<number>            | 是   | 回调方法,返回更新的数据记录数。                 |
X
xuchenghua09 已提交
743

Z
zengyawen 已提交
744
**示例:**
X
xuchenghua09 已提交
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767

```js
import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataability'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
const va = {
    "name": "roe1",
    "age": 21,
    "salary": 20.5,
    "blobType": u8,
}
let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.update(
    "dataability:///com.example.DataAbility",
    va,
    da,
    (err, data) => {
		console.info("==========================>Called=======================>");
});
```

Z
zengyawen 已提交
768
### update
X
xuchenghua09 已提交
769

Z
zengyawen 已提交
770
update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates): Promise\<number>
X
xuchenghua09 已提交
771

Z
zengyawen 已提交
772
更新数据库中的数据记录(Promise形式)。
X
xuchenghua09 已提交
773

ahjxliubao2's avatar
ahjxliubao2 已提交
774 775 776 777
**系统能力:**

SystemCapability.Ability.AbilityRuntime.FAModel

Z
zengyawen 已提交
778
**参数:**
X
xuchenghua09 已提交
779

Z
zengyawen 已提交
780 781 782 783 784
| 名称         | 类型                              | 必填 | 描述                                             |
| ------------ | --------------------------------- | ---- | ------------------------------------------------ |
| uri          | string                            | 是   | 指示要更新的数据的路径。                         |
| valuesBucket | rdb.ValuesBucket                  | 是   | 指示要更新的数据。                               |
| predicates   | dataAbility.DataAbilityPredicates | 是   | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |
X
xuchenghua09 已提交
785

Z
zengyawen 已提交
786 787 788 789
**返回值:**
| 类型             | 说明                                         |
| ---------------- | -------------------------------------------- |
| Promise\<number> | 返回值为Promise对象,Promise中包含应用信息。 |
X
xuchenghua09 已提交
790

Z
zengyawen 已提交
791
**示例:**
X
xuchenghua09 已提交
792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814

```js
import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataability'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
const va = {
    "name": "roe1",
    "age": 21,
    "salary": 20.5,
    "blobType": u8,
}
let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.update(
    "dataability:///com.example.DataAbility",
    va,
    da
	).then((data) => {
		console.info("==========================>updateCallback=======================>");
});
```

Z
zengyawen 已提交
815
### query
X
xuchenghua09 已提交
816

Z
zengyawen 已提交
817
query(uri: string, columns: Array\<string>, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback\<ResultSet>): void
X
xuchenghua09 已提交
818

Z
zengyawen 已提交
819
查询数据库中的数据(callback形式)。
X
xuchenghua09 已提交
820

ahjxliubao2's avatar
ahjxliubao2 已提交
821 822 823 824
**系统能力:**

SystemCapability.Ability.AbilityRuntime.FAModel

Z
zengyawen 已提交
825
**参数:**
X
xuchenghua09 已提交
826

Z
zengyawen 已提交
827 828 829 830 831 832
| 名称       | 类型                              | 必填 | 描述                                             |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri        | string                            | 是   | 指示要查询的数据的路径。                         |
| columns    | rdb.ValuesBucket                  | 是   | 指示要查询的列。如果此参数为空,则查询所有列。   |
| predicates | dataAbility.DataAbilityPredicates | 是   | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |
| callback   | AsyncCallback\<ResultSet>         | 是   | 回调方法,返回查询结果。                         |
X
xuchenghua09 已提交
833

Z
zengyawen 已提交
834
**示例:**
X
xuchenghua09 已提交
835 836 837 838 839 840 841

```js
import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataability'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
ahjxliubao2's avatar
ahjxliubao2 已提交
842
var cars=new Array("value1", "value2", "value3", "value4");
X
xuchenghua09 已提交
843 844 845 846 847 848 849 850 851 852 853 854
let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.query(
    "dataability:///com.example.DataAbility",
    cars,
    da,
    (err, data) => {
		console.info("==========================>Called=======================>");
});
```



Z
zengyawen 已提交
855
### query
X
xuchenghua09 已提交
856

Z
zengyawen 已提交
857
query(uri: string, columns: Array\<string>, predicates: dataAbility.DataAbilityPredicates): Promise\<ResultSet>
X
xuchenghua09 已提交
858

Z
zengyawen 已提交
859
查询数据库中的数据(Promise形式)。
X
xuchenghua09 已提交
860

ahjxliubao2's avatar
ahjxliubao2 已提交
861 862 863 864
**系统能力:**

SystemCapability.Ability.AbilityRuntime.FAModel

Z
zengyawen 已提交
865
**参数:**
X
xuchenghua09 已提交
866

Z
zengyawen 已提交
867 868 869 870 871
| 名称       | 类型                              | 必填 | 描述                                             |
| ---------- | --------------------------------- | ---- | ------------------------------------------------ |
| uri        | string                            | 是   | 指示要查询的数据的路径。                         |
| columns    | rdb.ValuesBucket                  | 是   | 指示要查询的列。如果此参数为空,则查询所有列。   |
| predicates | dataAbility.DataAbilityPredicates | 是   | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |
X
xuchenghua09 已提交
872

Z
zengyawen 已提交
873 874 875 876
**返回值:**
| 类型                | 说明           |
| ------------------- | -------------- |
| Promise\<ResultSet> | 返回查询结果。 |
X
xuchenghua09 已提交
877

Z
zengyawen 已提交
878
**示例:**
X
xuchenghua09 已提交
879 880 881 882 883 884 885

```js
import featureAbility from '@ohos.ability.featureAbility'
import ohos_data_ability from '@ohos.data.dataability'
var DAHelper = featureAbility.acquireDataAbilityHelper(
    "dataability:///com.example.DataAbility"
);
ahjxliubao2's avatar
ahjxliubao2 已提交
886
var cars=new Array("value1", "value2", "value3", "value4");
X
xuchenghua09 已提交
887 888 889 890 891 892 893 894 895
let da = new ohos_data_ability.DataAbilityPredicates()
DAHelper.query(
    "dataability:///com.example.DataAbility",
    cars,
    da
	).then((data) => {
		console.info("==========================>queryCallback=======================>");
});
```