提交 30bd6062 编写于 作者: A Annie_wang

update docs

Signed-off-by: NAnnie_wang <annie.wangli@huawei.com>
上级 350ebfae
...@@ -2,9 +2,11 @@ ...@@ -2,9 +2,11 @@
The **DataShareResultSet** module provides APIs for accessing the result set obtained from the database. You can access the values in the specified rows or the value of the specified data type. The **DataShareResultSet** module provides APIs for accessing the result set obtained from the database. You can access the values in the specified rows or the value of the specified data type.
>**NOTE** > **NOTE**
> >
>The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. > The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.
>
> The APIs provided by this module are system APIs.
## Modules to Import ## Modules to Import
...@@ -44,7 +46,10 @@ dataShareHelper.query(uri, da, columns).then((data) => { ...@@ -44,7 +46,10 @@ dataShareHelper.query(uri, da, columns).then((data) => {
}); });
``` ```
## Attributes ## DataShareResultSet
Provides methods for accessing the result sets generated by querying the database.
### Attributes
**System capability**: SystemCapability.DistributedDataManager.DataShare.Core **System capability**: SystemCapability.DistributedDataManager.DataShare.Core
...@@ -55,7 +60,7 @@ dataShareHelper.query(uri, da, columns).then((data) => { ...@@ -55,7 +60,7 @@ dataShareHelper.query(uri, da, columns).then((data) => {
| rowCount | number | Yes | Number of rows in the result set. | | rowCount | number | Yes | Number of rows in the result set. |
| isClosed | boolean | Yes | Whether the result set is closed.| | isClosed | boolean | Yes | Whether the result set is closed.|
## goToFirstRow ### goToFirstRow
goToFirstRow(): boolean goToFirstRow(): boolean
...@@ -76,7 +81,7 @@ let isGoTOFirstRow = resultSet.goToFirstRow(); ...@@ -76,7 +81,7 @@ let isGoTOFirstRow = resultSet.goToFirstRow();
console.info('resultSet.goToFirstRow: ' + isGoTOFirstRow); console.info('resultSet.goToFirstRow: ' + isGoTOFirstRow);
``` ```
## goToLastRow ### goToLastRow
goToLastRow(): boolean goToLastRow(): boolean
...@@ -97,7 +102,7 @@ let isGoToLastRow = resultSet.goToLastRow(); ...@@ -97,7 +102,7 @@ let isGoToLastRow = resultSet.goToLastRow();
console.info('resultSet.goToLastRow: ' + isGoToLastRow); console.info('resultSet.goToLastRow: ' + isGoToLastRow);
``` ```
## goToNextRow ### goToNextRow
goToNextRow(): boolean goToNextRow(): boolean
...@@ -118,7 +123,7 @@ let isGoToNextRow = resultSet.goToNextRow(); ...@@ -118,7 +123,7 @@ let isGoToNextRow = resultSet.goToNextRow();
console.info('resultSet.goToNextRow: ' + isGoToNextRow); console.info('resultSet.goToNextRow: ' + isGoToNextRow);
``` ```
## goToPreviousRow ### goToPreviousRow
goToPreviousRow(): boolean goToPreviousRow(): boolean
...@@ -139,7 +144,7 @@ let isGoToPreviousRow = resultSet.goToPreviousRow(); ...@@ -139,7 +144,7 @@ let isGoToPreviousRow = resultSet.goToPreviousRow();
console.info('resultSet.goToPreviousRow: ' + isGoToPreviousRow); console.info('resultSet.goToPreviousRow: ' + isGoToPreviousRow);
``` ```
## goTo ### goTo
goTo(offset:number): boolean goTo(offset:number): boolean
...@@ -167,7 +172,7 @@ let isGoTo = resultSet.goTo(goToNum); ...@@ -167,7 +172,7 @@ let isGoTo = resultSet.goTo(goToNum);
console.info('resultSet.goTo: ' + isGoTo); console.info('resultSet.goTo: ' + isGoTo);
``` ```
## goToRow ### goToRow
goToRow(position: number): boolean goToRow(position: number): boolean
...@@ -195,7 +200,7 @@ let isGoToRow = resultSet.goToRow(goToRowNum); ...@@ -195,7 +200,7 @@ let isGoToRow = resultSet.goToRow(goToRowNum);
console.info('resultSet.goToRow: ' + isGoToRow); console.info('resultSet.goToRow: ' + isGoToRow);
``` ```
## getBlob ### getBlob
getBlob(columnIndex: number): Uint8Array getBlob(columnIndex: number): Uint8Array
...@@ -224,7 +229,7 @@ let getBlob = resultSet.getBlob(columnIndex); ...@@ -224,7 +229,7 @@ let getBlob = resultSet.getBlob(columnIndex);
console.info('resultSet.getBlob: ' + getBlob); console.info('resultSet.getBlob: ' + getBlob);
``` ```
## getString ### getString
getString(columnIndex: number): *string* getString(columnIndex: number): *string*
...@@ -253,7 +258,7 @@ let getString = resultSet.getString(columnIndex); ...@@ -253,7 +258,7 @@ let getString = resultSet.getString(columnIndex);
console.info('resultSet.getString: ' + getString); console.info('resultSet.getString: ' + getString);
``` ```
## getLong ### getLong
getLong(columnIndex: number): number getLong(columnIndex: number): number
...@@ -282,7 +287,7 @@ let getLong = resultSet.getLong(columnIndex); ...@@ -282,7 +287,7 @@ let getLong = resultSet.getLong(columnIndex);
console.info('resultSet.getLong: ' + getLong); console.info('resultSet.getLong: ' + getLong);
``` ```
## getDouble ### getDouble
getDouble(columnIndex: number): number getDouble(columnIndex: number): number
...@@ -311,7 +316,7 @@ let getDouble = resultSet.getDouble(columnIndex); ...@@ -311,7 +316,7 @@ let getDouble = resultSet.getDouble(columnIndex);
console.info('resultSet.getDouble: ' + getDouble); console.info('resultSet.getDouble: ' + getDouble);
``` ```
## close ### close
close(): void close(): void
...@@ -325,7 +330,7 @@ Closes this result set. ...@@ -325,7 +330,7 @@ Closes this result set.
resultSet.close(); resultSet.close();
``` ```
## getColumnIndex ### getColumnIndex
getColumnIndex(columnName: string): number getColumnIndex(columnName: string): number
...@@ -353,7 +358,7 @@ let getColumnIndex = resultSet.getColumnIndex(ColumnName) ...@@ -353,7 +358,7 @@ let getColumnIndex = resultSet.getColumnIndex(ColumnName)
console.info('resultSet.getColumnIndex: ' + getColumnIndex); console.info('resultSet.getColumnIndex: ' + getColumnIndex);
``` ```
## getColumnName ### getColumnName
getColumnName(columnIndex: number): *string* getColumnName(columnIndex: number): *string*
...@@ -381,7 +386,7 @@ let getColumnName = resultSet.getColumnName(columnIndex) ...@@ -381,7 +386,7 @@ let getColumnName = resultSet.getColumnName(columnIndex)
console.info('resultSet.getColumnName: ' + getColumnName); 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.
先完成此消息的编辑!
想要评论请 注册