diff --git a/docs-cn/14-reference/03-connector/03-connector.mdx b/docs-cn/14-reference/03-connector/03-connector.mdx index b8b510cdf00bcae62a437164e5015d288bb64fad..516a2bb1ee39f4b736b69cd2900b89138928610b 100644 --- a/docs-cn/14-reference/03-connector/03-connector.mdx +++ b/docs-cn/14-reference/03-connector/03-connector.mdx @@ -1,95 +1,96 @@ ---- -title: 连接器 ---- - -TDengine 提供了丰富的应用程序开发接口，其中包括 C/C++、Java、Python、Go、Node.js、C# 、RESTful 等，便于用户快速开发应用。 - -![image-connecotr](/img/connector.png) - -## 支持的系统 - -目前 TDengine 的连接器可支持的平台广泛，包括：X64/X86/ARM64/ARM32/MIPS/Alpha 等硬件平台，以及 Linux/Win64/Win32 等开发环境。对照矩阵如下： - -| **CPU** | **OS** | **JDBC** | **Python** | **Go** | **Node.js** | **C#** | **Rust** | **RESTful** | -| -------------- | --------- | -------- | ---------- | ------ | ----------- | ------ | -------- | ----------- | -| **X86 64bit** | **Linux** | ● | ● | ● | ● | ● | ● | ● | -| **X86 64bit** | **Win64** | ● | ● | ● | ● | ● | ● | ● | -| **X86 64bit** | **Win32** | ● | ● | ● | ● | ○ | ○ | ● | -| **X86 32bit** | **Win32** | ○ | ○ | ○ | ○ | ○ | ○ | ● | -| **ARM64** | **Linux** | ● | ● | ● | ● | ○ | ○ | ● | -| **ARM32** | **Linux** | ● | ● | ● | ● | ○ | ○ | ● | -| **MIPS 龙芯** | **Linux** | ○ | ○ | ○ | ○ | ○ | ○ | ○ | -| **Alpha 申威** | **Linux** | ○ | ○ | -- | -- | -- | -- | ○ | -| **X86 海光** | **Linux** | ○ | ○ | ○ | -- | -- | -- | ○ | - -其中 ● 表示官方测试验证通过，○ 表示非官方测试验证通过，-- 表示未经验证。 - -## 特性矩阵 - -连接器对 TDengine 特性的支持对照矩阵如下[1]： - -| **Feature** | **Java** | **Python** | **Go** | **C#** | **Node.js** | **Rust** | -| ------------------ | --------- | ---------- | -------- | -------- | ----------- | -------- | -| **连接管理** | 支持 | 支持 | 支持 | 支持 | 支持 | 支持 | -| **同步查询** | 支持 | 支持 | 支持 | 支持 | 支持 | 支持 | -| **异步查询** | 不支持[2] | 支持 | 支持 | 支持 | 支持 | 暂不支持 | -| **参数绑定** | 支持 | 支持 | 支持 | 支持 | 支持 | 支持 | -| **获取系统信息** | 暂不支持 | 支持 | 暂不支持 | 暂不支持 | 支持 | 暂不支持 | -| **错误信息** | 支持 | 支持 | 支持 | 支持 | 支持 | 支持 | -| **订阅功能** | 支持 | 支持 | 支持 | 支持 | 支持 | 暂不支持 | -| **Schemaless** | 支持 | 支持 | 支持 | 支持 | 支持 | 支持 | -| **RESTful 连接** | 支持 | 支持 | 支持 | 暂不支持 | 支持 | 支持 | -| **批量拉取（WS）** | 支持 | 暂不支持 | 暂不支持 | 暂不支持 | 暂不支持 | 暂不支持 | - -备注： - -[1]: 由于不同语言数据库框架规范不同，并不意味着所有 C/C++ 接口都需要对应支持。 - -[2]: JDBC 标准为同步查询。 - -:::warning - -- 在没有安装 TDengine 服务端软件的系统中使用连接器（除 RESTful 外）访问 TDengine 数据库，需要安装相应版本的客户端安装包来使应用驱动（Linux 系统中文件名为 libtaos.so，Windows 系统中为 taos.dll）被安装在系统中，否则会产生无法找到相应库文件的错误。 -- 所有执行 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 文档](https://www.taosdata.com/cn/documentation/connector/java#version)。 -- 无论选用何种编程语言的连接器，2.0 及以上版本的 TDengine 推荐数据库应用的每个线程都建立一个独立的连接，或基于线程建立连接池，以避免连接内的“USE statement”状态量在线程之间相互干扰（但连接的查询和写入操作都是线程安全的）。 - -::: - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import InstallOnWindows from "./_linux_install.mdx"; -import InstallOnLinux from "./_windows_install.mdx"; -import VarifyWindows from "./_varify_linux.mdx"; -import VarifyLinux from "./_varify_windows.mdx"; - -## 安装客户端驱动 - -:::info -只有在没有安装 TDengine 服务端软件的系统上使用非 RESTFful 连接器才需要安装客户端驱动。 - -::: - -### 安装步骤 - - - - - - - - - - -### 安装验证 - -以上安装和配置完成后，并确认 TDengine 服务已经正常启动运行，此时可以执行 taos 客户端进行登录。 - - - - - - - - - +--- +title: 连接器 +--- + +TDengine 提供了丰富的应用程序开发接口，其中包括 C/C++、Java、Python、Go、Node.js、C# 、RESTful 等，便于用户快速开发应用。 + +![image-connecotr](/img/connector.png) + +## 支持的系统 + +目前 TDengine 的连接器可支持的平台广泛，包括：X64/X86/ARM64/ARM32/MIPS/Alpha 等硬件平台，以及 Linux/Win64/Win32 等开发环境。对照矩阵如下： + +| **CPU** | **OS** | **JDBC** | **Python** | **Go** | **Node.js** | **C#** | **Rust** | **RESTful** | +| -------------- | --------- | -------- | ---------- | ------ | ----------- | ------ | -------- | ----------- | +| **X86 64bit** | **Linux** | ● | ● | ● | ● | ● | ● | ● | +| **X86 64bit** | **Win64** | ● | ● | ● | ● | ● | ● | ● | +| **X86 64bit** | **Win32** | ● | ● | ● | ● | ○ | ○ | ● | +| **X86 32bit** | **Win32** | ○ | ○ | ○ | ○ | ○ | ○ | ● | +| **ARM64** | **Linux** | ● | ● | ● | ● | ○ | ○ | ● | +| **ARM32** | **Linux** | ● | ● | ● | ● | ○ | ○ | ● | +| **MIPS 龙芯** | **Linux** | ○ | ○ | ○ | ○ | ○ | ○ | ○ | +| **Alpha 申威** | **Linux** | ○ | ○ | -- | -- | -- | -- | ○ | +| **X86 海光** | **Linux** | ○ | ○ | ○ | -- | -- | -- | ○ | + +其中 ● 表示官方测试验证通过，○ 表示非官方测试验证通过，-- 表示未经验证。 + +## 特性矩阵 + +连接器对 TDengine 特性的支持对照矩阵如下[1]： + +| **Feature** | **Java** | **Python** | **Go** | **C#** | **Node.js** | **Rust** | +| ------------------ | --------- | ---------- | -------- | -------- | ----------- | -------- | +| **连接管理** | 支持 | 支持 | 支持 | 支持 | 支持 | 支持 | +| **同步查询** | 支持 | 支持 | 支持 | 支持 | 支持 | 支持 | +| **异步查询** | 不支持[2] | 支持 | 支持 | 支持 | 支持 | 暂不支持 | +| **参数绑定** | 支持 | 支持 | 支持 | 支持 | 支持 | 支持 | +| **获取系统信息** | 暂不支持 | 支持 | 暂不支持 | 暂不支持 | 支持 | 暂不支持 | +| **错误信息** | 支持 | 支持 | 支持 | 支持 | 支持 | 支持 | +| **订阅功能** | 支持 | 支持 | 支持 | 支持 | 支持 | 暂不支持 | +| **Schemaless** | 支持 | 支持 | 支持 | 支持 | 支持 | 支持 | +| **RESTful 连接** | 支持 | 支持 | 支持 | 暂不支持 | 支持 | 支持 | +| **批量拉取（WS）** | 支持 | 暂不支持 | 暂不支持 | 暂不支持 | 暂不支持 | 暂不支持 | + +备注： + +[1]: 由于不同语言数据库框架规范不同，并不意味着所有 C/C++ 接口都需要对应支持。 + +[2]: JDBC 标准为同步查询。 + +:::warning + +- 在没有安装 TDengine 服务端软件的系统中使用连接器（除 RESTful 外）访问 TDengine 数据库，需要安装相应版本的客户端安装包来使应用驱动（Linux 系统中文件名为 libtaos.so，Windows 系统中为 taos.dll）被安装在系统中，否则会产生无法找到相应库文件的错误。 +- 所有执行 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 文档](https://www.taosdata.com/cn/documentation/connector/java#version)。 +- 无论选用何种编程语言的连接器，2.0 及以上版本的 TDengine 推荐数据库应用的每个线程都建立一个独立的连接，或基于线程建立连接池，以避免连接内的“USE statement”状态量在线程之间相互干扰（但连接的查询和写入操作都是线程安全的）。 + +::: + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import InstallOnWindows from "./_linux_install.mdx"; +import InstallOnLinux from "./_windows_install.mdx"; +import VerifyWindows from "./_verify_linux.mdx"; +import VerifyLinux from "./_verify_windows.mdx"; + +## 安装客户端驱动 + +:::info +只有在没有安装 TDengine 服务端软件的系统上使用非 RESTFful 连接器才需要安装客户端驱动。 + +::: + +### 安装步骤 + + + + + + + + + + +### 安装验证 + +以上安装和配置完成后，并确认 TDengine 服务已经正常启动运行，此时可以执行 taos 客户端进行登录。 + + + + + + + + + + diff --git a/docs-cn/14-reference/03-connector/_varify_linux.mdx b/docs-cn/14-reference/03-connector/_verify_linux.mdx similarity index 98% rename from docs-cn/14-reference/03-connector/_varify_linux.mdx rename to docs-cn/14-reference/03-connector/_verify_linux.mdx index b7340a7ef131cefc78aa9555eadba9a72d43fcb9..794f95dd702a9684fd1299e5b0fd380b174ca04c 100644 --- a/docs-cn/14-reference/03-connector/_varify_linux.mdx +++ b/docs-cn/14-reference/03-connector/_verify_linux.mdx @@ -1,14 +1,14 @@ -在 Linux shell 下直接执行 taos，应该就能正常连接到 TDegine 服务，进入到 taos shell 界面，示例如下： - -```sql -$ taos -Welcome to the TDengine shell from Linux, Client Version:2.0.5.0 -Copyright (c) 2017 by TAOS Data, Inc. All rights reserved. -taos> show databases; -name | created_time | ntables | vgroups | replica | quorum | days | keep1,keep2,keep(D) | cache(MB)| blocks | minrows | maxrows | wallevel | fsync | comp | precision | status | -========================================================================================================================================================================================================================= -test | 2020-10-14 10:35:48.617 | 10 | 1 | 1 | 1 | 2 | 3650,3650,3650 | 16| 6 | 100 | 4096 | 1 | 3000 | 2 | ms | ready | -log | 2020-10-12 09:08:21.651 | 4 | 1 | 1 | 1 | 10 | 30,30,30 | 1| 3 | 100 | 4096 | 1 | 3000 | 2 | us | ready | -Query OK, 2 row(s) in set (0.001198s) -taos> -``` +在 Linux shell 下直接执行 taos，应该就能正常连接到 TDegine 服务，进入到 taos shell 界面，示例如下： + +```sql +$ taos +Welcome to the TDengine shell from Linux, Client Version:2.0.5.0 +Copyright (c) 2017 by TAOS Data, Inc. All rights reserved. +taos> show databases; +name | created_time | ntables | vgroups | replica | quorum | days | keep1,keep2,keep(D) | cache(MB)| blocks | minrows | maxrows | wallevel | fsync | comp | precision | status | +========================================================================================================================================================================================================================= +test | 2020-10-14 10:35:48.617 | 10 | 1 | 1 | 1 | 2 | 3650,3650,3650 | 16| 6 | 100 | 4096 | 1 | 3000 | 2 | ms | ready | +log | 2020-10-12 09:08:21.651 | 4 | 1 | 1 | 1 | 10 | 30,30,30 | 1| 3 | 100 | 4096 | 1 | 3000 | 2 | us | ready | +Query OK, 2 row(s) in set (0.001198s) +taos> +``` diff --git a/docs-cn/14-reference/03-connector/_varify_windows.mdx b/docs-cn/14-reference/03-connector/_verify_windows.mdx similarity index 98% rename from docs-cn/14-reference/03-connector/_varify_windows.mdx rename to docs-cn/14-reference/03-connector/_verify_windows.mdx index 4f61bef9a22806f61b4b056ca319ab606c348b1d..0e16f272ae478ffbd1eebb2dfec4d4ea7c47e18d 100644 --- a/docs-cn/14-reference/03-connector/_varify_windows.mdx +++ b/docs-cn/14-reference/03-connector/_verify_windows.mdx @@ -1,14 +1,14 @@ -在 cmd 下进入到 c:\TDengine 目录下直接执行 taos.exe，应该就能正常链接到 tdegine 服务，进入到 taos shell 界面，示例如下： - -```sql - C:\TDengine>taos - Welcome to the TDengine shell from Linux, Client Version:2.0.5.0 - Copyright (c) 2017 by TAOS Data, Inc. All rights reserved. - taos> show databases; - name | created_time | ntables | vgroups | replica | quorum | days | keep1,keep2,keep(D) | cache(MB) | blocks | minrows | maxrows | wallevel | fsync | comp | precision | status | - =================================================================================================================================================================================================================================================================== - test | 2020-10-14 10:35:48.617 | 10 | 1 | 1 | 1 | 2 | 3650,3650,3650 | 16 | 6 | 100 | 4096 | 1 | 3000 | 2 | ms | ready | - log | 2020-10-12 09:08:21.651 | 4 | 1 | 1 | 1 | 10 | 30,30,30 | 1 | 3 | 100 | 4096 | 1 | 3000 | 2 | us | ready | - Query OK, 2 row(s) in set (0.045000s) - taos> -``` +在 cmd 下进入到 c:\TDengine 目录下直接执行 taos.exe，应该就能正常链接到 tdegine 服务，进入到 taos shell 界面，示例如下： + +```sql + C:\TDengine>taos + Welcome to the TDengine shell from Linux, Client Version:2.0.5.0 + Copyright (c) 2017 by TAOS Data, Inc. All rights reserved. + taos> show databases; + name | created_time | ntables | vgroups | replica | quorum | days | keep1,keep2,keep(D) | cache(MB) | blocks | minrows | maxrows | wallevel | fsync | comp | precision | status | + =================================================================================================================================================================================================================================================================== + test | 2020-10-14 10:35:48.617 | 10 | 1 | 1 | 1 | 2 | 3650,3650,3650 | 16 | 6 | 100 | 4096 | 1 | 3000 | 2 | ms | ready | + log | 2020-10-12 09:08:21.651 | 4 | 1 | 1 | 1 | 10 | 30,30,30 | 1 | 3 | 100 | 4096 | 1 | 3000 | 2 | us | ready | + Query OK, 2 row(s) in set (0.045000s) + taos> +``` diff --git a/docs-cn/14-reference/03-connector/cpp.mdx b/docs-cn/14-reference/03-connector/cpp.mdx index 00b62dcf2a8074ee52a0de185c55222b0afd3bd3..78f3d8a68874ccee3b5a6cec7af3735e7d4d6af4 100644 --- a/docs-cn/14-reference/03-connector/cpp.mdx +++ b/docs-cn/14-reference/03-connector/cpp.mdx @@ -1,5 +1,6 @@ --- sidebar_position: 1 +sidebar_label: C/C++ title: C/C++ Connector --- diff --git a/docs-cn/14-reference/03-connector/go.mdx b/docs-cn/14-reference/03-connector/go.mdx index 5919278086120a76c6dbfcbfaf74eb67ed35607f..0a7c82ffc885915e7613a0d7c3e5ef4b8d767fe2 100644 --- a/docs-cn/14-reference/03-connector/go.mdx +++ b/docs-cn/14-reference/03-connector/go.mdx @@ -1,5 +1,6 @@ --- sidebar_position: 4 +sidebar_label: Go title: Go Connector --- diff --git a/docs-cn/14-reference/03-connector/java.mdx b/docs-cn/14-reference/03-connector/java.mdx index 58ddf0db5efb1ac7e95f93aeed67c2e5dea97c9f..e314fc85c14cd470e3de06c885db71beadee0d83 100644 --- a/docs-cn/14-reference/03-connector/java.mdx +++ b/docs-cn/14-reference/03-connector/java.mdx @@ -1,5 +1,6 @@ --- sidebar_position: 2 +sidebar_label: Java title: Java Connector --- diff --git a/docs-cn/14-reference/03-connector/node.mdx b/docs-cn/14-reference/03-connector/node.mdx index 5e6f5a0bd9a692fa4e3def4f8e730620380f3706..b48c5c2b85bfb86a344948d7a499fa4b955fd4df 100644 --- a/docs-cn/14-reference/03-connector/node.mdx +++ b/docs-cn/14-reference/03-connector/node.mdx @@ -1,5 +1,6 @@ --- -sidebar_position: 5 +sidebar_position: 6 +sidebar_label: Node.js title: Node.js Connector --- diff --git a/docs-cn/14-reference/03-connector/python.mdx b/docs-cn/14-reference/03-connector/python.mdx index eacad9d2e3804d5371a05ba0dff9acfd97ef77f0..dc1466c22bfca823aae6c51c0bfdaa1d633600e4 100644 --- a/docs-cn/14-reference/03-connector/python.mdx +++ b/docs-cn/14-reference/03-connector/python.mdx @@ -1,5 +1,6 @@ --- sidebar_position: 3 +sidebar_label: Python title: Python Connector --- diff --git a/docs-cn/14-reference/03-connector/rust.mdx b/docs-cn/14-reference/03-connector/rust.mdx index 73e0c8b3f2533adcfe95cf9dfd341d3900fd0d73..b26f572e8d35d253b80183c760179ef4208b3f07 100644 --- a/docs-cn/14-reference/03-connector/rust.mdx +++ b/docs-cn/14-reference/03-connector/rust.mdx @@ -1,4 +1,6 @@ --- +sidebar_position: 5 +sidebar_label: Rust title: Rust Connector ---