Merge pull request #29173 from taosdata/docs/fix-node-doc
improve doc format
This commit is contained in:
Linhe Huo
GitHub
commit
5c3f6d8641
|
|
@ -14,19 +14,19 @@ The source code for the Node.js connector is hosted on [GitHub](https://github.c
|
|||
|
||||
## Node.js Version Compatibility
|
||||
|
||||
- Supports Node.js 14 and above.
|
||||
Supports Node.js 14 and above.
|
||||
|
||||
## Supported Platforms
|
||||
|
||||
- Support all platforms that can run Node.js.
|
||||
Support all platforms that can run Node.js.
|
||||
|
||||
## Version History
|
||||
|
||||
| Node.js Connector Version | Major Changes | TDengine Version |
|
||||
| ------------------ | ---------------------- | ----------------|
|
||||
| 3.1.2 | Optimized data protocol and parsing, significantly improved performance.| - |
|
||||
| 3.1.1 | Optimized data transmission performance. | 3.3.2.0 and higher versions |
|
||||
| 3.1.0 | New release, supports WebSocket connection. | 3.2.0.0 and higher versions |
|
||||
| Node.js Connector Version | Major Changes | TDengine Version |
|
||||
| ------------------------- | ------------------------------------------------------------------------ | --------------------------- |
|
||||
| 3.1.2 | Optimized data protocol and parsing, significantly improved performance. | - |
|
||||
| 3.1.1 | Optimized data transmission performance. | 3.3.2.0 and higher versions |
|
||||
| 3.1.0 | New release, supports WebSocket connection. | 3.2.0.0 and higher versions |
|
||||
|
||||
## Exception Handling
|
||||
|
||||
|
|
@ -36,19 +36,19 @@ Error description: Node.js connector error codes range from 100 to 110, errors o
|
|||
|
||||
For specific connector error codes, please refer to:
|
||||
|
||||
| Error Code | Description | Suggested Actions |
|
||||
| ---------- | -------------------------------------------------------------| ----------------------------------------------------------------------------------------- |
|
||||
| 100 | invalid variables | The parameters are illegal, please check the corresponding interface specifications and adjust the parameter types and sizes. |
|
||||
| 101 | invalid url | URL error, please check if the URL is correctly filled. |
|
||||
| 102 | received server data but did not find a callback for processing | Received server data but no upper layer callback was found |
|
||||
| 103 | invalid message type | Received message type unrecognized, please check if the server is normal. |
|
||||
| 104 | connection creation failed | Connection creation failed, please check if the network is normal. |
|
||||
| 105 | websocket request timeout | Request timed out |
|
||||
| 106 | authentication fail | Authentication failed, please check if the username and password are correct. |
|
||||
| 107 | unknown sql type in tdengine | Please check the Data Type types supported by TDengine. |
|
||||
| 108 | connection has been closed | The connection has been closed, please check if the Connection is used again after closing, or if the connection is normal. |
|
||||
| 109 | fetch block data parse fail | Failed to parse the fetched query data |
|
||||
| 110 | websocket connection has reached its maximum limit | WebSocket connection has reached its maximum limit |
|
||||
| Error Code | Description | Suggested Actions |
|
||||
| ---------- | --------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
|
||||
| 100 | invalid variables | The parameters are illegal, please check the corresponding interface specifications and adjust the parameter types and sizes. |
|
||||
| 101 | invalid url | URL error, please check if the URL is correctly filled. |
|
||||
| 102 | received server data but did not find a callback for processing | Received server data but no upper layer callback was found |
|
||||
| 103 | invalid message type | Received message type unrecognized, please check if the server is normal. |
|
||||
| 104 | connection creation failed | Connection creation failed, please check if the network is normal. |
|
||||
| 105 | websocket request timeout | Request timed out |
|
||||
| 106 | authentication fail | Authentication failed, please check if the username and password are correct. |
|
||||
| 107 | unknown sql type in tdengine | Please check the Data Type types supported by TDengine. |
|
||||
| 108 | connection has been closed | The connection has been closed, please check if the Connection is used again after closing, or if the connection is normal. |
|
||||
| 109 | fetch block data parse fail | Failed to parse the fetched query data |
|
||||
| 110 | websocket connection has reached its maximum limit | WebSocket connection has reached its maximum limit |
|
||||
|
||||
- [TDengine Node.js Connector Error Code](https://github.com/taosdata/taos-connector-node/blob/main/nodejs/src/common/wsError.ts)
|
||||
- For errors from other TDengine modules, please refer to [Error Codes](../../error-codes/)
|
||||
|
|
@ -57,38 +57,38 @@ For specific connector error codes, please refer to:
|
|||
|
||||
The table below shows the mapping between TDengine DataType and Node.js DataType
|
||||
|
||||
| TDengine DataType | Node.js DataType|
|
||||
|-------------------|-------------|
|
||||
| TIMESTAMP | bigint |
|
||||
| TINYINT | number |
|
||||
| SMALLINT | number |
|
||||
| INT | number |
|
||||
| BIGINT | bigint |
|
||||
| TINYINT UNSIGNED | number |
|
||||
| SMALLINT UNSIGNED | number |
|
||||
| INT UNSIGNED | number |
|
||||
| BIGINT UNSIGNED | bigint |
|
||||
| FLOAT | number |
|
||||
| DOUBLE | number |
|
||||
| BOOL | boolean |
|
||||
| BINARY | string |
|
||||
| NCHAR | string |
|
||||
| JSON | string |
|
||||
| VARBINARY | ArrayBuffer |
|
||||
| GEOMETRY | ArrayBuffer |
|
||||
| TDengine DataType | Node.js DataType |
|
||||
| ----------------- | ---------------- |
|
||||
| TIMESTAMP | bigint |
|
||||
| TINYINT | number |
|
||||
| SMALLINT | number |
|
||||
| INT | number |
|
||||
| BIGINT | bigint |
|
||||
| TINYINT UNSIGNED | number |
|
||||
| SMALLINT UNSIGNED | number |
|
||||
| INT UNSIGNED | number |
|
||||
| BIGINT UNSIGNED | bigint |
|
||||
| FLOAT | number |
|
||||
| DOUBLE | number |
|
||||
| BOOL | boolean |
|
||||
| BINARY | string |
|
||||
| NCHAR | string |
|
||||
| JSON | string |
|
||||
| VARBINARY | ArrayBuffer |
|
||||
| GEOMETRY | ArrayBuffer |
|
||||
|
||||
**Note**: JSON type is only supported in tags.
|
||||
|
||||
## More Example Programs
|
||||
|
||||
| Example Program | Description of Example Program |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------- |
|
||||
| [sql_example](https://github.com/taosdata/TDengine/tree/main/docs/examples/node/websocketexample/sql_example.js) | Basic usage such as establishing connections, executing SQL, etc. |
|
||||
| [stmt_example](https://github.com/taosdata/TDengine/tree/main/docs/examples/node/websocketexample/stmt_example.js) | Example of binding parameters for insertion. |
|
||||
| [line_example](https://github.com/taosdata/TDengine/tree/main/docs/examples/node/websocketexample/line_example.js) | Line protocol writing example. |
|
||||
| [tmq_example](https://github.com/taosdata/TDengine/tree/main/docs/examples/node/websocketexample/tmq_example.js) | Example of using subscriptions. |
|
||||
| [all_type_query](https://github.com/taosdata/TDengine/tree/main/docs/examples/node/websocketexample/all_type_query.js) | Example supporting all types. |
|
||||
| [all_type_stmt](https://github.com/taosdata/TDengine/tree/main/docs/examples/node/websocketexample/all_type_stmt.js) | Example of parameter binding supporting all types. |
|
||||
| Example Program | Description of Example Program |
|
||||
| ---------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
|
||||
| [sql_example](https://github.com/taosdata/TDengine/tree/main/docs/examples/node/websocketexample/sql_example.js) | Basic usage such as establishing connections, executing SQL, etc. |
|
||||
| [stmt_example](https://github.com/taosdata/TDengine/tree/main/docs/examples/node/websocketexample/stmt_example.js) | Example of binding parameters for insertion. |
|
||||
| [line_example](https://github.com/taosdata/TDengine/tree/main/docs/examples/node/websocketexample/line_example.js) | Line protocol writing example. |
|
||||
| [tmq_example](https://github.com/taosdata/TDengine/tree/main/docs/examples/node/websocketexample/tmq_example.js) | Example of using subscriptions. |
|
||||
| [all_type_query](https://github.com/taosdata/TDengine/tree/main/docs/examples/node/websocketexample/all_type_query.js) | Example supporting all types. |
|
||||
| [all_type_stmt](https://github.com/taosdata/TDengine/tree/main/docs/examples/node/websocketexample/all_type_stmt.js) | Example of parameter binding supporting all types. |
|
||||
|
||||
## Usage Restrictions
|
||||
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ TDengine ODBC provides both 64-bit and 32-bit drivers. However, the 32-bit versi
|
|||
|
||||
## ODBC Version Compatibility
|
||||
|
||||
- Supports all ODBC versions.
|
||||
Supports all ODBC versions.
|
||||
|
||||
## Installation
|
||||
|
||||
|
|
|
|||
|
|
@ -13,11 +13,11 @@ Node.js 连接器源码托管在 [GitHub](https://github.com/taosdata/taos-conne
|
|||
|
||||
## Node.js 版本兼容性
|
||||
|
||||
- 支持 Node.js 14 及以上版本。
|
||||
支持 Node.js 14 及以上版本。
|
||||
|
||||
## 支持的平台
|
||||
|
||||
- 支持所有能运行 Node.js 的平台。
|
||||
支持所有能运行 Node.js 的平台。
|
||||
|
||||
|
||||
## 版本历史
|
||||
|
|
|
|||
|
|
@ -15,7 +15,8 @@ TDengine ODBC 提供 64 位 和 32 位 两种驱动程序。但 32 位仅企业
|
|||
想更多了解 TDengine 时序时序数据库的使用，可访问 [TDengine官方文档](https://docs.taosdata.com/intro/)。
|
||||
|
||||
## ODBC 版本兼容性
|
||||
- 支持 ODBC 所有版本
|
||||
|
||||
支持 ODBC 所有版本
|
||||
|
||||
## 安装
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue