Skip to content

T
TDengine

taosdata / TDengine
接近 2 年 前同步成功

通知 1191
Star 22018
Fork 4786
T
TDengine
未验证 提交 a68e68ee 编写于 作者: sangshuduo's avatar sangshuduo 提交者： GitHub
浏览文件
操作

docs: connector refine (#11781) 

* docs: refine connector doc

[TD-14839]

* docs: use TDengine CLI

[TD-14839]

* docs: replace JNI with navtive connection

[TD-14839]

* docs: make connectors doc use same preparition

[TD-14839]

* docs: refine connectors doc

[TD-14839]
上级 fc556d83
隐藏空白更改
内联 并排
Showing with 52 addition and 68 deletion
docs-cn/14-reference/03-connector/03-connector.mdx
浏览文件 @ a68e68ee
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
title: 连接器 title: 连接器
--- ---
TDengine 提供了丰富的应用程序开发接口，其中官方连接器包括支持 C/C++、Java、Python、Go、Node.js、C# 等多种语言的连接器，支持使用原生接口（taosc）连接和 REST 接口（部分语言暂不支持）连接 TDengine 服务端，便于用户快速开发自己的应用。社区开发者也开发了其他语言的非官方连接器，例如 Lua 和 PHP 连接器。 TDengine 提供了丰富的应用程序开发接口，其中官方连接器包括支持 C/C++、Java、Python、Go、Node.js、C# 等多种语言的连接器，支持使用原生接口（taosc）连接和 REST 接口（部分语言暂不支持）连接 TDengine 数据库，便于用户快速开发自己的应用。社区开发者也开发了多种非官方连接器，例如 Lua 连接器和 PHP 连接器。
![image-connector](/img/connector.png) ![image-connector](/img/connector.png)
...@@ -26,7 +26,7 @@ TDengine 提供了丰富的应用程序开发接口，其中官方连接器包 ...@@ -26,7 +26,7 @@ TDengine 提供了丰富的应用程序开发接口，其中官方连接器包
使用 REST 接口连接由于不依赖原生接口可以支持更广泛的操作系统。 使用 REST 接口连接由于不依赖原生接口可以支持更广泛的操作系统。
## 特性矩阵 ## 功能特性矩阵
连接器对 TDengine 功能特性的支持对照矩阵如下[1]： 连接器对 TDengine 功能特性的支持对照矩阵如下[1]：
...@@ -38,24 +38,20 @@ TDengine 提供了丰富的应用程序开发接口，其中官方连接器包 ...@@ -38,24 +38,20 @@ TDengine 提供了丰富的应用程序开发接口，其中官方连接器包
| **同步查询** | 支持 | 支持 | 支持 | 支持 | 支持 | 支持 | | **同步查询** | 支持 | 支持 | 支持 | 支持 | 支持 | 支持 |
| **异步查询** | 不支持[2] | 支持 | 支持 | 支持 | 支持 | 暂不支持 | | **异步查询** | 不支持[2] | 支持 | 支持 | 支持 | 支持 | 暂不支持 |
| **参数绑定** | 支持 | 支持 | 支持 | 支持 | 支持 | 支持 | | **参数绑定** | 支持 | 支持 | 支持 | 支持 | 支持 | 支持 |
| **获取系统信息** | 暂不支持 | 支持 | 暂不支持 | 暂不支持 | 支持 | 暂不支持 |
| **错误信息** | 支持 | 支持 | 支持 | 支持 | 支持 | 支持 |
| **订阅功能** | 支持 | 支持 | 支持 | 支持 | 支持 | 暂不支持 | | **订阅功能** | 支持 | 支持 | 支持 | 支持 | 支持 | 暂不支持 |
| **Schemaless** | 支持 | 支持 | 支持 | 支持 | 支持 | 支持 | | **Schemaless** | 支持 | 支持 | 支持 | 支持 | 支持 | 支持 |
### 使用 REST 接口 ### 使用 REST 接口
| **功能特性** | **Java** | **Python（暂不支持）** | **Go** | **C#（暂不支持）** | **Node.js** | **Rust** | | **功能特性** | **Java** | **Python（暂不支持）** | **Go** | **C#（暂不支持）** | **Node.js** | **Rust** |
| ------------------ | --------- | ---------------------- | -------- | -------------------- | ----------- | -------- | | ----------------------------- | --------- | ---------------------- | -------- | -------------------- | ----------- | -------- |
| **连接管理** | 支持 | n/a | 支持 | n/a | 支持 | 支持 | | **连接管理** | 支持 | n/a | 支持 | n/a | 支持 | 支持 |
| **同步查询** | 支持 | n/a | 支持 | n/a | 支持 | 支持 | | **同步查询** | 支持 | n/a | 支持 | n/a | 支持 | 支持 |
| **异步查询** | 不支持[2] | n/a | 不支持 | n/a | 不支持 | 暂不支持 | | **异步查询** | 不支持[2] | n/a | 不支持 | n/a | 不支持 | 不支持 |
| **参数绑定** | 不支持 | n/a | 不支持 | n/a | 不支持 | 不支持 | | **参数绑定** | 不支持 | n/a | 不支持 | n/a | 不支持 | 不支持 |
| **获取系统信息** | 暂不支持 | n/a | 暂不支持 | n/a | 支持 | 暂不支持 | | **订阅功能** | 不支持 | n/a | 不支持 | n/a | 不支持 | 不支持 |
| **错误信息** | 支持 | n/a | 支持 | n/a | 支持 | 支持 | | **Schemaless** | 暂不支持 | n/a | 暂不支持 | n/a | 支持 | 暂不支持 |
| **订阅功能** | 不支持 | n/a | 不支持 | n/a | 不支持 | 不支持 | | **批量拉取（基于WebSocket）** | 支持 | n/a | 暂不支持 | n/a | 暂不支持 | 暂不支持 |
| **Schemaless** | 暂不支持 | n/a | 暂不支持 | n/a | 暂不支持 | 暂不支持 |
| **批量拉取（WS）** | 支持 | n/a | 暂不支持 | n/a | 暂不支持 | 暂不支持 |
备注： 备注：
...@@ -67,7 +63,6 @@ TDengine 提供了丰富的应用程序开发接口，其中官方连接器包 ...@@ -67,7 +63,6 @@ TDengine 提供了丰富的应用程序开发接口，其中官方连接器包
- 在没有安装 TDengine 服务端软件的系统中使用连接器以原生接口连接 TDengine 数据库，需要安装相应版本的客户端安装包来使客户端驱动（Linux 系统中文件名为 libtaos.so，Windows 系统中为 taos.dll）被安装在系统中，否则会产生无法找到相应库文件的错误。 - 在没有安装 TDengine 服务端软件的系统中使用连接器以原生接口连接 TDengine 数据库，需要安装相应版本的客户端安装包来使客户端驱动（Linux 系统中文件名为 libtaos.so，Windows 系统中为 taos.dll）被安装在系统中，否则会产生无法找到相应库文件的错误。
- 所有执行 SQL 语句的 API，例如 C/C++ Connector 中的 `tao_query()`、`taos_query_a()`、`taos_subscribe()` 等，以及其它语言中与它们对应的 API，每次都只能执行一条 SQL 语句，如果实际参数中包含了多条语句，它们的行为是未定义的。 - 所有执行 SQL 语句的 API，例如 C/C++ Connector 中的 `tao_query()`、`taos_query_a()`、`taos_subscribe()` 等，以及其它语言中与它们对应的 API，每次都只能执行一条 SQL 语句，如果实际参数中包含了多条语句，它们的行为是未定义的。
- 升级 TDengine 到 2.0.8.0 版本的用户，必须更新 JDBC。连接 TDengine 必须升级 taos-jdbcdriver 到 2.0.12 及以上。详细的版本依赖关系请参见 [taos-jdbcdriver 文档](/reference/connector/java#version)。
- 无论选用何种编程语言的连接器，2.0 及以上版本的 TDengine 推荐数据库应用的每个线程都建立一个独立的连接，或基于线程建立连接池，以避免连接内的“USE statement”状态量在线程之间相互干扰（但连接的查询和写入操作都是线程安全的）。 - 无论选用何种编程语言的连接器，2.0 及以上版本的 TDengine 推荐数据库应用的每个线程都建立一个独立的连接，或基于线程建立连接池，以避免连接内的“USE statement”状态量在线程之间相互干扰（但连接的查询和写入操作都是线程安全的）。
::: :::
......
docs-cn/14-reference/03-connector/_linux_install.mdx
浏览文件 @ a68e68ee
...@@ -4,8 +4,8 @@ ...@@ -4,8 +4,8 @@
- ARM32 硬件环境：TDengine-client-2.x.x.x-Linux-aarch32.tar.gz - ARM32 硬件环境：TDengine-client-2.x.x.x-Linux-aarch32.tar.gz
2. 解压缩软件包 2. 解压缩软件包
将软件包放置在当前用户可读写的任意目录下，然后执行下面的命令：`tar -xzvf TDengine-client-xxxxxxxxx.tar.gz` 将软件包放置在当前用户可读写的任意目录下，然后执行下面的命令：`tar -xzvf TDengine-client-VERSION.tar.gz`
其中 xxxxxxxxx 需要替换为实际版本的字符串。 其中 VERSION 需要替换为实际版本的字符串。
3. 执行安装脚本 3. 执行安装脚本
解压软件包之后，会在解压目录下看到以下文件(目录)： 解压软件包之后，会在解压目录下看到以下文件(目录)：
...@@ -17,7 +17,7 @@ ...@@ -17,7 +17,7 @@
运行 install_client.sh 进行安装。 运行 install_client.sh 进行安装。
4. 配置 taos.cfg 4. 配置 taos.cfg
编辑 taos.cfg 文件(默认路径/etc/taos/taos.cfg)，将 firstEP 修改为 TDengine 服务器的 End Point，例如：`h1.tdengine.com:6030` 编辑 taos.cfg 文件（默认路径/etc/taos/taos.cfg），将 firstEP 修改为 TDengine 服务器的 End Point，例如：`h1.tdengine.com:6030`
:::tip :::tip
......
docs-cn/14-reference/03-connector/_preparition.mdx
浏览文件 @ a68e68ee
2. 已安装 maven 3.6 及以上版本 2. 已安装 TDengine-client（使用原生连接必须安装，使用REST 连接无需安装）
3. 已安装 TDengine-client（使用原生连接必须安装，使用REST 连接无需安装）
**注意**：由于 TDengine 的应用驱动是使用 C 语言开发的，使用原生连接时需要依赖系统对应的本地函数库。TDengine Linux 服务端安装包也附带了 TDengine client，也可以单独安装 [Linux 客户端](/get-started/) 连接远端 TDengine 集群。在 Windows 环境开发时需要安装 TDengine 对应的 [Windows 客户端](https://www.taosdata.com/cn/all-downloads/#TDengine-Windows-Client) 连接远端 TDengine 集群。 **注意**：由于 TDengine 的应用驱动是使用 C 语言开发的，使用原生连接时需要依赖系统对应的安装在本地的函数库，包含在 TDengine 客户端安装包。TDengine Linux 服务端安装包附带了 TDengine k客户端，也可以单独安装 [Linux 客户端](/get-started/) 。在 Windows 环境开发时需要安装 TDengine 对应的 [Windows 客户端](https://www.taosdata.com/cn/all-downloads/#TDengine-Windows-Client) 连接远端 TDengine 集群。
- libtaos.so 在 Linux 系统中成功安装 TDengine 后，依赖的 Linux b版客户端驱动 libtaos.so 文件会被自动拷贝至 /usr/lib/libtaos.so，该目录包含在 Linux 自动扫描路径上，无需单独指定。 - libtaos.so 在 Linux 系统中成功安装 TDengine 后，依赖的 Linux 版客户端驱动 libtaos.so 文件会被自动拷贝至 /usr/lib/libtaos.so，该目录包含在 Linux 自动扫描路径上，无需单独指定。
- taos.dll 在 Windows 系统中安装完客户端之后，驱动包依赖的 Windows 版客户端驱动 taos.dll 文件会自动拷贝到系统默认搜索路径 C:/Windows/System32 下，同样无需要单独指定。 - taos.dll 在 Windows 系统中安装完客户端之后，依赖的 Windows 版客户端驱动 taos.dll 文件会自动拷贝到系统默认搜索路径 C:/Windows/System32 下，同样无需要单独指定。
docs-cn/14-reference/03-connector/_windows_install.mdx
浏览文件 @ a68e68ee
...@@ -16,7 +16,7 @@ ...@@ -16,7 +16,7 @@
4. 配置 taos.cfg 4. 配置 taos.cfg
编辑 taos.cfg 文件(默认路径 C:\TDengine\cfg\taos.cfg)，将 firstEP 修改为 TDengine 服务器的 End Point，例如：`h1.tdengine.com:6030`。 编辑 taos.cfg 文件（默认路径 C:\TDengine\cfg\taos.cfg），将 firstEP 修改为 TDengine 服务器的 End Point，例如：`h1.tdengine.com:6030`。
:::tip :::tip
......
docs-cn/14-reference/03-connector/csharp.mdx
浏览文件 @ a68e68ee
...@@ -8,7 +8,7 @@ import Preparition from "./_preparition.mdx" ...@@ -8,7 +8,7 @@ import Preparition from "./_preparition.mdx"
## 总体介绍 ## 总体介绍
TDengine.Connector 是 TDengine 提供的 C# 本地客户端驱动连接器。C# 语言开发人员可以通过 它开发存取 TDengine 数据库的应用软件。连接器支持通过客户端驱动（taosc）建立本地连接 TDengine 服务端。进行查询、订阅、schemaless 接口、参数绑定接口等功能。 TDengine.Connector 是 TDengine 提供的 C# 连接器。C# 语言开发人员可以通过它开发存取 TDengine 数据库的 C# 应用软件。连接器支持通过客户端驱动（taosc）建立本地连接 TDengine 服务端。进行查询、订阅、schemaless 接口、参数绑定接口等功能。
TDengine.Connector 目前暂未提供使用 REST 连接d的接口，用户可以参考 [RESTful APIs](https://docs.taosdata.com//reference/restful-api/) 文档自行编写。 TDengine.Connector 目前暂未提供使用 REST 连接d的接口，用户可以参考 [RESTful APIs](https://docs.taosdata.com//reference/restful-api/) 文档自行编写。
...@@ -16,7 +16,10 @@ TDengine.Connector 目前暂未提供使用 REST 连接d的接口，用户可以 ...@@ -16,7 +16,10 @@ TDengine.Connector 目前暂未提供使用 REST 连接d的接口，用户可以
## 支持的平台 ## 支持的平台
C# 连接器支持的系统有：Linux 64 / Windows x64/ Windows x86 | **CPU 类型** | x64（64bit） | | |
| ------------ | ------------ | -------- | -------- |
| **OS 类型** | Linux | Win64 | Win32 |
| **支持与否** | **支持** | **支持** | **支持** |
## 版本支持 ## 版本支持
...@@ -24,13 +27,7 @@ C# 连接器支持的系统有：Linux 64 / Windows x64/ Windows x86 ...@@ -24,13 +27,7 @@ C# 连接器支持的系统有：Linux 64 / Windows x64/ Windows x86
|--------------------|:-------------------------------------:| |--------------------|:-------------------------------------:|
| 1.0.2 ~ 1.0.6 | v2.3.4+ | | 1.0.2 ~ 1.0.6 | v2.3.4+ |
## 支持的特性 ## 支持的功能特性
### 原生连接
“原生连接”指连接器通过客户端驱动 taosc 直接与 TDengine 服务端建立连接。
“本地连接”支持的特新如下：
1. 连接管理 1. 连接管理
2. 同步查询 2. 同步查询
...@@ -86,8 +83,6 @@ dotnet add TDengineDriver/TDengineDriver.csproj ...@@ -86,8 +83,6 @@ dotnet add TDengineDriver/TDengineDriver.csproj
## 建立连接 ## 建立连接
### 建立本地连接
``` C# ``` C#
using TDengineDriver; using TDengineDriver;
......
docs-cn/14-reference/03-connector/go.mdx
浏览文件 @ a68e68ee
...@@ -10,7 +10,7 @@ import Preparition from "./_preparition.mdx" ...@@ -10,7 +10,7 @@ import Preparition from "./_preparition.mdx"
driver-go 是 TDengine 的官方 Go 语言连接器。Go 语言开发人员可以通过它开发存取 TDengine 数据库的应用软件。driver-go 实现了 Go [database/sql](https://golang.org/pkg/database/sql/) 包的接口，支持通过客户端驱动程序（taosc）原生连接 TDengine 服务端，支持数据写入、查询、订阅、schemaless 接口和参数绑定接口等功能。 driver-go 是 TDengine 的官方 Go 语言连接器。Go 语言开发人员可以通过它开发存取 TDengine 数据库的应用软件。driver-go 实现了 Go [database/sql](https://golang.org/pkg/database/sql/) 包的接口，支持通过客户端驱动程序（taosc）原生连接 TDengine 服务端，支持数据写入、查询、订阅、schemaless 接口和参数绑定接口等功能。
driver-go 也支持使用 REST 连接 TDengine 服务端。 driver-go 也支持使用 REST 连接 TDengine 服务端。REST 连接实现的功能集合和原生连接有少量不同。
本文介绍如何在 Windows 或 Linux 环境中安装 driver-go，并通过 driver-go 连接 TDengine 数据库、进行数据查询、数据写入等基本操作。 本文介绍如何在 Windows 或 Linux 环境中安装 driver-go，并通过 driver-go 连接 TDengine 数据库、进行数据查询、数据写入等基本操作。
...@@ -30,11 +30,11 @@ Go 连接器的源码托管在 github。项目名称：driver-go。欢迎 [贡 ...@@ -30,11 +30,11 @@ Go 连接器的源码托管在 github。项目名称：driver-go。欢迎 [贡
| master | database/sql（cgo）、订阅、schemaless写入、stmt | 2.2.0.0 及以上 | | master | database/sql（cgo）、订阅、schemaless写入、stmt | 2.2.0.0 及以上 |
| develop | database/sql（cgo & REST）、订阅、schemaless写入、stmt | 2.4.0.4及以上 | | develop | database/sql（cgo & REST）、订阅、schemaless写入、stmt | 2.4.0.4及以上 |
## 支持的特性 ## 支持的功能特性
### 原生连接 ### 原生连接
“原生连接”指连接器通过客户端驱动（taosc）直接与 TDengine 服务端建立连接。 “原生连接”指连接器通过客户端驱动（taosc）直接与 TDengine 数据库建立连接。
* database/sql (cgo 模式) * database/sql (cgo 模式)
* 订阅 * 订阅
......
docs-cn/14-reference/03-connector/java.mdx
浏览文件 @ a68e68ee
...@@ -9,7 +9,9 @@ import Preparition from "./_preparition.mdx" ...@@ -9,7 +9,9 @@ import Preparition from "./_preparition.mdx"
## 总体介绍 ## 总体介绍
`taos-jdbcdriver` 的实现包括两种形式： JDBC 原生连接和 JDBC-REST（taos-jdbcdriver-2.0.18 开始支持 JDBC-RESTful）。 JDBC 原生连接通过调用客户端驱动 libtaos.so（或 taos.dll ）的本地方法实现， JDBC-RESTful 则通过封装 TDengine REST 服务接口建立连接，REST 连接实现的功能集合和原生连接有少量不同。 taos-jdbcdriver 是 TDengine 的官方 Java 语言连接器。Java 语言开发人员可以通过它开发存取 TDengine 数据库的应用软件。taos-jdbcdriver 实现了 JDBC driver 标准的接口。支持通过客户端驱动程序（taosc）原生连接 TDengine 服务端，支持数据写入、查询、订阅、schemaless 接口和参数绑定接口等功能。
taos-jdbcdriver（2.0.18 和更高版本）也支持使用 REST 连接 TDengine 数据库。REST 连接实现的功能集合和原生连接有少量不同。
![tdengine-connector](/img/tdengine-jdbc-connector.png) ![tdengine-connector](/img/tdengine-jdbc-connector.png)
...@@ -19,7 +21,7 @@ import Preparition from "./_preparition.mdx" ...@@ -19,7 +21,7 @@ import Preparition from "./_preparition.mdx"
- RESTful：应用将 SQL 发送给位于物理节点 2（pnode2）上的 REST 连接器，再调用客户端驱动 API。 - RESTful：应用将 SQL 发送给位于物理节点 2（pnode2）上的 REST 连接器，再调用客户端驱动 API。
- JDBC-RESTful：Java 应用通过 JDBC-RESTful 的 API ，将 SQL 封装成一个 RESTful 请求，发送给物理节点 2 的 REST 连接器。 - JDBC-RESTful：Java 应用通过 JDBC-RESTful 的 API ，将 SQL 封装成一个 RESTful 请求，发送给物理节点 2 的 REST 连接器。
TDengine 的 JDBC 驱动实现尽可能与关系型数据库驱动保持一致，但 TDengine 与关系对象型数据库的使用场景和技术特征存在差异，导致 `taos-jdbcdriver` 与传统的 JDBC driver 也存在一定差异。在使用时需要注意以下几点： TDengine 的 JDBC 驱动实现尽可能与关系型数据库驱动保持一致，但 TDengine 与关系对象型数据库的使用场景和技术特征存在差异，所以`taos-jdbcdriver` 与传统的 JDBC driver 也存在一定差异。在使用时需要注意以下几点：
- TDengine 目前不支持针对单条数据记录的删除操作。 - TDengine 目前不支持针对单条数据记录的删除操作。
- 目前不支持事务操作。 - 目前不支持事务操作。
...@@ -107,11 +109,11 @@ TDengine 目前支持时间戳、数字、字符、布尔类型，与 Java 对 ...@@ -107,11 +109,11 @@ TDengine 目前支持时间戳、数字、字符、布尔类型，与 Java 对
使用 Java Connector 连接数据库前，需要具备以下条件： 使用 Java Connector 连接数据库前，需要具备以下条件：
1. 已安装 Java 1.8 或以上版本运行时环境 1. 已安装 Java 1.8 或以上版本运行时环境和 Maven 3.6 或以上版本
<Preparition /> <Preparition />
### 使用 maven 安装 ### 使用 Maven 安装
目前 taos-jdbcdriver 已经发布到 [Sonatype Repository](https://search.maven.org/artifact/com.taosdata.jdbc/taos-jdbcdriver) 仓库，且各大仓库都已同步。 目前 taos-jdbcdriver 已经发布到 [Sonatype Repository](https://search.maven.org/artifact/com.taosdata.jdbc/taos-jdbcdriver) 仓库，且各大仓库都已同步。
...@@ -119,7 +121,7 @@ TDengine 目前支持时间戳、数字、字符、布尔类型，与 Java 对 ...@@ -119,7 +121,7 @@ TDengine 目前支持时间戳、数字、字符、布尔类型，与 Java 对
- [mvnrepository](https://mvnrepository.com/artifact/com.taosdata.jdbc/taos-jdbcdriver) - [mvnrepository](https://mvnrepository.com/artifact/com.taosdata.jdbc/taos-jdbcdriver)
- [maven.aliyun](https://maven.aliyun.com/mvn/search) - [maven.aliyun](https://maven.aliyun.com/mvn/search)
maven 项目中，在 pom.xml 中添加以下依赖： Maven 项目中，在 pom.xml 中添加以下依赖：
```xml-dtd ```xml-dtd
<dependency> <dependency>
...@@ -139,7 +141,7 @@ cd TDengine/src/connector/jdbc ...@@ -139,7 +141,7 @@ cd TDengine/src/connector/jdbc
mvn clean install -Dmaven.test.skip=true mvn clean install -Dmaven.test.skip=true
``` ```
编译后，在 target 目录下会产生 taos-jdbcdriver-2.0.XX-dist.jar 的 jar 包，并自动将此 jar 文件放在 maven 本地仓库中。 编译后，在 target 目录下会产生 taos-jdbcdriver-2.0.XX-dist.jar 的 jar 包，并自动将此 jar 文件放在 Maven 本地仓库中。
## 建立连接 ## 建立连接
...@@ -156,7 +158,7 @@ Connection conn = DriverManager.getConnection(jdbcUrl); ...@@ -156,7 +158,7 @@ Connection conn = DriverManager.getConnection(jdbcUrl);
以上示例，使用了 JDBC 原生连接的 driver，建立了到 hostname 为 taosdemo.com，端口为 6030（TDengine 的默认端口），数据库名为 test 的连接。这个 URL 中指定用户名（user）为 root，密码（password）为 taosdata。 以上示例，使用了 JDBC 原生连接的 driver，建立了到 hostname 为 taosdemo.com，端口为 6030（TDengine 的默认端口），数据库名为 test 的连接。这个 URL 中指定用户名（user）为 root，密码（password）为 taosdata。
**注意**：使用 JDBC 原生连接的 driver，taos-jdbcdriver 驱动包时需要依赖系统对应的本地客户端驱动（Linux 下是 libtaos.so；Windows 下是 taos.dll）。 **注意**：使用 JDBC 原生连接的 driver，taos-jdbcdriver 驱动包时需要依赖系统对应本地的客户端驱动（Linux 下是 libtaos.so；Windows 下是 taos.dll）。
url 中的配置参数如下： url 中的配置参数如下：
......
docs-cn/14-reference/03-connector/node.mdx
浏览文件 @ a68e68ee
...@@ -30,33 +30,26 @@ Node.js 连接器支持的系统有： ...@@ -30,33 +30,26 @@ Node.js 连接器支持的系统有：
| 2.0.11 | ver-2.5.0.x、ver-2.4.x.x、ver-2.3.x.x | | 2.0.11 | ver-2.5.0.x、ver-2.4.x.x、ver-2.3.x.x |
| 2.0.12 | ver-2.5.0.x、ver-2.4.x.x、ver-2.3.x.x | | 2.0.12 | ver-2.5.0.x、ver-2.4.x.x、ver-2.3.x.x |
## 支持的特性 ## 支持的功能特性
### 本地连接 ### 原生连接
"本地连接" 指连接器通过本地的客户端驱动程序 taosc 直接与服务端程序 taosd 建立连接。 “原生连接”指连接器通过客户端驱动程序 taosc 直接与 TDengine 数据库建立连接
本地连接支持的特新如下：
原生连接支持的功能特性如下：
1. 连接管理 1. 连接管理
2. 同步查询 2. 同步查询
3. 异步查询 3. 异步查询
4. 参数绑定 4. 参数绑定
5. 获取系统信息 5. 订阅功能
6. 错误信息 6. Schemaless
7. 订阅功能
8. Schemaless
### RESTful 连接 ### REST 连接
1. 连接管理 1. 连接管理
2. 同步查询 2. 同步查询
3. 异步查询（暂不支持） 3. Schemaless
4. 参数绑定（暂不支持）
5. 获取系统信息
6. 错误信息
7. 订阅功能（暂不支持）
8. Schemaless
9. 批量拉取（暂不支持）
## 安装步骤 ## 安装步骤
...@@ -66,7 +59,7 @@ Node.js 连接器支持的系统有： ...@@ -66,7 +59,7 @@ Node.js 连接器支持的系统有：
<Preparition /> <Preparition />
- 应用驱动安装请参考[安装连接器驱动步骤](/reference/connector/#安装客户端驱动)。 - 应用驱动安装请参考[安装连接器驱动步骤](/reference/connector/#安装客户端驱动)。
我们使用[node-gyp](https://github.com/nodejs/node-gyp)和 TDengine 服务端进行交互。安装 Node.js 本地驱动连接器之前，还需要根据具体操作系统来安装下文提到的一些依赖工具。如果要安装的是 RESTful 连接器则可以跳过以下步骤，直接只用 npm 安装。 我们使用[node-gyp](https://github.com/nodejs/node-gyp)和 TDengine 服务端进行交互。安装 Node.js 连接器之前，还需要根据具体操作系统来安装下文提到的一些依赖工具。如果要安装的是 RESTful 连接器则可以跳过以下步骤，直接只用 npm 安装。
### Linux ### Linux
...@@ -95,7 +88,7 @@ Node.js 连接器支持的系统有： ...@@ -95,7 +88,7 @@ Node.js 连接器支持的系统有：
### 使用 npm 安装 ### 使用 npm 安装
- 安装本地客户端驱动连接器 - 安装客户端驱动连接器
``` bash ``` bash
npm install td2.0-connector npm install td2.0-connector
...@@ -127,7 +120,7 @@ node nodejsChecker.js host=localhost ...@@ -127,7 +120,7 @@ node nodejsChecker.js host=localhost
## 建立连接 ## 建立连接
### 建立本地连接 ### 建立连接
安装并引用 `td2.0-connector` 包。 安装并引用 `td2.0-connector` 包。
...@@ -161,7 +154,7 @@ let cursor = conn.cursor(); ...@@ -161,7 +154,7 @@ let cursor = conn.cursor();
## 使用示例 ## 使用示例
| 示例程序 | 示例程序描述 | | 示例程序 | 示例程序描述 |
|-----------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------| |-----------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|
| [connection](https://github.com/taosdata/TDengine/blob/develop/src/connector/nodejs/examples/cursorClose.js) | 建立本地连接的示例。 | | [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) | 绑定多行参数插入的示例。 | | [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) | 一行一行绑定参数插入的示例。 | | [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) | 按列绑定参数插入的示例。 | | [stmtBindSingleParamBatch](https://github.com/taosdata/TDengine/blob/develop/src/connector/nodejs/examples/stmtBindSingleParamBatchSample.js) | 按列绑定参数插入的示例。 |
...@@ -176,7 +169,7 @@ let cursor = conn.cursor(); ...@@ -176,7 +169,7 @@ let cursor = conn.cursor();
## 使用限制 ## 使用限制
Node.js 的本地连接器 >= v2.0.6 目前支持 node 的版本为： 支持 >=v12.8.0 <= v12.9.1 || >=v10.20.0 <= v10.9.0 ；2.0.5 及更早版本支持 v10.x 版本，其他版本可能存在包兼容性的问题。 Node.js 连接器 >= v2.0.6 目前支持 node 的版本为： 支持 >=v12.8.0 <= v12.9.1 || >=v10.20.0 <= v10.9.0 ；2.0.5 及更早版本支持 v10.x 版本，其他版本可能存在包兼容性的问题。
## 重要更新记录 ## 重要更新记录
...@@ -202,7 +195,7 @@ Node.js 连接器的使用参见[视频教程](https://www.taosdata.com/blog/202 ...@@ -202,7 +195,7 @@ Node.js 连接器的使用参见[视频教程](https://www.taosdata.com/blog/202
sudo systemctl start taosadapter sudo systemctl start taosadapter
``` ```
2. 本地客户端驱动连接器 >v2.0.6 目前兼容的 node 为：>=v12.8.0 <= v12.9.1 || >=v10.20.0 <= v10.9.0。 2. 连接器 >v2.0.6 目前兼容的 Node.js 为：>=v10.20.0 <= v10.9.0 || >=v12.8.0 <= v12.9.1
3. "Unable to establish connection"，"Unable to resolve FQDN"， 一般都是应为为配置 FQDN 可以参考[如何彻底搞懂 TDengine 的 FQDN](https://www.taosdata.com/blog/2021/07/29/2741.html) 。 3. "Unable to establish connection"，"Unable to resolve FQDN"， 一般都是应为为配置 FQDN 可以参考[如何彻底搞懂 TDengine 的 FQDN](https://www.taosdata.com/blog/2021/07/29/2741.html) 。
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或