未验证 提交 dce545f7 编写于 作者: O openharmony_ci 提交者: Gitee

!1136 【RDB】增加querySql接口描述

Merge pull request !1136 from MangTsang/master
...@@ -1057,7 +1057,7 @@ query(rdbPredicates: RdbPredicates, columns: Array<string>, callback: Asyn ...@@ -1057,7 +1057,7 @@ query(rdbPredicates: RdbPredicates, columns: Array<string>, callback: Asyn
### query ### query
query(rdbPredicates: RdbPredicates, columns: Array<string>):Promise<ResultSet> query(rdbPredicates: RdbPredicates, columns?: Array<string>):Promise<ResultSet>
根据指定条件查询数据库中的数据,结果以Promise形式返回。 根据指定条件查询数据库中的数据,结果以Promise形式返回。
...@@ -1065,7 +1065,7 @@ query(rdbPredicates: RdbPredicates, columns: Array<string>):Promise<Res ...@@ -1065,7 +1065,7 @@ query(rdbPredicates: RdbPredicates, columns: Array<string>):Promise<Res
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | 表示rdbPredicates的实例对象指定的查询条件。 | | rdbPredicates | [RdbPredicates](#rdbpredicates) | 是 | 表示rdbPredicates的实例对象指定的查询条件。 |
| columns | Array<string> | | 表示要查询的列。如果值为空,则查询应用于所有列。 | | columns | Array<string> | | 表示要查询的列。如果值为空,则查询应用于所有列。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
...@@ -1083,6 +1083,53 @@ query(rdbPredicates: RdbPredicates, columns: Array<string>):Promise<Res ...@@ -1083,6 +1083,53 @@ query(rdbPredicates: RdbPredicates, columns: Array<string>):Promise<Res
``` ```
### querySql<sup>8+</sup>
querySql(sql: string, bindArgs: Array&lt;ValueType&gt;, callback: AsyncCallback&lt;ResultSet&gt;):void
根据指定SQL语句查询数据库中的数据,结果以callback形式返回。
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| sql | string | 是 | 指定要执行的SQL语句。 |
| bindArgs | Array&lt;[ValueType](#valuetype)&gt; | 是 | SQL语句中参数的值。 |
| callback | AsyncCallback&lt;[ResultSet](js-apis-data-resultset.md)&gt; | 是 | 指定callback回调函数。如果操作成功,则返回ResultSet对象。 |
- 示例:
```
rdbStore.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo'], function (err, resultSet) {
console.log(TAG + "resultSet column names:" + resultSet.columnNames)
console.log(TAG + "resultSet column count:" + resultSet.columnCount)})
```
### querySql<sup>8+</sup>
querySql(sql: string, bindArgs?: Array&lt;ValueType&gt;):Promise&lt;ResultSet&gt;
根据指定SQL语句查询数据库中的数据,结果以Promise形式返回。
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| sql | string | 是 | 指定要执行的SQL语句。 |
| bindArgs | Array&lt;[ValueType](#valuetype)&gt; | 否 | SQL语句中参数的值。 |
- 返回值:
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;[ResultSet](../apis/js-apis-data-resultset.md)&gt; | 指定Promise回调函数。如果操作成功,则返回ResultSet对象。 |
- 示例:
```
let promise = rdbStore.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo'])
promise.then((resultSet) => {
console.log(TAG + "resultSet column names:" + resultSet.columnNames)
console.log(TAG + "resultSet column count:" + resultSet.columnCount)})
```
### executeSql ### executeSql
executeSql(sql: string, bindArgs: Array&lt;ValueType&gt;, callback: AsyncCallback&lt;void&gt;):void executeSql(sql: string, bindArgs: Array&lt;ValueType&gt;, callback: AsyncCallback&lt;void&gt;):void
...@@ -1098,14 +1145,14 @@ executeSql(sql: string, bindArgs: Array&lt;ValueType&gt;, callback: AsyncCallbac ...@@ -1098,14 +1145,14 @@ executeSql(sql: string, bindArgs: Array&lt;ValueType&gt;, callback: AsyncCallbac
- 示例: - 示例:
``` ```
rdbStore.executeSql("DELETE FROM EMPLOYEE", function () { rdbStore.executeSql("DELETE FROM EMPLOYEE", null, function () {
console.info(TAG + 'delete done.')}) console.info(TAG + 'delete done.')})
``` ```
### executeSql ### executeSql
executeSql(sql: string, bindArgs: Array&lt;ValueType&gt;):Promise&lt;void&gt; executeSql(sql: string, bindArgs?: Array&lt;ValueType&gt;):Promise&lt;void&gt;
执行包含指定参数但不返回值的SQL语句,结果以Promise形式返回。 执行包含指定参数但不返回值的SQL语句,结果以Promise形式返回。
...@@ -1113,7 +1160,7 @@ executeSql(sql: string, bindArgs: Array&lt;ValueType&gt;):Promise&lt;void&gt; ...@@ -1113,7 +1160,7 @@ executeSql(sql: string, bindArgs: Array&lt;ValueType&gt;):Promise&lt;void&gt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| sql | string | 是 | 指定要执行的SQL语句。 | | sql | string | 是 | 指定要执行的SQL语句。 |
| bindArgs | Array&lt;[ValueType](#valuetype)&gt; | | SQL语句中参数的值。 | | bindArgs | Array&lt;[ValueType](#valuetype)&gt; | | SQL语句中参数的值。 |
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册