提交 c1dbd75a 编写于 作者: S songruirui

格式修改

Signed-off-by: Nsongruirui <songruirui1@huawei.com>
上级 468bd3b4
......@@ -15,7 +15,7 @@ import DataShareExtensionAbility from '@ohos.application.DataShareExtensionAbili
## onCreate
onCreate?(want: Want, callback: AsyncCallback<void>): void;
onCreate?(want: Want, callback: AsyncCallback&lt;void&gt;): void
DataShareExtAbility生命周期回调,在创建时回调,执行初始化业务逻辑操作。
......@@ -30,7 +30,7 @@ DataShareExtAbility生命周期回调,在创建时回调,执行初始化业
| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| want | [Want](js-apis-application-Want.md#want) | 是 | Want类型信息,包括ability名称、bundle名称等。 |
| callback | AsyncCallback<void> | 是 | 表示被指定的回调方法。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 表示被指定的回调方法。 |
**示例:**
......@@ -64,7 +64,7 @@ onCreate(want, callback) {
## insert
insert?(uri: string, valueBucket: ValuesBucket, callback: AsyncCallback<number>): void;
insert?(uri: string, valueBucket: ValuesBucket, callback: AsyncCallback&lt;number&gt;): void
insert生命周期回调,在数据库插入时回调。
......@@ -80,7 +80,7 @@ insert生命周期回调,在数据库插入时回调。
| ----- | ------ | ------ | ------ |
| uri |string | 是 | 指示要插入的数据的路径。 |
| valueBucket |[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要插入的数据记录。 |
| callback |AsyncCallback<number> | 是 | 表示被指定的回调方法。 |
| callback |AsyncCallback&lt;number&gt; | 是 | 表示被指定的回调方法。 |
**示例:**
......@@ -108,7 +108,7 @@ insert(uri, value, callback) {
## update
update?(uri: string, predicates: DataSharePredicates, valueBucket: ValuesBucket, callback: AsyncCallback<number>): void;
update?(uri: string, predicates: DataSharePredicates, valueBucket: ValuesBucket, callback: AsyncCallback&lt;number&gt;): void
update生命周期回调,在数据库更新时回调。
......@@ -125,7 +125,7 @@ update生命周期回调,在数据库更新时回调。
| uri | string | 是 | 指示要更新的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。 |
| valueBucket | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要更新的数据。 |
| callback | AsyncCallback<number> | 是 | 表示被指定的回调方法。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 表示被指定的回调方法。 |
**示例:**
......@@ -151,7 +151,7 @@ update(uri, predicates, value, callback) {
## query
query?(uri: string, predicates: DataSharePredicates, columns: Array<string>, callback: AsyncCallback<Object>): void;
query?(uri: string, predicates: DataSharePredicates, columns: Array&lt;string&gt;, callback: AsyncCallback&lt;Object&gt;): void
query生命周期回调,在数据库查询时回调。
......@@ -167,8 +167,8 @@ query生命周期回调,在数据库查询时回调。
| ----- | ------ | ------ | ------ |
| uri | string | 是 | 指示要查询的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。 |
| columns | Array<string> | 是 | 指示要查询的列。如果此参数为空,则查询所有列。 |
| callback | AsyncCallback<Object> | 是 | 表示被指定的回调方法。 |
| columns | Array&lt;string&gt; | 是 | 指示要查询的列。如果此参数为空,则查询所有列。 |
| callback | AsyncCallback&lt;Object&gt; | 是 | 表示被指定的回调方法。 |
**示例:**
......@@ -197,7 +197,7 @@ query(uri, predicates, columns, callback) {
## delete
delete?(uri: string, predicates: DataSharePredicates, callback: AsyncCallback<number>): void;
delete?(uri: string, predicates: DataSharePredicates, callback: AsyncCallback&lt;number&gt;): void
delete生命周期回调,在删除数据库记录时回调。
......@@ -213,7 +213,7 @@ delete生命周期回调,在删除数据库记录时回调。
| ---------- | ------------------------------------------------------------ | ---- | ------------------------ |
| uri | string | 是 | 指示要查询的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。 |
| callback | AsyncCallback<number> | 是 | 表示被指定的回调方法。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 表示被指定的回调方法。 |
**示例:**
......@@ -239,7 +239,7 @@ delete(uri, predicates, callback) {
## batchInsert
batchInsert?(uri: string, valueBuckets: Array<ValuesBucket>, callback: AsyncCallback<number>): void;
batchInsert?(uri: string, valueBuckets: Array&lt;ValuesBucket&gt;, callback: AsyncCallback&lt;number&gt;): void
batchinsert生命周期回调,在数据库批量插入时回调。
......@@ -254,8 +254,8 @@ batchinsert生命周期回调,在数据库批量插入时回调。
| 名称 | 参数类型 | 必填 | 说明 |
| ------------ | ------------------------------------------------------------ | ---- | ------------------------ |
| uri | string | 是 | 指示要插入的数据的路径。 |
| valueBuckets | Array<[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)> | 是 | 指示要插入的数据记录。 |
| callback | AsyncCallback<number> | 是 | 表示被指定的回调方法。 |
| valueBuckets | Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是 | 指示要插入的数据记录。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 表示被指定的回调方法。 |
**示例:**
......@@ -285,7 +285,7 @@ batchInsert(uri: string, valueBuckets, callback) {
## getType
getType?(uri: string, callback: AsyncCallback<string>): void;
getType?(uri: string, callback: AsyncCallback&lt;string&gt;): void
getType生命周期回调函数,获取给定URI对应的MIME类型时回调。
......@@ -300,7 +300,7 @@ getType生命周期回调函数,获取给定URI对应的MIME类型时回调。
| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| uri | string | 是 | 指示要操作的数据的路径。 |
| callback | AsyncCallback<string> | 是 | 表示被指定的回调方法。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 表示被指定的回调方法。 |
**示例:**
......@@ -316,7 +316,7 @@ getType(uri: string, callback) {
## getFileTypes
getFileTypes?(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array<string>>): void;
getFileTypes?(uri: string, mimeTypeFilter: string, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void
getFileTypes生命周期回调,获取支持文件的MIME类型时回调。
......@@ -332,7 +332,7 @@ getFileTypes生命周期回调,获取支持文件的MIME类型时回调。
| -------------- | ---------------------------- | ---- | ---------------------------- |
| uri | string | 是 | 指示要获取的文件的路径。 |
| mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 |
| callback | AsyncCallback<Array<string>> | 是 | 表示被指定的回调方法。 |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 表示被指定的回调方法。 |
**示例:**
......@@ -348,7 +348,7 @@ getFileTypes(uri: string, mimeTypeFilter: string,callback) {
## normalizeUri
normalizeUri?(uri: string, callback: AsyncCallback<string>): void;
normalizeUri?(uri: string, callback: AsyncCallback&lt;string&gt;): void
normalizeUri生命周期回调,给定uri转换为规范化uri时回调。
......@@ -363,7 +363,7 @@ normalizeUri生命周期回调,给定uri转换为规范化uri时回调。
| 名称 | 类型 | 必填 | 描述 |
| -------- | --------------------- | ---- | ----------------------- |
| uri | string | 是 | 指示要规范化的uri对象。 |
| callback | AsyncCallback<string> | 是 | 表示被指定的回调方法。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 表示被指定的回调方法。 |
**示例:**
......@@ -379,7 +379,7 @@ normalizeUri(uri: string, callback) {
## denormalizeUri
denormalizeUri?(uri: string, callback: AsyncCallback<string>): void;
denormalizeUri?(uri: string, callback: AsyncCallback&lt;string&gt;): void
将由denormalizeUri生命周期回调,给定规范化uri转换为非规范化uri时回调。
......@@ -394,7 +394,7 @@ denormalizeUri?(uri: string, callback: AsyncCallback<string>): void;
| 名称 | 类型 | 必填 | 描述 |
| -------- | --------------------- | ---- | ----------------------- |
| uri | string | 是 | 指示要规范化的uri对象。 |
| callback | AsyncCallback<string> | 是 | 表示被指定的回调方法。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 表示被指定的回调方法。 |
**示例:**
......@@ -410,7 +410,7 @@ denormalizeUri(uri: string, callback) {
## openFile
openFile?(uri: string, mode: string, callback: AsyncCallback<number>): void;
openFile?(uri: string, mode: string, callback: AsyncCallback&lt;number&gt;): void
将由openFile生命周期回调,在打开文件时回调。
......@@ -426,7 +426,7 @@ openFile?(uri: string, mode: string, callback: AsyncCallback<number>): void;
| -------- | --------------------- | ---- | ------------------------------------------ |
| uri | string | 是 | 指示要规范化的uri对象。 |
| mode | string | 是 | 指示文件打开模式,包括只读模式,读写模式。 |
| callback | AsyncCallback<number> | 是 | 表示被指定的回调方法。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 表示被指定的回调方法。 |
**示例:**
......
......@@ -16,7 +16,7 @@ import DataSharePredicates from '@ohos.data.DataSharePredicates';
## equalTo
equalTo(field: string, value: ValueType): DataSharePredicates;
equalTo(field: string, value: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType且值等于指定值的字段。
......@@ -46,7 +46,7 @@ dataSharePredicates.equalTo("NAME", "Rose")
## notEqualTo
notEqualTo(field: string, value: ValueType): DataSharePredicates;
notEqualTo(field: string, value: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType且值不等于指定值的字段。
......@@ -76,7 +76,7 @@ dataSharePredicates.notEqualTo("NAME", "Rose")
## beginWrap
beginWrap(): DataSharePredicates;
beginWrap(): DataSharePredicates
该接口用于向谓词添加左括号。目前仅RDB支持该谓词。
......@@ -102,7 +102,7 @@ dataSharePredicates.equalTo("NAME", "lisi")
## endWrap
endWrap(): DataSharePredicates;
endWrap(): DataSharePredicates
该接口用于向谓词添加右括号。目前仅RDB支持该谓词。
......@@ -128,7 +128,7 @@ dataSharePredicates.equalTo("NAME", "lisi")
## or
or(): DataSharePredicates;
or(): DataSharePredicates
该接口用于将或条件添加到谓词中。
......@@ -153,7 +153,7 @@ dataSharePredicates.equalTo("NAME", "lisi")
## and
and(): DataSharePredicates;
and(): DataSharePredicates
该接口用于将和条件添加到谓词中。
......@@ -178,7 +178,7 @@ dataSharePredicates.equalTo("NAME", "lisi")
## contains
contains(field: string, value: string): DataSharePredicates;
contains(field: string, value: string): DataSharePredicates
该接口用于配置谓词以匹配数据类型为String且value包含指定值的字段。目前仅RDB支持该谓词。
......@@ -206,7 +206,7 @@ dataSharePredicates.contains("NAME", "os")
## beginsWith
beginsWith(field: string, value: string): DataSharePredicates;
beginsWith(field: string, value: string): DataSharePredicates
该接口用于配置谓词以匹配数据类型为String且值以指定字符串开头的字段。目前仅RDB支持该谓词。
......@@ -234,7 +234,7 @@ dataSharePredicates.beginsWith("NAME", "os")
## endsWith
endsWith(field: string, value: string): DataSharePredicates;
endsWith(field: string, value: string): DataSharePredicates
该接口用于配置谓词以匹配数据类型为String且值以指定字符串结尾的字段。目前仅RDB支持该谓词。
......@@ -262,7 +262,7 @@ dataSharePredicates.endsWith("NAME", "os")
## isNull
isNull(field: string): DataSharePredicates;
isNull(field: string): DataSharePredicates
该接口用于配置谓词以匹配值为null的字段。
......@@ -291,7 +291,7 @@ dataSharePredicates.isNull("NAME")
## isNotNull
isNotNull(field: string): DataSharePredicates;
isNotNull(field: string): DataSharePredicates
该接口用于配置谓词以匹配值不为null的指定字段。
......@@ -320,7 +320,7 @@ dataSharePredicates.isNotNull("NAME")
## like
like(field: string, value: string): DataSharePredicates;
like(field: string, value: string): DataSharePredicates
该接口用于配置谓词以匹配数据类型为string且值类似于指定字符串的字段。
......@@ -350,7 +350,7 @@ dataSharePredicates.like("NAME", "%os%")
## unlike
unlike(field: string, value: string): DataSharePredicates;
unlike(field: string, value: string): DataSharePredicates
该接口用于配置谓词以匹配数据类型为string且值不类似于指定字符串的字段。
......@@ -380,7 +380,7 @@ dataSharePredicates.unlike("NAME", "%os%")
## glob
glob(field: string, value: string): DataSharePredicates;
glob(field: string, value: string): DataSharePredicates
该接口用于配置谓词匹配数据类型为string的指定字段。目前仅RDB支持该谓词。
......@@ -408,7 +408,7 @@ dataSharePredicates.glob("NAME", "?h*g")
## between
between(field: string, low: ValueType, high: ValueType): DataSharePredicates;
between(field: string, low: ValueType, high: ValueType): DataSharePredicates
该接口用于将谓词配置为匹配数据类型为ValueType且value在指定范围内的指定字段。目前仅RDB支持该谓词。
......@@ -437,7 +437,7 @@ dataSharePredicates.between("AGE", 10, 50)
## notBetween
notBetween(field: string, low: ValueType, high: ValueType): DataSharePredicates;
notBetween(field: string, low: ValueType, high: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType且value超出给定范围的指定字段。目前仅RDB支持该谓词。
......@@ -466,7 +466,7 @@ dataSharePredicates.notBetween("AGE", 10, 50)
## greaterThan
greaterThan(field: string, value: ValueType): DataSharePredicates;
greaterThan(field: string, value: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType且值大于指定值的字段。
......@@ -496,7 +496,7 @@ dataSharePredicates.greaterThan("AGE", 10)
## lessThan
lessThan(field: string, value: ValueType): DataSharePredicates;
lessThan(field: string, value: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为valueType且value小于指定值的字段。
......@@ -526,7 +526,7 @@ dataSharePredicates.lessThan("AGE", 50)
## greaterThanOrEqualTo
greaterThanOrEqualTo(field: string, value: ValueType): DataSharePredicates;
greaterThanOrEqualTo(field: string, value: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType且value大于或等于指定值的字段。
......@@ -556,7 +556,7 @@ dataSharePredicates.greaterThanOrEqualTo("AGE", 10)
## lessThanOrEqualTo
lessThanOrEqualTo(field: string, value: ValueType): DataSharePredicates;
lessThanOrEqualTo(field: string, value: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType且value小于或等于指定值的字段。
......@@ -586,7 +586,7 @@ dataSharePredicates.lessThanOrEqualTo("AGE", 50)
## orderByAsc
orderByAsc(field: *string*): DataSharePredicates;
orderByAsc(field: *string*): DataSharePredicates
该接口用于配置谓词以匹配其值按升序排序的列。
......@@ -615,7 +615,7 @@ dataSharePredicates.orderByAsc("AGE")
## orderByDesc
orderByDesc(field: *string*): DataSharePredicates;
orderByDesc(field: *string*): DataSharePredicates
该接口用于配置谓词以匹配其值按降序排序的列。
......@@ -644,7 +644,7 @@ dataSharePredicates.orderByDesc("AGE")
## distinct
distinct(): DataSharePredicates;
distinct(): DataSharePredicates
该接口用于配置谓词以过滤重复记录并仅保留其中一个。目前仅RDB支持该谓词。
......@@ -665,7 +665,7 @@ dataSharePredicates.equalTo("NAME", "Rose").distinct("NAME")
## limit
limit(total: number, offset: number): DataSharePredicates;
limit(total: number, offset: number): DataSharePredicates
该接口用于配置谓词以指定结果数和起始位置。
......@@ -695,7 +695,7 @@ dataSharePredicates.equalTo("NAME", "Rose").limit(10, 3)
## groupBy
groupBy(fields: Array<string>): DataSharePredicates;
groupBy(fields: Array&lt;string&gt;): DataSharePredicates
该接口用于配置谓词按指定列分组查询结果。目前仅RDB支持该谓词。
......@@ -705,7 +705,7 @@ groupBy(fields: Array<string>): DataSharePredicates;
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------- | ---- | -------------------- |
| fields | Array<string> | 是 | 指定分组依赖的列名。 |
| fields | Array&lt;string&gt; | 是 | 指定分组依赖的列名。 |
**返回值:**
......@@ -722,7 +722,7 @@ dataSharePredicates.groupBy(["AGE", "NAME"])
## indexedBy
indexedBy(field: string): DataSharePredicates;
indexedBy(field: string): DataSharePredicates
该接口用于配置谓词以指定索引列。目前仅RDB支持该谓词。
......@@ -749,7 +749,7 @@ dataSharePredicates.indexedBy("SALARY_INDEX")
## in
in(field: string, value: Array<ValueType>): DataSharePredicates;
in(field: string, value: Array&lt;ValueType&gt;): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType数组且值在给定范围内的指定字段。
......@@ -762,7 +762,7 @@ in(field: string, value: Array<ValueType>): DataSharePredicates;
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------- | ---- | --------------------------------------- |
| field | string | 是 | 数据库表中的列名。 |
| value | Array<[ValueType](js-apis-data-ValuesBucket.md#valuetype)> | 是 | 以ValueType型数组形式指定的要匹配的值。 |
| value | Array&lt;[ValueType](js-apis-data-ValuesBucket.md#valuetype)&gt; | 是 | 以ValueType型数组形式指定的要匹配的值。 |
**返回值:**
......@@ -779,7 +779,7 @@ dataSharePredicates.in("AGE", [18, 20])
## notIn
notIn(field: string, value: Array<ValueType>): DataSharePredicates;
notIn(field: string, value: Array&lt;ValueType&gt;): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType数组且值不在给定范围内的指定字段。
......@@ -792,7 +792,7 @@ notIn(field: string, value: Array<ValueType>): DataSharePredicates;
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------- | ---- | --------------------------------------- |
| field | string | 是 | 数据库表中的列名。 |
| value | Array<[ValueType](js-apis-data-ValuesBucket.md#valuetype)> | 是 | 以ValueType型数组形式指定的要匹配的值。 |
| value | Array&lt;[ValueType](js-apis-data-ValuesBucket.md#valuetype)&gt; | 是 | 以ValueType型数组形式指定的要匹配的值。 |
**返回值:**
......@@ -809,7 +809,7 @@ dataSharePredicates.notIn("NAME", ["Lisa", "Rose"])
## prefixKey
prefixKey(prefix: string): DataSharePredicates;
prefixKey(prefix: string): DataSharePredicates
该接口用于配置谓词以匹配键前缀的指定字段。目前仅KVDB支持该谓词。
......@@ -836,7 +836,7 @@ dataSharePredicates.prefixKey("NAME")
## inKeys
inKeys(keys: Array<string>): DataSharePredicates;
inKeys(keys: Array&lt;string&gt;): DataSharePredicates
该接口用于配置谓词以匹配键在给定范围内的指定字段。目前仅KVDB支持该谓词。
......@@ -846,7 +846,7 @@ inKeys(keys: Array<string>): DataSharePredicates;
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------- | ---- | ------------------ |
| inKeys | Array<string> | 是 | 给定范围的键数组。 |
| inKeys | Array&lt;string&gt; | 是 | 给定范围的键数组。 |
**返回值:**
......
......@@ -47,14 +47,14 @@ dataShareHelper.query(uri, da, columns).then((data) => {
| 名称 | 参数类型 | 必填 | 说明 |
| ----------- | ------------- | ---- | ------------------------ |
| columnNames | Array<string> | 是 | 结果集中所有列的名称。 |
| columnNames | Array&lt;string&gt; | 是 | 结果集中所有列的名称。 |
| columnCount | number | 是 | 结果集中的列数。 |
| rowCount | number | 是 | 结果集中的行数。 |
| isClosed | boolean | 是 | 标志当前结果集是否关闭。 |
## goToFirstRow
goToFirstRow(): boolean;
goToFirstRow(): boolean
该接口用于转到结果集的第一行。
......@@ -77,7 +77,7 @@ console.info('resultSet.goToFirstRow: ' + isGoTOFirstRow);
## goToLastRow
goToLastRow(): boolean;
goToLastRow(): boolean
该接口用于转到结果集的最后一行。
......@@ -100,7 +100,7 @@ console.info('resultSet.goToLastRow: ' + isGoToLastRow);
## goToNextRow
goToNextRow(): boolean;
goToNextRow(): boolean
该接口用于转到结果集的下一行。
......@@ -123,7 +123,7 @@ console.info('resultSet.goToNextRow: ' + isGoToNextRow);
## goToPreviousRow
goToPreviousRow(): boolean;
goToPreviousRow(): boolean
该接口用于转到结果集的上一行。
......@@ -146,7 +146,7 @@ console.info('resultSet.goToPreviousRow: ' + isGoToPreviousRow);
## goTo
goTo(offset:number): boolean;
goTo(offset:number): boolean
该接口用于向前或向后转至结果集的指定行,相对于其当前位置偏移。
......@@ -176,7 +176,7 @@ console.info('resultSet.goTo: ' + isGoTo);
## goToRow
goToRow(position: number): boolean;
goToRow(position: number): boolean
该接口用于转到结果集的指定行。
......@@ -206,7 +206,7 @@ console.info('resultSet.goToRow: ' + isGoToRow);
## getBlob
getBlob(columnIndex: number): Uint8Array;
getBlob(columnIndex: number): Uint8Array
该接口用于以字节数组的形式获取当前行中指定列的值。
......@@ -237,7 +237,7 @@ console.info('resultSet.getBlob: ' + getBlob);
## getString
getString(columnIndex: number): *string*;
getString(columnIndex: number): *string*
该接口用于以字符串形式获取当前行中指定列的值。
......@@ -268,7 +268,7 @@ console.info('resultSet.getString: ' + getString);
## getLong
getLong(columnIndex: number): *number*;
getLong(columnIndex: number): *number*
该接口用于以Long形式获取当前行中指定列的值。
......@@ -299,7 +299,7 @@ console.info('resultSet.getLong: ' + getLong);
## getDouble
getDouble(columnIndex: number): *number*;
getDouble(columnIndex: number): *number*
该接口用于以double形式获取当前行中指定列的值。
......@@ -330,7 +330,7 @@ console.info('resultSet.getDouble: ' + getDouble);
## close
close(): void;
close(): void
该接口用于关闭结果集。
......@@ -344,7 +344,7 @@ resultSet.close();
## getColumnIndex
getColumnIndex(columnName: string): *number*;
getColumnIndex(columnName: string): *number*
该接口用于根据指定的列名获取列索引。
......@@ -374,7 +374,7 @@ console.info('resultSet.getColumnIndex: ' + getColumnIndex);
## getColumnName
getColumnName(columnIndex: number): *string*;
getColumnName(columnIndex: number): *string*
该接口用于根据指定的列索引获取列名。
......@@ -404,7 +404,7 @@ console.info('resultSet.getColumnName: ' + getColumnName);
## getDataType
getDataType(columnIndex: number): DataType;
getDataType(columnIndex: number): DataType
该接口用于获取指定列的数据类型。
......
......@@ -17,8 +17,8 @@ import dataShare from '@ohos.data.dataShare'
## dataShare.createDataShareHelper
createDataShareHelper(context: Context, uri: string, callback: AsyncCallback&lt;DataShareHelper&gt;): void;
createDataShareHelper(context: Context, uri: string): Promise&lt;DataShareHelper&gt;;
createDataShareHelper(context: Context, uri: string, callback: AsyncCallback&lt;DataShareHelper&gt;): void
createDataShareHelper(context: Context, uri: string): Promise&lt;DataShareHelper&gt;
创建DataShare工具类,创建helper对象时将连接服务端,与服务端取得连接后或超时后将返回helper实例,此方法为异步方法。在与服务端取得连接后可使用DataShare工具类提供的方法访问或管理服务端的数据,若未连接上服务端,调用工具类提供的方法时将返回error code。
......@@ -52,7 +52,7 @@ dataShare.createDataShareHelper(this.context, dseUri, (err, data) => {
### openFile
openFile(uri: string, mode: string, callback: AsyncCallback<number>): void
openFile(uri: string, mode: string, callback: AsyncCallback&lt;number&gt;): void
打开URI所指定的远程路径中的文件(callback形式)。
......@@ -64,7 +64,7 @@ openFile(uri: string, mode: string, callback: AsyncCallback<number>): void
| -------- | --------------------- | ---- | ---------------------------------- |
| uri | string | 是 | 指示要打开的文件的路径。 |
| mode | string | 是 | 指示文件打开模式‘rwt’。 |
| callback | AsyncCallback<number> | 是 | 被指定的回调方法,返回文件描述符。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 被指定的回调方法,返回文件描述符。 |
**示例:**
......@@ -84,7 +84,7 @@ dataShareHelper.openFile(uri, "rwt", (err, data) => {
### openFile
openFile(uri: string, mode: string): Promise<number>
openFile(uri: string, mode: string): Promise&lt;number&gt;
打开URI所指定的远程路径中的文件(Promise形式)。
......@@ -101,7 +101,7 @@ openFile(uri: string, mode: string): Promise<number>
| 类型 | 说明 |
| --------------- | ---------------- |
| Promise<number> | 返回文件描述符。 |
| Promise&lt;number&gt; | 返回文件描述符。 |
**示例:**
......@@ -119,7 +119,7 @@ dataShareHelper.openFile(uri, "rwt").then((data) => {
### on('dataChange')
on(type: 'dataChange', uri: string, callback: AsyncCallback\<void>): void
on(type: 'dataChange', uri: string, callback: AsyncCallback&lt;void&gt;): void
注册观察者以订阅给定uri指定的数据callback通知。若用户(订阅者)已注册了观察者,当有其他用户触发了变更通知时(调用了下文中的notifyChange方法),订阅者将会接受到callback通知。
......@@ -131,7 +131,7 @@ on(type: 'dataChange', uri: string, callback: AsyncCallback\<void>): void
| -------- | -------------------- | ---- | ------------------------ |
| type | string | 是 | 数据更改。 |
| uri | string | 是 | 指示要操作的数据的路径。 |
| callback | AsyncCallback\<void> | 是 | 指示数据更改时的回调。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 指示数据更改时的回调。 |
**示例:**
......@@ -148,7 +148,7 @@ export function onCallback() {
### off('dataChange')
off(type: 'dataChange', uri: string, callback?: AsyncCallback\<void>): void
off(type: 'dataChange', uri: string, callback?: AsyncCallback&lt;void&gt;): void
注消观察者以停止观察给定uri指定的数据callback通知。
......@@ -160,7 +160,7 @@ off(type: 'dataChange', uri: string, callback?: AsyncCallback\<void>): void
| -------- | -------------------- | ---- | ------------------------ |
| type | string | 是 | 数据更改。 |
| uri | string | 是 | 指示要操作的数据的路径。 |
| callback | AsyncCallback\<void> | 否 | 指示已注册的回调。 |
| callback | AsyncCallback&lt;void&gt; | 否 | 指示已注册的回调。 |
**示例:**
......@@ -177,7 +177,7 @@ export function offCallback() {
### notifyChange
notifyChange(uri: string, callback: AsyncCallback\<void>): void
notifyChange(uri: string, callback: AsyncCallback&lt;void&gt;): void
通知已注册的观察者uri指定的数据资源的更改(callback形式)。
......@@ -188,7 +188,7 @@ notifyChange(uri: string, callback: AsyncCallback\<void>): void
| 名称 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | ------------------------ |
| uri | string | 是 | 指示要操作的数据的路径。 |
| callback | AsyncCallback\<void> | 是 | 回调方法。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调方法。 |
**示例:**
......@@ -203,7 +203,7 @@ dataShareHelper.notifyChange(uri, () => {
### notifyChange
notifyChange(uri: string): Promise\<void>
notifyChange(uri: string): Promise&lt;void&gt;
通知已注册的观察者uri指定的数据资源的更改(Promise形式)。
......@@ -219,7 +219,7 @@ notifyChange(uri: string): Promise\<void>
| 类型 | 说明 |
| -------------- | --------------------- |
| Promise\<void> | 返回值为Promise对象。 |
| Promise&lt;void&gt; | 返回值为Promise对象。 |
**示例:**
......@@ -241,7 +241,7 @@ dataShareHelper.notifyChange(uri);
### getType
getType(uri: string, callback: AsyncCallback\<string>): void
getType(uri: string, callback: AsyncCallback&lt;string&gt;): void
获取URI所指定的数据的MIME类型(callback形式)。
......@@ -252,7 +252,7 @@ getType(uri: string, callback: AsyncCallback\<string>): void
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | --------------------------------------------- |
| uri | string | 是 | 指示要操作的数据的路径。 |
| callback | AsyncCallback\<string> | 是 | 回调方法,返回与uri指定的数据匹配的MIME类型。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调方法,返回与uri指定的数据匹配的MIME类型。 |
**示例:**
......@@ -272,7 +272,7 @@ dataShareHelper.getType(uri, (err, data)=>{
### getType
getType(uri: string): Promise\<string>
getType(uri: string): Promise&lt;string&gt;
获取URI所指定数据的MIME类型(Promise形式)。
......@@ -288,7 +288,7 @@ getType(uri: string): Promise\<string>
| 类型 | 说明 |
| ---------------- | ----------------------------------- |
| Promise\<string> | 返回与uri指定的数据匹配的MIME类型。 |
| Promise&lt;string&gt; | 返回与uri指定的数据匹配的MIME类型。 |
**示例:**
......@@ -305,7 +305,7 @@ dataShareHelper.getType(uri).then((data) => {
### getFileTypes
getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array\<string>>): void
getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void
获取支持的文件的MIME类型(callback形式)。
......@@ -317,7 +317,7 @@ getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback<Array\
| -------------- | ------------------------------ | ---- | ---------------------------------- |
| uri | string | 是 | 指示要获取的文件的路径。 |
| mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 |
| callback | AsyncCallback\<Array\<string>> | 是 | 回调方法,返回匹配的MIME类型数组。 |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 回调方法,返回匹配的MIME类型数组。 |
**示例:**
......@@ -339,7 +339,7 @@ dataShareHelper.getFileTypes(uri, mimeTypeFilter, (err,data) => {
### getFileTypes
getFileTypes(uri: string, mimeTypeFilter: string): Promise\<Array\<string>>
getFileTypes(uri: string, mimeTypeFilter: string): Promise&lt;Array&lt;string&gt;&gt;
获取支持的文件的MIME类型(Promise形式)。
......@@ -356,7 +356,7 @@ getFileTypes(uri: string, mimeTypeFilter: string): Promise\<Array\<string>>
| 类型 | 说明 |
| ------------------------ | ------------------------ |
| Promise\<Array\<string>> | 返回匹配的MIME类型数组。 |
| Promise&lt;Array&lt;string&gt;&gt; | 返回匹配的MIME类型数组。 |
**示例:**
......@@ -374,7 +374,7 @@ dataShareHelper.getFileTypes(uri, mimeTypeFilter).then((data) => {
### normalizeUri
normalizeUri(uri: string, callback: AsyncCallback\<string>): void
normalizeUri(uri: string, callback: AsyncCallback&lt;string&gt;): void
将给定的DataShare uri转换为规范化uri(callback形式)。
......@@ -385,7 +385,7 @@ normalizeUri(uri: string, callback: AsyncCallback\<string>): void
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | -------------------------------------------------------- |
| uri | string | 是 | 指示要规范化的uri对象。 |
| callback | AsyncCallback\<string> | 是 | 回调方法。如果支持uri规范化或null,则返回规范化uri对象。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调方法。如果支持uri规范化或null,则返回规范化uri对象。 |
**示例:**
......@@ -404,7 +404,7 @@ dataShareHelper.normalizeUri(uri, (err, data) => {
### normalizeUri
normalizeUri(uri: string): Promise\<string>
normalizeUri(uri: string): Promise&lt;string&gt;
将给定的DataShare uri转换为规范化uri(Promise形式)。
......@@ -420,7 +420,7 @@ normalizeUri(uri: string): Promise\<string>
| 类型 | 说明 |
| ---------------- | ---------------------------------------------- |
| Promise\<string> | 如果支持uri规范化或null,则返回规范化uri对象。 |
| Promise&lt;string&gt; | 如果支持uri规范化或null,则返回规范化uri对象。 |
**示例:**
......@@ -437,7 +437,7 @@ dataShareHelper.normalizeUri(uri).then((data) => {
### denormalizeUri
denormalizeUri(uri: string, callback: AsyncCallback\<string>): void
denormalizeUri(uri: string, callback: AsyncCallback&lt;string&gt;): void
将由normalizeUri(uri)生成的规范化uri转换为非规范化uri(callback形式)。
......@@ -448,7 +448,7 @@ denormalizeUri(uri: string, callback: AsyncCallback\<string>): void
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | --------------------------------------------------- |
| uri | string | 是 | 指示要规范化的uri对象。 |
| callback | AsyncCallback\<string> | 是 | 回调方法。如果反规范化成功,则返回反规范化uri对象。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调方法。如果反规范化成功,则返回反规范化uri对象。 |
**示例:**
......@@ -467,7 +467,7 @@ dataShareHelper.denormalizeUri(uri, (err, data) => {
### denormalizeUri
denormalizeUri(uri: string): Promise\<string>
denormalizeUri(uri: string): Promise&lt;string&gt;
将由normalizeUri(uri)生成的规范化uri转换为非规范化uri(Promise形式)。
......@@ -483,7 +483,7 @@ denormalizeUri(uri: string): Promise\<string>
| 类型 | 说明 |
| ---------------- | ----------------------------------------- |
| Promise\<string> | 如果反规范化成功,则返回反规范化uri对象。 |
| Promise&lt;string&gt; | 如果反规范化成功,则返回反规范化uri对象。 |
**示例:**
......@@ -500,7 +500,7 @@ dataShareHelper.denormalizeUri(uri).then((data) => {
### insert
insert(uri: string, value: ValuesBucket, callback: AsyncCallback\<number>): void
insert(uri: string, value: ValuesBucket, callback: AsyncCallback&lt;number&gt;): void
将单条数据记录插入数据库(callback形式)。
......@@ -512,7 +512,7 @@ insert(uri: string, value: ValuesBucket, callback: AsyncCallback\<number>): void
| -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 指示要插入的数据的路径。 |
| value | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要插入的数据记录。如果此参数为空,将插入一个空行。 |
| callback | AsyncCallback\<number> | 是 | 回调方法,返回插入数据记录的索引。(能否返回索引取决于服务端所使用的数据库) |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调方法,返回插入数据记录的索引。(能否返回索引取决于服务端所使用的数据库) |
**示例:**
......@@ -537,7 +537,7 @@ dataShareHelper.insert(uri, valueBucket, (err, data) => {
### insert
insert(uri: string, value: ValuesBucket): Promise\<number>
insert(uri: string, value: ValuesBucket): Promise&lt;number&gt;
将单条数据记录插入数据库(Promise形式)。
......@@ -554,7 +554,7 @@ insert(uri: string, value: ValuesBucket): Promise\<number>
| 类型 | 说明 |
| ---------------- | ------------------------------------------------------------ |
| Promise\<number> | 返回插入数据记录的索引。(能否返回索引取决于服务端所使用的数据库) |
| Promise&lt;number&gt; | 返回插入数据记录的索引。(能否返回索引取决于服务端所使用的数据库) |
**示例:**
......@@ -577,7 +577,7 @@ dataShareHelper.insert(uri, valueBucket).then((data) => {
### batchInsert
batchInsert(uri: string, values: Array\<ValuesBucket>, callback: AsyncCallback\<number>): void
batchInsert(uri: string, values: Array&lt;ValuesBucket&gt;, callback: AsyncCallback&lt;number&gt;): void
将批量数据插入数据库(callback形式)。
......@@ -588,8 +588,8 @@ batchInsert(uri: string, values: Array\<ValuesBucket>, callback: AsyncCallback\<
| 名称 | 类型 | 必填 | 描述 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 指示要插入的数据的路径。 |
| values | Array\<[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)> | 是 | 指示要插入的数据记录。 |
| callback | AsyncCallback\<number> | 是 | 回调方法,返回插入的数据记录数。(能否返回记录数取决于服务端所使用的数据库) |
| values | Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是 | 指示要插入的数据记录。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调方法,返回插入的数据记录数。(能否返回记录数取决于服务端所使用的数据库) |
**示例:**
......@@ -611,7 +611,7 @@ dataShareHelper.batchInsert(uri, vbs, (err, data) => {
### batchInsert
batchInsert(uri: string, values: Array\<ValuesBucket>): Promise\<number>
batchInsert(uri: string, values: Array&lt;ValuesBucket&gt;): Promise&lt;number&gt;
将批量数据插入数据库(Promise形式)。
......@@ -622,13 +622,13 @@ batchInsert(uri: string, values: Array\<ValuesBucket>): Promise\<number>
| 名称 | 类型 | 必填 | 描述 |
| ------ | ------------------------------------------------------------ | ---- | ------------------------ |
| uri | string | 是 | 指示要插入的数据的路径。 |
| values | Array\<[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)> | 是 | 指示要插入的数据记录。 |
| values | Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是 | 指示要插入的数据记录。 |
**返回值:**
| 类型 | 说明 |
| ---------------- | ------------------------------------------------------------ |
| Promise\<number> | 返回插入的数据记录数。(能否返回记录数取决于服务端所使用的数据库) |
| Promise&lt;number&gt; | 返回插入的数据记录数。(能否返回记录数取决于服务端所使用的数据库) |
**示例:**
......@@ -648,7 +648,7 @@ dataShareHelper.batchInsert(uri, vbs).then((data) => {
### delete
delete(uri: string, predicates: DataSharePredicates, callback: AsyncCallback\<number>): void
delete(uri: string, predicates: DataSharePredicates, callback: AsyncCallback&lt;number&gt;): void
从数据库中删除一条或多条数据记录(callback形式)。
......@@ -660,7 +660,7 @@ delete(uri: string, predicates: DataSharePredicates, callback: AsyncCallback\<nu
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 指示要删除的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。当此参数为null时,应定义处理逻辑。(具体所支持的谓词方法取决于服务端所选用的数据库,如KVDB的删除目前仅支持inKeys谓词) |
| callback | AsyncCallback\<number> | 是 | 回调方法,返回已删除的数据记录数。(能否返回已删除的数目取决于服务端所使用的数据库) |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调方法,返回已删除的数据记录数。(能否返回已删除的数目取决于服务端所使用的数据库) |
**示例:**
......@@ -681,7 +681,7 @@ dataShareHelper.delete(uri, da, (err, data) => {
### delete
delete(uri: string, predicates: DataSharePredicates): Promise\<number>
delete(uri: string, predicates: DataSharePredicates): Promise&lt;number&gt;
从数据库中删除一条或多条数据记录(Promise形式)。
......@@ -698,7 +698,7 @@ delete(uri: string, predicates: DataSharePredicates): Promise\<number>
| 类型 | 说明 |
| ---------------- | ------------------------------------------------------------ |
| Promise\<number> | 返回已删除的数据记录数。(能否返回已删除的数目取决于服务端所使用的数据库) |
| Promise&lt;number&gt; | 返回已删除的数据记录数。(能否返回已删除的数目取决于服务端所使用的数据库) |
**示例:**
......@@ -717,7 +717,7 @@ dataShareHelper.delete(uri, da).then((data) => {
### update
update(uri: string, predicates: DataSharePredicates, value: ValuesBucket, callback: AsyncCallback<number>): void
update(uri: string, predicates: DataSharePredicates, value: ValuesBucket, callback: AsyncCallback&lt;number&gt;): void
更新数据库中的数据记录(callback形式)。
......@@ -730,7 +730,7 @@ update(uri: string, predicates: DataSharePredicates, value: ValuesBucket, callba
| uri | string | 是 | 指示要更新的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。当此参数为null时,应定义处理逻辑。(是否支持谓词取决于服务端所选用的数据库,如KVDB并不支持谓词,仅RDB支持) |
| value | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要更新的数据。 |
| callback | AsyncCallback\<number> | 是 | 回调方法,返回更新的数据记录数。(能否返回更新的数据记录数取决于服务端所使用的数据库) |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调方法,返回更新的数据记录数。(能否返回更新的数据记录数取决于服务端所使用的数据库) |
**示例:**
......@@ -757,7 +757,7 @@ dataShareHelper.update(uri, da, va, (err, data) => {
### update
update(uri: string, predicates: DataSharePredicates, value: ValuesBucket): Promise<number>
update(uri: string, predicates: DataSharePredicates, value: ValuesBucket): Promise&lt;number&gt;
更新数据库中的数据记录(Promise形式)。
......@@ -775,7 +775,7 @@ update(uri: string, predicates: DataSharePredicates, value: ValuesBucket): Promi
| 类型 | 说明 |
| ---------------- | ------------------------------------------------------------ |
| Promise\<number> | 返回更新的数据记录数。(能否返回更新的数据记录数取决于服务端所使用的数据库) |
| Promise&lt;number&gt; | 返回更新的数据记录数。(能否返回更新的数据记录数取决于服务端所使用的数据库) |
**示例:**
......@@ -800,7 +800,7 @@ dataShareHelper.update(uri, da, va).then((data) => {
### query
query(uri: string, predicates: DataSharePredicates, columns: Array<string>, callback: AsyncCallback<DataShareResultSet>): void
query(uri: string, predicates: DataSharePredicates, columns: Array&lt;string&gt;, callback: AsyncCallback&lt;DataShareResultSet&gt;): void
查询数据库中的数据(callback形式)。
......@@ -812,8 +812,8 @@ query(uri: string, predicates: DataSharePredicates, columns: Array<string>, call
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 指示要查询的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。当此参数为null时,应定义处理逻辑。(具体所支持的谓词方法取决于服务端所选用的数据库,如KVDB目前仅支持inKeys和prefixKey) |
| columns | Array<string> | 是 | 指示要查询的列。如果此参数为空,则查询所有列。 |
| callback | AsyncCallback\<[DataShareResultSet](js-apis-data-DataShareResultSet.md#datashareresultset)> | 是 | 回调方法,返回查询结果。 |
| columns | Array&lt;string&gt; | 是 | 指示要查询的列。如果此参数为空,则查询所有列。 |
| callback | AsyncCallback&lt;[DataShareResultSet](js-apis-data-DataShareResultSet.md#datashareresultset)&gt; | 是 | 回调方法,返回查询结果。 |
**示例:**
......@@ -837,7 +837,7 @@ dataShareHelper.query(uri, da, columns, (err, data) => {
### query
query(uri: string, predicates: DataSharePredicates, columns: Array<string>): Promise<DataShareResultSet>
query(uri: string, predicates: DataSharePredicates, columns: Array&lt;string&gt;): Promise&lt;DataShareResultSet&gt;
查询数据库中的数据(Promise形式)。
......@@ -849,13 +849,13 @@ query(uri: string, predicates: DataSharePredicates, columns: Array<string>): Pro
| ---------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| uri | string | 是 | 指示要查询的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。当此参数为null时,应定义处理逻辑。(具体所支持的谓词方法取决于服务端所选用的数据库,如KVDB目前仅支持inKeys和prefixKey) |
| columns | Array<string> | 是 | 指示要查询的列。如果此参数为空,则查询所有列。 |
| columns | Array&lt;string&gt; | 是 | 指示要查询的列。如果此参数为空,则查询所有列。 |
**返回值:**
| 类型 | 说明 |
| ------------------------------------------------------------ | -------------- |
| Promise\<[DataShareResultSet](js-apis-data-DataShareResultSet.md#datashareresultset)> | 返回查询结果。 |
| Promise&lt;[DataShareResultSet](js-apis-data-DataShareResultSet.md#datashareresultset)&gt; | 返回查询结果。 |
**示例:**
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册