Skip to main content

连接器参考手册

TDengine 提供了丰富的应用程序开发接口,为了便于用户快速开发自己的应用,TDengine 支持了多种编程语言的连接器,其中官方连接器包括支持 C/C++、Java、Python、Go、Node.js、C# 和 Rust 的连接器。这些连接器支持使用原生接口(taosc)和 WebSocket 接口连接 TDengine 集群。社区开发者也贡献了多个非官方连接器,例如 ADO.NET 连接器、Lua 连接器和 PHP 连接器。

TDengine Database connector architecture

支持的平台

目前 TDengine 的原生接口连接器可支持的平台包括:X64/ARM64 等硬件平台,以及 Linux/Win64 等开发环境。对照矩阵如下:

CPUOSJavaPythonGoNode.jsC#RustC/C++
X86 64bitLinux
X86 64bitWin64
X86 64bitmacOS
ARM64Linux
ARM64macOS

其中 ● 表示官方测试验证通过,○ 表示非官方测试验证通过,-- 表示未经验证。

使用 REST 连接由于不依赖客户端驱动可以支持更广泛的操作系统。

版本支持

TDengine 版本更新往往会增加新的功能特性,列表中的连接器版本为连接器最佳适配版本。

TDengine 版本JavaPythonGoC#Node.jsRustC/C++
3.3.0.0 及以上3.3.0及以上taospy 2.7.15及以上,taos-ws-py 0.3.2及以上3.5.5及以上3.1.3及以上3.1.0及以上当前版本与 TDengine 相同版本
3.0.0.0 及以上3.0.2以上当前版本3.0 分支3.0.03.1.0当前版本与 TDengine 相同版本
2.4.0.14 及以上2.0.38当前版本develop 分支1.0.2 - 1.0.62.0.10 - 2.0.12当前版本与 TDengine 相同版本
2.4.0.4 - 2.4.0.132.0.37当前版本develop 分支1.0.2 - 1.0.62.0.10 - 2.0.12当前版本与 TDengine 相同版本
**2.2.x.x **2.0.36当前版本master 分支n/a2.0.7 - 2.0.9当前版本与 TDengine 相同版本
**2.0.x.x **2.0.34当前版本master 分支n/a2.0.1 - 2.0.6当前版本与 TDengine 相同版本

功能特性

连接器对 TDengine 功能特性的支持对照如下:

使用原生接口(taosc)

功能特性JavaPythonGoC#RustC/C++
连接管理支持支持支持支持支持支持
执行 SQL支持支持支持支持支持支持
参数绑定支持支持支持支持支持支持
数据订阅(TMQ)支持支持支持支持支持支持
无模式写入支持支持支持支持支持支持
info

由于不同编程语言数据库框架规范不同,并不意味着所有 C/C++ 接口都需要对应封装支持。

使用 http REST 接口

功能特性JavaPythonGo
连接管理支持支持支持
执行 SQL支持支持支持

使用 Websocket 接口

功能特性JavaPythonGoC#Node.jsRustC/C++
连接管理支持支持支持支持支持支持支持
执行 SQL支持支持支持支持支持支持支持
参数绑定支持支持支持支持支持支持支持
数据订阅(TMQ)支持支持支持支持支持支持支持
无模式写入支持支持支持支持支持支持支持
warning
  • 无论选用何种编程语言的连接器,2.0 及以上版本的 TDengine 推荐数据库应用的每个线程都建立一个独立的连接,或基于线程建立连接池,以避免连接内的“USE statement”状态量在线程之间相互干扰(但连接的查询和写入操作都是线程安全的)。

安装客户端驱动

info

只有在没有安装 TDengine 服务端软件的系统上使用原生接口连接器才需要安装客户端驱动。

安装步骤

  1. 下载客户端安装包
    1. 解压缩软件包

      将软件包放置在当前用户可读写的任意目录下,然后执行下面的命令:tar -xzvf TDengine-client-VERSION.tar.gz 其中 VERSION 需要替换为实际版本的字符串。

    2. 执行安装脚本

      解压软件包之后,会在解压目录下看到以下文件(目录):

      • _ install_client.sh_:安装脚本,用于应用驱动程序
      • _ package.tar.gz_:应用驱动安装包
      • _ driver_:TDengine 应用驱动 driver
      • examples: 各种编程语言的示例程序(c/C#/go/JDBC/MATLAB/python/R) 运行 install_client.sh 进行安装。
    3. 配置 taos.cfg

      编辑 taos.cfg 文件(默认路径/etc/taos/taos.cfg),将 firstEP 修改为 TDengine 服务器的 End Point,例如:h1.tdengine.com:6030

    tip
    1. 如本机没有部署 TDengine 服务,仅安装了应用驱动,则 taos.cfg 中仅需配置 firstEP,无需在本机配置 FQDN
    2. 为防止与服务器端连接时出现“Unable to resolve FQDN”错误,建议确认本机的 /etc/hosts 文件已经配置了服务器正确的 FQDN 值,或配置好了 DNS 服务。

    安装验证

    以上安装和配置完成后,并确认 TDengine 服务已经正常启动运行,此时可以执行 TDengine CLI 工具进行登录。

    在 Linux shell 下直接执行 taos 连接到 TDengine 服务,进入到 TDengine CLI 界面,示例如下:

    $ taos

    taos> show databases;
    name |
    =================================
    information_schema |
    performance_schema |
    db |
    Query OK, 3 rows in database (0.019154s)

    taos>

    📄️ Python

    taospy 是 TDengine 的官方 Python 连接器。taospy 提供了丰富的 API, 使得 Python 应用可以很方便地使用 TDengine。tasopy 对 TDengine 的原生接口和 REST 接口都进行了封装, 分别对应 tasopy 的两个子模块:taos 和 taosrest。除了对原生接口和 REST 接口的封装,taospy 还提供了符合 Python 数据访问规范(PEP 249)的编程接口。这使得 taospy 和很多第三方工具集成变得简单,比如 SQLAlchemy 和 pandas