提交 c1dbd75a 编写于 作者: S songruirui

格式修改

Signed-off-by: Nsongruirui <songruirui1@huawei.com>
上级 468bd3b4
...@@ -15,7 +15,7 @@ import DataShareExtensionAbility from '@ohos.application.DataShareExtensionAbili ...@@ -15,7 +15,7 @@ import DataShareExtensionAbility from '@ohos.application.DataShareExtensionAbili
## onCreate ## onCreate
onCreate?(want: Want, callback: AsyncCallback<void>): void; onCreate?(want: Want, callback: AsyncCallback&lt;void&gt;): void
DataShareExtAbility生命周期回调,在创建时回调,执行初始化业务逻辑操作。 DataShareExtAbility生命周期回调,在创建时回调,执行初始化业务逻辑操作。
...@@ -30,7 +30,7 @@ DataShareExtAbility生命周期回调,在创建时回调,执行初始化业 ...@@ -30,7 +30,7 @@ DataShareExtAbility生命周期回调,在创建时回调,执行初始化业
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ | | ----- | ------ | ------ | ------ |
| want | [Want](js-apis-application-Want.md#want) | 是 | Want类型信息,包括ability名称、bundle名称等。 | | 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) { ...@@ -64,7 +64,7 @@ onCreate(want, callback) {
## insert ## insert
insert?(uri: string, valueBucket: ValuesBucket, callback: AsyncCallback<number>): void; insert?(uri: string, valueBucket: ValuesBucket, callback: AsyncCallback&lt;number&gt;): void
insert生命周期回调,在数据库插入时回调。 insert生命周期回调,在数据库插入时回调。
...@@ -80,7 +80,7 @@ insert生命周期回调,在数据库插入时回调。 ...@@ -80,7 +80,7 @@ insert生命周期回调,在数据库插入时回调。
| ----- | ------ | ------ | ------ | | ----- | ------ | ------ | ------ |
| uri |string | 是 | 指示要插入的数据的路径。 | | uri |string | 是 | 指示要插入的数据的路径。 |
| valueBucket |[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要插入的数据记录。 | | valueBucket |[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要插入的数据记录。 |
| callback |AsyncCallback<number> | 是 | 表示被指定的回调方法。 | | callback |AsyncCallback&lt;number&gt; | 是 | 表示被指定的回调方法。 |
**示例:** **示例:**
...@@ -108,7 +108,7 @@ insert(uri, value, callback) { ...@@ -108,7 +108,7 @@ insert(uri, value, callback) {
## update ## 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生命周期回调,在数据库更新时回调。 update生命周期回调,在数据库更新时回调。
...@@ -125,7 +125,7 @@ update生命周期回调,在数据库更新时回调。 ...@@ -125,7 +125,7 @@ update生命周期回调,在数据库更新时回调。
| uri | string | 是 | 指示要更新的数据的路径。 | | uri | string | 是 | 指示要更新的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。 | | predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。 |
| valueBucket | [ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket) | 是 | 指示要更新的数据。 | | 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) { ...@@ -151,7 +151,7 @@ update(uri, predicates, value, callback) {
## query ## 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生命周期回调,在数据库查询时回调。 query生命周期回调,在数据库查询时回调。
...@@ -167,8 +167,8 @@ query生命周期回调,在数据库查询时回调。 ...@@ -167,8 +167,8 @@ query生命周期回调,在数据库查询时回调。
| ----- | ------ | ------ | ------ | | ----- | ------ | ------ | ------ |
| uri | string | 是 | 指示要查询的数据的路径。 | | uri | string | 是 | 指示要查询的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。 | | predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。 |
| columns | Array<string> | 是 | 指示要查询的列。如果此参数为空,则查询所有列。 | | columns | Array&lt;string&gt; | 是 | 指示要查询的列。如果此参数为空,则查询所有列。 |
| callback | AsyncCallback<Object> | 是 | 表示被指定的回调方法。 | | callback | AsyncCallback&lt;Object&gt; | 是 | 表示被指定的回调方法。 |
**示例:** **示例:**
...@@ -197,7 +197,7 @@ query(uri, predicates, columns, callback) { ...@@ -197,7 +197,7 @@ query(uri, predicates, columns, callback) {
## delete ## delete
delete?(uri: string, predicates: DataSharePredicates, callback: AsyncCallback<number>): void; delete?(uri: string, predicates: DataSharePredicates, callback: AsyncCallback&lt;number&gt;): void
delete生命周期回调,在删除数据库记录时回调。 delete生命周期回调,在删除数据库记录时回调。
...@@ -213,7 +213,7 @@ delete生命周期回调,在删除数据库记录时回调。 ...@@ -213,7 +213,7 @@ delete生命周期回调,在删除数据库记录时回调。
| ---------- | ------------------------------------------------------------ | ---- | ------------------------ | | ---------- | ------------------------------------------------------------ | ---- | ------------------------ |
| uri | string | 是 | 指示要查询的数据的路径。 | | uri | string | 是 | 指示要查询的数据的路径。 |
| predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。 | | predicates | [DataSharePredicates](js-apis-data-DataSharePredicates.md#datasharepredicates) | 是 | 指示筛选条件。 |
| callback | AsyncCallback<number> | 是 | 表示被指定的回调方法。 | | callback | AsyncCallback&lt;number&gt; | 是 | 表示被指定的回调方法。 |
**示例:** **示例:**
...@@ -239,7 +239,7 @@ delete(uri, predicates, callback) { ...@@ -239,7 +239,7 @@ delete(uri, predicates, callback) {
## batchInsert ## 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生命周期回调,在数据库批量插入时回调。 batchinsert生命周期回调,在数据库批量插入时回调。
...@@ -254,8 +254,8 @@ batchinsert生命周期回调,在数据库批量插入时回调。 ...@@ -254,8 +254,8 @@ batchinsert生命周期回调,在数据库批量插入时回调。
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| ------------ | ------------------------------------------------------------ | ---- | ------------------------ | | ------------ | ------------------------------------------------------------ | ---- | ------------------------ |
| uri | string | 是 | 指示要插入的数据的路径。 | | uri | string | 是 | 指示要插入的数据的路径。 |
| valueBuckets | Array<[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)> | 是 | 指示要插入的数据记录。 | | valueBuckets | Array&lt;[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)&gt; | 是 | 指示要插入的数据记录。 |
| callback | AsyncCallback<number> | 是 | 表示被指定的回调方法。 | | callback | AsyncCallback&lt;number&gt; | 是 | 表示被指定的回调方法。 |
**示例:** **示例:**
...@@ -285,7 +285,7 @@ batchInsert(uri: string, valueBuckets, callback) { ...@@ -285,7 +285,7 @@ batchInsert(uri: string, valueBuckets, callback) {
## getType ## getType
getType?(uri: string, callback: AsyncCallback<string>): void; getType?(uri: string, callback: AsyncCallback&lt;string&gt;): void
getType生命周期回调函数,获取给定URI对应的MIME类型时回调。 getType生命周期回调函数,获取给定URI对应的MIME类型时回调。
...@@ -300,7 +300,7 @@ getType生命周期回调函数,获取给定URI对应的MIME类型时回调。 ...@@ -300,7 +300,7 @@ getType生命周期回调函数,获取给定URI对应的MIME类型时回调。
| 参数名 | 参数类型 | 必填 | 说明 | | 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ | | ----- | ------ | ------ | ------ |
| uri | string | 是 | 指示要操作的数据的路径。 | | uri | string | 是 | 指示要操作的数据的路径。 |
| callback | AsyncCallback<string> | 是 | 表示被指定的回调方法。 | | callback | AsyncCallback&lt;string&gt; | 是 | 表示被指定的回调方法。 |
**示例:** **示例:**
...@@ -316,7 +316,7 @@ getType(uri: string, callback) { ...@@ -316,7 +316,7 @@ getType(uri: string, callback) {
## getFileTypes ## 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类型时回调。 getFileTypes生命周期回调,获取支持文件的MIME类型时回调。
...@@ -332,7 +332,7 @@ getFileTypes生命周期回调,获取支持文件的MIME类型时回调。 ...@@ -332,7 +332,7 @@ getFileTypes生命周期回调,获取支持文件的MIME类型时回调。
| -------------- | ---------------------------- | ---- | ---------------------------- | | -------------- | ---------------------------- | ---- | ---------------------------- |
| uri | string | 是 | 指示要获取的文件的路径。 | | uri | string | 是 | 指示要获取的文件的路径。 |
| mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 | | 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) { ...@@ -348,7 +348,7 @@ getFileTypes(uri: string, mimeTypeFilter: string,callback) {
## normalizeUri ## normalizeUri
normalizeUri?(uri: string, callback: AsyncCallback<string>): void; normalizeUri?(uri: string, callback: AsyncCallback&lt;string&gt;): void
normalizeUri生命周期回调,给定uri转换为规范化uri时回调。 normalizeUri生命周期回调,给定uri转换为规范化uri时回调。
...@@ -363,7 +363,7 @@ normalizeUri生命周期回调,给定uri转换为规范化uri时回调。 ...@@ -363,7 +363,7 @@ normalizeUri生命周期回调,给定uri转换为规范化uri时回调。
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | --------------------- | ---- | ----------------------- | | -------- | --------------------- | ---- | ----------------------- |
| uri | string | 是 | 指示要规范化的uri对象。 | | uri | string | 是 | 指示要规范化的uri对象。 |
| callback | AsyncCallback<string> | 是 | 表示被指定的回调方法。 | | callback | AsyncCallback&lt;string&gt; | 是 | 表示被指定的回调方法。 |
**示例:** **示例:**
...@@ -379,7 +379,7 @@ normalizeUri(uri: string, callback) { ...@@ -379,7 +379,7 @@ normalizeUri(uri: string, callback) {
## denormalizeUri ## denormalizeUri
denormalizeUri?(uri: string, callback: AsyncCallback<string>): void; denormalizeUri?(uri: string, callback: AsyncCallback&lt;string&gt;): void
将由denormalizeUri生命周期回调,给定规范化uri转换为非规范化uri时回调。 将由denormalizeUri生命周期回调,给定规范化uri转换为非规范化uri时回调。
...@@ -394,7 +394,7 @@ denormalizeUri?(uri: string, callback: AsyncCallback<string>): void; ...@@ -394,7 +394,7 @@ denormalizeUri?(uri: string, callback: AsyncCallback<string>): void;
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| -------- | --------------------- | ---- | ----------------------- | | -------- | --------------------- | ---- | ----------------------- |
| uri | string | 是 | 指示要规范化的uri对象。 | | uri | string | 是 | 指示要规范化的uri对象。 |
| callback | AsyncCallback<string> | 是 | 表示被指定的回调方法。 | | callback | AsyncCallback&lt;string&gt; | 是 | 表示被指定的回调方法。 |
**示例:** **示例:**
...@@ -410,7 +410,7 @@ denormalizeUri(uri: string, callback) { ...@@ -410,7 +410,7 @@ denormalizeUri(uri: string, callback) {
## openFile ## openFile
openFile?(uri: string, mode: string, callback: AsyncCallback<number>): void; openFile?(uri: string, mode: string, callback: AsyncCallback&lt;number&gt;): void
将由openFile生命周期回调,在打开文件时回调。 将由openFile生命周期回调,在打开文件时回调。
...@@ -426,7 +426,7 @@ openFile?(uri: string, mode: string, callback: AsyncCallback<number>): void; ...@@ -426,7 +426,7 @@ openFile?(uri: string, mode: string, callback: AsyncCallback<number>): void;
| -------- | --------------------- | ---- | ------------------------------------------ | | -------- | --------------------- | ---- | ------------------------------------------ |
| uri | string | 是 | 指示要规范化的uri对象。 | | uri | string | 是 | 指示要规范化的uri对象。 |
| mode | string | 是 | 指示文件打开模式,包括只读模式,读写模式。 | | mode | string | 是 | 指示文件打开模式,包括只读模式,读写模式。 |
| callback | AsyncCallback<number> | 是 | 表示被指定的回调方法。 | | callback | AsyncCallback&lt;number&gt; | 是 | 表示被指定的回调方法。 |
**示例:** **示例:**
......
...@@ -16,7 +16,7 @@ import DataSharePredicates from '@ohos.data.DataSharePredicates'; ...@@ -16,7 +16,7 @@ import DataSharePredicates from '@ohos.data.DataSharePredicates';
## equalTo ## equalTo
equalTo(field: string, value: ValueType): DataSharePredicates; equalTo(field: string, value: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType且值等于指定值的字段。 该接口用于配置谓词以匹配数据类型为ValueType且值等于指定值的字段。
...@@ -46,7 +46,7 @@ dataSharePredicates.equalTo("NAME", "Rose") ...@@ -46,7 +46,7 @@ dataSharePredicates.equalTo("NAME", "Rose")
## notEqualTo ## notEqualTo
notEqualTo(field: string, value: ValueType): DataSharePredicates; notEqualTo(field: string, value: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType且值不等于指定值的字段。 该接口用于配置谓词以匹配数据类型为ValueType且值不等于指定值的字段。
...@@ -76,7 +76,7 @@ dataSharePredicates.notEqualTo("NAME", "Rose") ...@@ -76,7 +76,7 @@ dataSharePredicates.notEqualTo("NAME", "Rose")
## beginWrap ## beginWrap
beginWrap(): DataSharePredicates; beginWrap(): DataSharePredicates
该接口用于向谓词添加左括号。目前仅RDB支持该谓词。 该接口用于向谓词添加左括号。目前仅RDB支持该谓词。
...@@ -102,7 +102,7 @@ dataSharePredicates.equalTo("NAME", "lisi") ...@@ -102,7 +102,7 @@ dataSharePredicates.equalTo("NAME", "lisi")
## endWrap ## endWrap
endWrap(): DataSharePredicates; endWrap(): DataSharePredicates
该接口用于向谓词添加右括号。目前仅RDB支持该谓词。 该接口用于向谓词添加右括号。目前仅RDB支持该谓词。
...@@ -128,7 +128,7 @@ dataSharePredicates.equalTo("NAME", "lisi") ...@@ -128,7 +128,7 @@ dataSharePredicates.equalTo("NAME", "lisi")
## or ## or
or(): DataSharePredicates; or(): DataSharePredicates
该接口用于将或条件添加到谓词中。 该接口用于将或条件添加到谓词中。
...@@ -153,7 +153,7 @@ dataSharePredicates.equalTo("NAME", "lisi") ...@@ -153,7 +153,7 @@ dataSharePredicates.equalTo("NAME", "lisi")
## and ## and
and(): DataSharePredicates; and(): DataSharePredicates
该接口用于将和条件添加到谓词中。 该接口用于将和条件添加到谓词中。
...@@ -178,7 +178,7 @@ dataSharePredicates.equalTo("NAME", "lisi") ...@@ -178,7 +178,7 @@ dataSharePredicates.equalTo("NAME", "lisi")
## contains ## contains
contains(field: string, value: string): DataSharePredicates; contains(field: string, value: string): DataSharePredicates
该接口用于配置谓词以匹配数据类型为String且value包含指定值的字段。目前仅RDB支持该谓词。 该接口用于配置谓词以匹配数据类型为String且value包含指定值的字段。目前仅RDB支持该谓词。
...@@ -206,7 +206,7 @@ dataSharePredicates.contains("NAME", "os") ...@@ -206,7 +206,7 @@ dataSharePredicates.contains("NAME", "os")
## beginsWith ## beginsWith
beginsWith(field: string, value: string): DataSharePredicates; beginsWith(field: string, value: string): DataSharePredicates
该接口用于配置谓词以匹配数据类型为String且值以指定字符串开头的字段。目前仅RDB支持该谓词。 该接口用于配置谓词以匹配数据类型为String且值以指定字符串开头的字段。目前仅RDB支持该谓词。
...@@ -234,7 +234,7 @@ dataSharePredicates.beginsWith("NAME", "os") ...@@ -234,7 +234,7 @@ dataSharePredicates.beginsWith("NAME", "os")
## endsWith ## endsWith
endsWith(field: string, value: string): DataSharePredicates; endsWith(field: string, value: string): DataSharePredicates
该接口用于配置谓词以匹配数据类型为String且值以指定字符串结尾的字段。目前仅RDB支持该谓词。 该接口用于配置谓词以匹配数据类型为String且值以指定字符串结尾的字段。目前仅RDB支持该谓词。
...@@ -262,7 +262,7 @@ dataSharePredicates.endsWith("NAME", "os") ...@@ -262,7 +262,7 @@ dataSharePredicates.endsWith("NAME", "os")
## isNull ## isNull
isNull(field: string): DataSharePredicates; isNull(field: string): DataSharePredicates
该接口用于配置谓词以匹配值为null的字段。 该接口用于配置谓词以匹配值为null的字段。
...@@ -291,7 +291,7 @@ dataSharePredicates.isNull("NAME") ...@@ -291,7 +291,7 @@ dataSharePredicates.isNull("NAME")
## isNotNull ## isNotNull
isNotNull(field: string): DataSharePredicates; isNotNull(field: string): DataSharePredicates
该接口用于配置谓词以匹配值不为null的指定字段。 该接口用于配置谓词以匹配值不为null的指定字段。
...@@ -320,7 +320,7 @@ dataSharePredicates.isNotNull("NAME") ...@@ -320,7 +320,7 @@ dataSharePredicates.isNotNull("NAME")
## like ## like
like(field: string, value: string): DataSharePredicates; like(field: string, value: string): DataSharePredicates
该接口用于配置谓词以匹配数据类型为string且值类似于指定字符串的字段。 该接口用于配置谓词以匹配数据类型为string且值类似于指定字符串的字段。
...@@ -350,7 +350,7 @@ dataSharePredicates.like("NAME", "%os%") ...@@ -350,7 +350,7 @@ dataSharePredicates.like("NAME", "%os%")
## unlike ## unlike
unlike(field: string, value: string): DataSharePredicates; unlike(field: string, value: string): DataSharePredicates
该接口用于配置谓词以匹配数据类型为string且值不类似于指定字符串的字段。 该接口用于配置谓词以匹配数据类型为string且值不类似于指定字符串的字段。
...@@ -380,7 +380,7 @@ dataSharePredicates.unlike("NAME", "%os%") ...@@ -380,7 +380,7 @@ dataSharePredicates.unlike("NAME", "%os%")
## glob ## glob
glob(field: string, value: string): DataSharePredicates; glob(field: string, value: string): DataSharePredicates
该接口用于配置谓词匹配数据类型为string的指定字段。目前仅RDB支持该谓词。 该接口用于配置谓词匹配数据类型为string的指定字段。目前仅RDB支持该谓词。
...@@ -408,7 +408,7 @@ dataSharePredicates.glob("NAME", "?h*g") ...@@ -408,7 +408,7 @@ dataSharePredicates.glob("NAME", "?h*g")
## between ## between
between(field: string, low: ValueType, high: ValueType): DataSharePredicates; between(field: string, low: ValueType, high: ValueType): DataSharePredicates
该接口用于将谓词配置为匹配数据类型为ValueType且value在指定范围内的指定字段。目前仅RDB支持该谓词。 该接口用于将谓词配置为匹配数据类型为ValueType且value在指定范围内的指定字段。目前仅RDB支持该谓词。
...@@ -437,7 +437,7 @@ dataSharePredicates.between("AGE", 10, 50) ...@@ -437,7 +437,7 @@ dataSharePredicates.between("AGE", 10, 50)
## notBetween ## notBetween
notBetween(field: string, low: ValueType, high: ValueType): DataSharePredicates; notBetween(field: string, low: ValueType, high: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType且value超出给定范围的指定字段。目前仅RDB支持该谓词。 该接口用于配置谓词以匹配数据类型为ValueType且value超出给定范围的指定字段。目前仅RDB支持该谓词。
...@@ -466,7 +466,7 @@ dataSharePredicates.notBetween("AGE", 10, 50) ...@@ -466,7 +466,7 @@ dataSharePredicates.notBetween("AGE", 10, 50)
## greaterThan ## greaterThan
greaterThan(field: string, value: ValueType): DataSharePredicates; greaterThan(field: string, value: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType且值大于指定值的字段。 该接口用于配置谓词以匹配数据类型为ValueType且值大于指定值的字段。
...@@ -496,7 +496,7 @@ dataSharePredicates.greaterThan("AGE", 10) ...@@ -496,7 +496,7 @@ dataSharePredicates.greaterThan("AGE", 10)
## lessThan ## lessThan
lessThan(field: string, value: ValueType): DataSharePredicates; lessThan(field: string, value: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为valueType且value小于指定值的字段。 该接口用于配置谓词以匹配数据类型为valueType且value小于指定值的字段。
...@@ -526,7 +526,7 @@ dataSharePredicates.lessThan("AGE", 50) ...@@ -526,7 +526,7 @@ dataSharePredicates.lessThan("AGE", 50)
## greaterThanOrEqualTo ## greaterThanOrEqualTo
greaterThanOrEqualTo(field: string, value: ValueType): DataSharePredicates; greaterThanOrEqualTo(field: string, value: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType且value大于或等于指定值的字段。 该接口用于配置谓词以匹配数据类型为ValueType且value大于或等于指定值的字段。
...@@ -556,7 +556,7 @@ dataSharePredicates.greaterThanOrEqualTo("AGE", 10) ...@@ -556,7 +556,7 @@ dataSharePredicates.greaterThanOrEqualTo("AGE", 10)
## lessThanOrEqualTo ## lessThanOrEqualTo
lessThanOrEqualTo(field: string, value: ValueType): DataSharePredicates; lessThanOrEqualTo(field: string, value: ValueType): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType且value小于或等于指定值的字段。 该接口用于配置谓词以匹配数据类型为ValueType且value小于或等于指定值的字段。
...@@ -586,7 +586,7 @@ dataSharePredicates.lessThanOrEqualTo("AGE", 50) ...@@ -586,7 +586,7 @@ dataSharePredicates.lessThanOrEqualTo("AGE", 50)
## orderByAsc ## orderByAsc
orderByAsc(field: *string*): DataSharePredicates; orderByAsc(field: *string*): DataSharePredicates
该接口用于配置谓词以匹配其值按升序排序的列。 该接口用于配置谓词以匹配其值按升序排序的列。
...@@ -615,7 +615,7 @@ dataSharePredicates.orderByAsc("AGE") ...@@ -615,7 +615,7 @@ dataSharePredicates.orderByAsc("AGE")
## orderByDesc ## orderByDesc
orderByDesc(field: *string*): DataSharePredicates; orderByDesc(field: *string*): DataSharePredicates
该接口用于配置谓词以匹配其值按降序排序的列。 该接口用于配置谓词以匹配其值按降序排序的列。
...@@ -644,7 +644,7 @@ dataSharePredicates.orderByDesc("AGE") ...@@ -644,7 +644,7 @@ dataSharePredicates.orderByDesc("AGE")
## distinct ## distinct
distinct(): DataSharePredicates; distinct(): DataSharePredicates
该接口用于配置谓词以过滤重复记录并仅保留其中一个。目前仅RDB支持该谓词。 该接口用于配置谓词以过滤重复记录并仅保留其中一个。目前仅RDB支持该谓词。
...@@ -665,7 +665,7 @@ dataSharePredicates.equalTo("NAME", "Rose").distinct("NAME") ...@@ -665,7 +665,7 @@ dataSharePredicates.equalTo("NAME", "Rose").distinct("NAME")
## limit ## limit
limit(total: number, offset: number): DataSharePredicates; limit(total: number, offset: number): DataSharePredicates
该接口用于配置谓词以指定结果数和起始位置。 该接口用于配置谓词以指定结果数和起始位置。
...@@ -695,7 +695,7 @@ dataSharePredicates.equalTo("NAME", "Rose").limit(10, 3) ...@@ -695,7 +695,7 @@ dataSharePredicates.equalTo("NAME", "Rose").limit(10, 3)
## groupBy ## groupBy
groupBy(fields: Array<string>): DataSharePredicates; groupBy(fields: Array&lt;string&gt;): DataSharePredicates
该接口用于配置谓词按指定列分组查询结果。目前仅RDB支持该谓词。 该接口用于配置谓词按指定列分组查询结果。目前仅RDB支持该谓词。
...@@ -705,7 +705,7 @@ groupBy(fields: Array<string>): DataSharePredicates; ...@@ -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"]) ...@@ -722,7 +722,7 @@ dataSharePredicates.groupBy(["AGE", "NAME"])
## indexedBy ## indexedBy
indexedBy(field: string): DataSharePredicates; indexedBy(field: string): DataSharePredicates
该接口用于配置谓词以指定索引列。目前仅RDB支持该谓词。 该接口用于配置谓词以指定索引列。目前仅RDB支持该谓词。
...@@ -749,7 +749,7 @@ dataSharePredicates.indexedBy("SALARY_INDEX") ...@@ -749,7 +749,7 @@ dataSharePredicates.indexedBy("SALARY_INDEX")
## in ## in
in(field: string, value: Array<ValueType>): DataSharePredicates; in(field: string, value: Array&lt;ValueType&gt;): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType数组且值在给定范围内的指定字段。 该接口用于配置谓词以匹配数据类型为ValueType数组且值在给定范围内的指定字段。
...@@ -762,7 +762,7 @@ in(field: string, value: Array<ValueType>): DataSharePredicates; ...@@ -762,7 +762,7 @@ in(field: string, value: Array<ValueType>): DataSharePredicates;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------- | ---- | --------------------------------------- | | ------- | ---------------- | ---- | --------------------------------------- |
| field | string | 是 | 数据库表中的列名。 | | 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]) ...@@ -779,7 +779,7 @@ dataSharePredicates.in("AGE", [18, 20])
## notIn ## notIn
notIn(field: string, value: Array<ValueType>): DataSharePredicates; notIn(field: string, value: Array&lt;ValueType&gt;): DataSharePredicates
该接口用于配置谓词以匹配数据类型为ValueType数组且值不在给定范围内的指定字段。 该接口用于配置谓词以匹配数据类型为ValueType数组且值不在给定范围内的指定字段。
...@@ -792,7 +792,7 @@ notIn(field: string, value: Array<ValueType>): DataSharePredicates; ...@@ -792,7 +792,7 @@ notIn(field: string, value: Array<ValueType>): DataSharePredicates;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------- | ---- | --------------------------------------- | | ------- | ---------------- | ---- | --------------------------------------- |
| field | string | 是 | 数据库表中的列名。 | | 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"]) ...@@ -809,7 +809,7 @@ dataSharePredicates.notIn("NAME", ["Lisa", "Rose"])
## prefixKey ## prefixKey
prefixKey(prefix: string): DataSharePredicates; prefixKey(prefix: string): DataSharePredicates
该接口用于配置谓词以匹配键前缀的指定字段。目前仅KVDB支持该谓词。 该接口用于配置谓词以匹配键前缀的指定字段。目前仅KVDB支持该谓词。
...@@ -836,7 +836,7 @@ dataSharePredicates.prefixKey("NAME") ...@@ -836,7 +836,7 @@ dataSharePredicates.prefixKey("NAME")
## inKeys ## inKeys
inKeys(keys: Array<string>): DataSharePredicates; inKeys(keys: Array&lt;string&gt;): DataSharePredicates
该接口用于配置谓词以匹配键在给定范围内的指定字段。目前仅KVDB支持该谓词。 该接口用于配置谓词以匹配键在给定范围内的指定字段。目前仅KVDB支持该谓词。
...@@ -846,7 +846,7 @@ inKeys(keys: Array<string>): DataSharePredicates; ...@@ -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) => { ...@@ -47,14 +47,14 @@ dataShareHelper.query(uri, da, columns).then((data) => {
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| ----------- | ------------- | ---- | ------------------------ | | ----------- | ------------- | ---- | ------------------------ |
| columnNames | Array<string> | 是 | 结果集中所有列的名称。 | | columnNames | Array&lt;string&gt; | 是 | 结果集中所有列的名称。 |
| columnCount | number | 是 | 结果集中的列数。 | | columnCount | number | 是 | 结果集中的列数。 |
| rowCount | number | 是 | 结果集中的行数。 | | rowCount | number | 是 | 结果集中的行数。 |
| isClosed | boolean | 是 | 标志当前结果集是否关闭。 | | isClosed | boolean | 是 | 标志当前结果集是否关闭。 |
## goToFirstRow ## goToFirstRow
goToFirstRow(): boolean; goToFirstRow(): boolean
该接口用于转到结果集的第一行。 该接口用于转到结果集的第一行。
...@@ -77,7 +77,7 @@ console.info('resultSet.goToFirstRow: ' + isGoTOFirstRow); ...@@ -77,7 +77,7 @@ console.info('resultSet.goToFirstRow: ' + isGoTOFirstRow);
## goToLastRow ## goToLastRow
goToLastRow(): boolean; goToLastRow(): boolean
该接口用于转到结果集的最后一行。 该接口用于转到结果集的最后一行。
...@@ -100,7 +100,7 @@ console.info('resultSet.goToLastRow: ' + isGoToLastRow); ...@@ -100,7 +100,7 @@ console.info('resultSet.goToLastRow: ' + isGoToLastRow);
## goToNextRow ## goToNextRow
goToNextRow(): boolean; goToNextRow(): boolean
该接口用于转到结果集的下一行。 该接口用于转到结果集的下一行。
...@@ -123,7 +123,7 @@ console.info('resultSet.goToNextRow: ' + isGoToNextRow); ...@@ -123,7 +123,7 @@ console.info('resultSet.goToNextRow: ' + isGoToNextRow);
## goToPreviousRow ## goToPreviousRow
goToPreviousRow(): boolean; goToPreviousRow(): boolean
该接口用于转到结果集的上一行。 该接口用于转到结果集的上一行。
...@@ -146,7 +146,7 @@ console.info('resultSet.goToPreviousRow: ' + isGoToPreviousRow); ...@@ -146,7 +146,7 @@ console.info('resultSet.goToPreviousRow: ' + isGoToPreviousRow);
## goTo ## goTo
goTo(offset:number): boolean; goTo(offset:number): boolean
该接口用于向前或向后转至结果集的指定行,相对于其当前位置偏移。 该接口用于向前或向后转至结果集的指定行,相对于其当前位置偏移。
...@@ -176,7 +176,7 @@ console.info('resultSet.goTo: ' + isGoTo); ...@@ -176,7 +176,7 @@ console.info('resultSet.goTo: ' + isGoTo);
## goToRow ## goToRow
goToRow(position: number): boolean; goToRow(position: number): boolean
该接口用于转到结果集的指定行。 该接口用于转到结果集的指定行。
...@@ -206,7 +206,7 @@ console.info('resultSet.goToRow: ' + isGoToRow); ...@@ -206,7 +206,7 @@ console.info('resultSet.goToRow: ' + isGoToRow);
## getBlob ## getBlob
getBlob(columnIndex: number): Uint8Array; getBlob(columnIndex: number): Uint8Array
该接口用于以字节数组的形式获取当前行中指定列的值。 该接口用于以字节数组的形式获取当前行中指定列的值。
...@@ -237,7 +237,7 @@ console.info('resultSet.getBlob: ' + getBlob); ...@@ -237,7 +237,7 @@ console.info('resultSet.getBlob: ' + getBlob);
## getString ## getString
getString(columnIndex: number): *string*; getString(columnIndex: number): *string*
该接口用于以字符串形式获取当前行中指定列的值。 该接口用于以字符串形式获取当前行中指定列的值。
...@@ -268,7 +268,7 @@ console.info('resultSet.getString: ' + getString); ...@@ -268,7 +268,7 @@ console.info('resultSet.getString: ' + getString);
## getLong ## getLong
getLong(columnIndex: number): *number*; getLong(columnIndex: number): *number*
该接口用于以Long形式获取当前行中指定列的值。 该接口用于以Long形式获取当前行中指定列的值。
...@@ -299,7 +299,7 @@ console.info('resultSet.getLong: ' + getLong); ...@@ -299,7 +299,7 @@ console.info('resultSet.getLong: ' + getLong);
## getDouble ## getDouble
getDouble(columnIndex: number): *number*; getDouble(columnIndex: number): *number*
该接口用于以double形式获取当前行中指定列的值。 该接口用于以double形式获取当前行中指定列的值。
...@@ -330,7 +330,7 @@ console.info('resultSet.getDouble: ' + getDouble); ...@@ -330,7 +330,7 @@ console.info('resultSet.getDouble: ' + getDouble);
## close ## close
close(): void; close(): void
该接口用于关闭结果集。 该接口用于关闭结果集。
...@@ -344,7 +344,7 @@ resultSet.close(); ...@@ -344,7 +344,7 @@ resultSet.close();
## getColumnIndex ## getColumnIndex
getColumnIndex(columnName: string): *number*; getColumnIndex(columnName: string): *number*
该接口用于根据指定的列名获取列索引。 该接口用于根据指定的列名获取列索引。
...@@ -374,7 +374,7 @@ console.info('resultSet.getColumnIndex: ' + getColumnIndex); ...@@ -374,7 +374,7 @@ console.info('resultSet.getColumnIndex: ' + getColumnIndex);
## getColumnName ## getColumnName
getColumnName(columnIndex: number): *string*; getColumnName(columnIndex: number): *string*
该接口用于根据指定的列索引获取列名。 该接口用于根据指定的列索引获取列名。
...@@ -404,7 +404,7 @@ console.info('resultSet.getColumnName: ' + getColumnName); ...@@ -404,7 +404,7 @@ console.info('resultSet.getColumnName: ' + getColumnName);
## getDataType ## getDataType
getDataType(columnIndex: number): DataType; getDataType(columnIndex: number): DataType
该接口用于获取指定列的数据类型。 该接口用于获取指定列的数据类型。
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册