diff --git a/docs-cn/14-reference/03-connector/node.mdx b/docs-cn/14-reference/03-connector/node.mdx index 688464eb35bdda1c0889047152349fa8bcc3735e..2aa748104be271ec2cf0ec29c09d911dc0895b65 100644 --- a/docs-cn/14-reference/03-connector/node.mdx +++ b/docs-cn/14-reference/03-connector/node.mdx @@ -5,16 +5,16 @@ sidebar_label: Node.js title: Node.js Connector --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; -import Preparition from "./_preparition.mdx" -import NodeInsert from "../../04-develop/03-insert-data/_js_sql.mdx" -import NodeInfluxLine from "../../04-develop/03-insert-data/_js_line.mdx" -import NodeOpenTSDBTelnet from "../../04-develop/03-insert-data/_js_opts_telnet.mdx" -import NodeOpenTSDBJson from "../../04-develop/03-insert-data/_js_opts_json.mdx" -import NodeQuery from "../../04-develop/04-query-data/_js.mdx" -import NodeAsyncQuery from "../../04-develop/04-query-data/_js_async.mdx" +import Preparition from "./_preparition.mdx"; +import NodeInsert from "../../04-develop/03-insert-data/_js_sql.mdx"; +import NodeInfluxLine from "../../04-develop/03-insert-data/_js_line.mdx"; +import NodeOpenTSDBTelnet from "../../04-develop/03-insert-data/_js_opts_telnet.mdx"; +import NodeOpenTSDBJson from "../../04-develop/03-insert-data/_js_opts_json.mdx"; +import NodeQuery from "../../04-develop/04-query-data/_js.mdx"; +import NodeAsyncQuery from "../../04-develop/04-query-data/_js_async.mdx"; `td2.0-connector` 是 TDengine 的官方 Node.js 语言连接器。Node.js 开发人员可以通过它开发可以存取 TDengine 集群数据的应用软件。 @@ -55,11 +55,11 @@ import NodeAsyncQuery from "../../04-develop/04-query-data/_js_async.mdx" ### 安装前准备 -* 安装 Node.js 开发环境 - +- 安装 Node.js 开发环境 + -- 应用驱动安装请参考[安装连接器驱动步骤](/reference/connector/#安装客户端驱动)。 -我们使用 [node-gyp](https://github.com/nodejs/node-gyp) 和 TDengine 集群进行交互。安装 Node.js 连接器之前，还需要根据具体操作系统来安装下文提到的一些依赖工具。如果要安装的是 REST 连接器则可以跳过以下步骤，直接只用 npm 安装。 +* 应用驱动安装请参考[安装连接器驱动步骤](/reference/connector/#安装客户端驱动)。 + 我们使用 [node-gyp](https://github.com/nodejs/node-gyp) 和 TDengine 集群进行交互。安装 Node.js 连接器之前，还需要根据具体操作系统来安装下文提到的一些依赖工具。如果要安装的是 REST 连接器则可以跳过以下步骤，直接只用 npm 安装。 @@ -87,6 +87,7 @@ import NodeAsyncQuery from "../../04-develop/04-query-data/_js_async.mdx" 参考微软的 Node.js 用户手册[ Microsoft's Node.js Guidelines for Windows](https://github.com/Microsoft/nodejs-guidelines/blob/master/windows-environment.md#compiling-native-addon-modules)。 如果在 Windows 10 ARM 上使用 ARM64 Node.js，还需添加 "Visual C++ compilers and libraries for ARM64" 和 "Visual C++ ATL for ARM64"。 + @@ -95,7 +96,7 @@ import NodeAsyncQuery from "../../04-develop/04-query-data/_js_async.mdx" -``` bash +```bash npm install td2.0-connector ``` @@ -105,6 +106,7 @@ npm install td2.0-connector ```bash npm i td2.0-rest-connector ``` + @@ -135,8 +137,14 @@ node nodejsChecker.js host=localhost ```javascript //A cursor also needs to be initialized in order to interact with TDengine from Node.js. -const taos = require('td2.0-connector'); -var conn = taos.connect({host:"127.0.0.1", user:"root", password:"taosdata", config:"/etc/taos",port:0}) +const taos = require("td2.0-connector"); +var conn = taos.connect({ + host: "127.0.0.1", + user: "root", + password: "taosdata", + config: "/etc/taos", + port: 0, +}); var cursor = conn.cursor(); // Initializing a new cursor //Close a connection @@ -148,18 +156,18 @@ conn.close(); 安装并引用 `td2.0-rest-connector` 包。 -``` javascript +```javascript //A cursor also needs to be initialized in order to interact with TDengine from Node.js. -import { options, connect } from 'td2.0-rest-connector' -options.path='/rest/sqlt'; +import { options, connect } from "td2.0-rest-connector"; +options.path = "/rest/sqlt"; // set host -options.host='localhost'; +options.host = "localhost"; // set other options like user/passwd let conn = connect(options); let cursor = conn.cursor(); - ``` + @@ -195,20 +203,20 @@ let cursor = conn.cursor(); ## 更多示例程序 -| 示例程序 | 示例程序描述 | -|-----------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------| -| [connection](https://github.com/taosdata/TDengine/blob/develop/src/connector/nodejs/examples/cursorClose.js) | 建立连接的示例。 | -| [stmtBindBatch](https://github.com/taosdata/TDengine/blob/develop/src/connector/nodejs/examples/stmtBindParamBatchSample.js) | 绑定多行参数插入的示例。 | -| [stmtBind](https://github.com/taosdata/TDengine/blob/develop/src/connector/nodejs/examples/stmtBindParamSample.js) | 一行一行绑定参数插入的示例。 | -| [stmtBindSingleParamBatch](https://github.com/taosdata/TDengine/blob/develop/src/connector/nodejs/examples/stmtBindSingleParamBatchSample.js) | 按列绑定参数插入的示例。 | -| [stmtUseResult](https://github.com/taosdata/TDengine/blob/develop/src/connector/nodejs/examples/stmtUseResultSample.js) | 绑定参数查询的示例。 | -| [json tag](https://github.com/taosdata/TDengine/blob/develop/src/connector/nodejs/examples/testJsonTag.js) | Json tag 的使用示例。 | -| [Nanosecond](https://github.com/taosdata/TDengine/blob/develop/src/connector/nodejs/examples/testNanoseconds.js) | 时间戳为纳秒精度的使用的示例。 | -| [Microsecond](https://github.com/taosdata/TDengine/blob/develop/src/connector/nodejs/examples/testMicroseconds.js) | 时间戳为微秒精度的使用的示例。 | -| [schemless insert](https://github.com/taosdata/TDengine/blob/develop/src/connector/nodejs/examples/testSchemalessInsert.js) | schemless 插入的示例。 | -| [subscribe](https://github.com/taosdata/TDengine/blob/develop/src/connector/nodejs/examples/testSubscribe.js) | 订阅的使用示例。 | -| [asyncQuery](https://github.com/taosdata/TDengine/blob/develop/src/connector/nodejs/examples/tset.js) | 异步查询的使用示例。 | -| [REST](https://github.com/taosdata/TDengine/tree/develop/src/connector/TypeScript-REST/example) | 使用 REST 连接的 TypeScript 使用示例。| +| 示例程序 | 示例程序描述 | +| --------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | +| [connection](https://github.com/taosdata/TDengine/blob/develop/src/connector/nodejs/examples/cursorClose.js) | 建立连接的示例。 | +| [stmtBindBatch](https://github.com/taosdata/TDengine/blob/develop/src/connector/nodejs/examples/stmtBindParamBatchSample.js) | 绑定多行参数插入的示例。 | +| [stmtBind](https://github.com/taosdata/TDengine/blob/develop/src/connector/nodejs/examples/stmtBindParamSample.js) | 一行一行绑定参数插入的示例。 | +| [stmtBindSingleParamBatch](https://github.com/taosdata/TDengine/blob/develop/src/connector/nodejs/examples/stmtBindSingleParamBatchSample.js) | 按列绑定参数插入的示例。 | +| [stmtUseResult](https://github.com/taosdata/TDengine/blob/develop/src/connector/nodejs/examples/stmtUseResultSample.js) | 绑定参数查询的示例。 | +| [json tag](https://github.com/taosdata/TDengine/blob/develop/src/connector/nodejs/examples/testJsonTag.js) | Json tag 的使用示例。 | +| [Nanosecond](https://github.com/taosdata/TDengine/blob/develop/src/connector/nodejs/examples/testNanoseconds.js) | 时间戳为纳秒精度的使用的示例。 | +| [Microsecond](https://github.com/taosdata/TDengine/blob/develop/src/connector/nodejs/examples/testMicroseconds.js) | 时间戳为微秒精度的使用的示例。 | +| [schemless insert](https://github.com/taosdata/TDengine/blob/develop/src/connector/nodejs/examples/testSchemalessInsert.js) | schemless 插入的示例。 | +| [subscribe](https://github.com/taosdata/TDengine/blob/develop/src/connector/nodejs/examples/testSubscribe.js) | 订阅的使用示例。 | +| [asyncQuery](https://github.com/taosdata/TDengine/blob/develop/src/connector/nodejs/examples/tset.js) | 异步查询的使用示例。 | +| [REST](https://github.com/taosdata/TDengine/tree/develop/src/connector/TypeScript-REST/example) | 使用 REST 连接的 TypeScript 使用示例。 | ## 使用限制 @@ -222,7 +230,7 @@ Node.js 连接器的使用参见[视频教程](https://www.taosdata.com/blog/202 1. 使用 REST 连接需要启动 taosadapter。 - ``` bash + ```bash sudo systemctl start taosadapter ``` @@ -234,17 +242,17 @@ Node.js 连接器的使用参见[视频教程](https://www.taosdata.com/blog/202 ### 原生接口连接器 -| td2.0-connector 版本 | 说明 | -|--------------------|---------------------------------------------------------------------| -| 2.0.10 | 支持连接管理，同步查询、异步查询、获取系统信息、错误信息、订阅功能。| -| 2.0.11 | 支持绑定参数、json tag、schemaless insert。 | -| 2.0.12 | 修复 cursor.close() 报错的问题。 | +| td2.0-connector 版本 | 说明 | +| -------------------- | -------------------------------------------------------------------- | +| 2.0.10 | 支持连接管理，同步查询、异步查询、获取系统信息、错误信息、订阅功能。 | +| 2.0.11 | 支持绑定参数、json tag、schemaless insert。 | +| 2.0.12 | 修复 cursor.close() 报错的问题。 | ### REST 接口连接器 | td2.0-rest-connector 版本 | 说明 | -|--------------------|---------------------------------------------------------------------| -| 1.0.3 | 支持连接管理、同步查询、获取系统信息、错误信息、schemeless。 | +| ------------------------- | ------------------------------------------------------------ | +| 1.0.3 | 支持连接管理、同步查询、获取系统信息、错误信息、schemeless。 | ## API 参考