未验证 提交 f1009b95 编写于 作者: X xiaolei li 提交者: GitHub

docs: Node.js add RESTful docs (#11427)

* docs:doc-cn Node.js add RESTful docs

* docs:doc-cn add Node.js RESTful docs

* docs:docs-cn fix C# invalid hyperlink

* docs:docs-cn node add restful docs fix format

* docs:docs-cn node add restful docs fix with comment
上级 ec55a752
......@@ -63,8 +63,7 @@ dotnet run -- -h <FQDN>. // 此步骤会先build,然后再运行。
```cs
using TDengineDriver;
```
- 用户可以参考[TDengineTest.cs](https://github.com/taosdata/TDengine/tree/develop/examples/C%2523/TDengineTest)来定义数据库连接参数,以及如何执行数据插入、查询等操作。
- 用户可以参考[TDengineTest.cs](https://github.com/taosdata/TDengine/tree/develop/examples/C%23/TDengineTest)来定义数据库连接参数,以及如何执行数据插入、查询等操作。
:::note
......
......@@ -201,3 +201,62 @@ promise2.then(function (result) {
[node-example-raw.js](https://github.com/taosdata/tests/tree/master/examples/nodejs/node-example-raw.js)同样是一个使用 NodeJS 连接器建表,插入天气数据并查询插入的数据的代码示例,但和上面不同的是,该示例只使用`cursor`。
[所有示例代码](https://github.com/taosdata/TDengine/tree/develop/src/connector/nodejs/examples)
## 使用 RESTful 连接器
TDengine 还提供 TypeScript 的 RESTful 连接器。
注意:`td2.0-rest-connector` 依赖 [node-fetch v2](https://github.com/node-fetch/node-fetch/tree/2.x) 。
### RESTful 连接器的使用
* 安装连接器
```bash
npm i td2.0-rest-connector
```
* 引用连接器
``` TypeScript
import { options, connect } from 'td2.0-rest-connector'
options.path='/rest/sqlt';
// 设置HOST
options.host='localhost';
// 设置其他的属性例如:用户名/密码
let conn = connect(options);
let cursor = conn.cursor();
(async()=>{
let result = await cursor.query('show databases');
// 打印查询结果
result.toString();
})()
```
### RESTful 常用方法
``` javascript
// restult 是 Result 对象,即执行查询命令后返回的对象。
// 获取执行结果对象
result.getResult()
// 获得执行状态,返回 'succ'|'error'.
result.getStatus()
// 获得返回结果的头,返回 Array<any>|undefined (当执行 SQL 语句失败时返回 undefined)。
result.getHead()
// 获得返回结果的元数据, 返回 Meta[]|undefined(当执行 SQL 语句失败时返回 undefined)。
result.getMeta()
// 获得返回结果的数据,返回 Array<Array<any>>|undefined(当执行 SQL 语句失败时返回 undefined)。
result.getData()
// 获得执行命令影响的行数,返回 number|undefined(当执行 SQL 语句失败时返回 undefined)。
result.getAffectRows()
// 获得执行的命令,返回 string(需要在 `query(sql,false)` 中设置 'pure=false',默认为 true)。
result.getCommand()
// 获得执行的命令的错误码,返回 number|undefined(当执行 SQL 语句失败时返回 undefined)。
result.getErrCode()
// 获得执行的命令的错误信息,返回 string|undefined(当执行 SQL 语句失败时返回 undefined)。
result.getErrStr()
```
### 示例程序
更多示例参考 [TypeScript REST connector](https://github.com/taosdata/TDengine/tree/develop/src/connector/TypeScript-REST)。
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册