未验证 提交 6bc95596 编写于 作者: sangshuduo's avatar sangshuduo 提交者: GitHub

docs: connector refine (#11826)

* 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]

* docs: refine connectors doc

[TD-14839]

* docs: refine connector docs

* docs: refine connector doc

[TD-14839]

* docs: refine connector doc

[TD-14839]

* docs: refine connector

[TD-14839]

* docs: fix faq path

* docs: refine cpp connector doc

* docs: refine cpp docs

* docs: fix java preparition

* docs: refine connector docs
上级 1fa3e897
...@@ -8,30 +8,25 @@ import Preparition from "./_preparition.mdx" ...@@ -8,30 +8,25 @@ import Preparition from "./_preparition.mdx"
## 总体介绍 ## 总体介绍
`TDengine.Connector` 是 TDengine 提供的 C# 连接器。C# 语言开发人员可以通过它开发存取 TDengine 数据库的 C# 应用软件。连接器支持通过客户端驱动(taosc)建立本地连接 TDengine 数据库。进行数据写入、查询、订阅、schemaless 数据写入、参数绑定接口数据写入等功能。 `TDengine.Connector` 是 TDengine 提供的 C# 语言连接器。C# 开发人员可以通过它开发存取 TDengine 集群数据的 C# 应用软件。连接器支持通过客户端驱动(taosc)建立本地连接 TDengine 集群,进行数据写入、查询、订阅、schemaless 数据写入、参数绑定接口数据写入等功能。
`TDengine.Connector` 目前暂未提供 REST 连接方式,用户可以参考 [RESTful APIs](https://docs.taosdata.com//reference/restful-api/) 文档自行编写。 `TDengine.Connector` 目前暂未提供 REST 连接方式,用户可以参考 [RESTful APIs](https://docs.taosdata.com//reference/restful-api/) 文档自行编写。
本文介绍如何在 Windows 或 Linux 环境中安装 `TDengine.Connector`,并通过 `TDengine.Connector` 连接 TDengine 数据库,进行数据写入、查询等基本操作。 本文介绍如何在 Windows 或 Linux 环境中安装 `TDengine.Connector`,并通过 `TDengine.Connector` 连接 TDengine 集群,进行数据写入、查询等基本操作。
## 支持的平台 ## 支持的平台
| **CPU 类型** | x64(64bit) | | | 请参考[支持的平台列表](/reference/connector#支持的平台)
| ------------ | ------------ | -------- | -------- |
| **OS 类型** | Linux | Win64 | Win32 |
| **支持与否** | **支持** | **支持** | **支持** |
## 版本支持 ## 版本支持
| TDengine.Connector | TDengine 版本 | 请参考[版本支持列表](/reference/connector#版本支持)
|--------------------|:-------------------------------------:|
| 1.0.2 ~ 1.0.6 | v2.3.4+ |
## 支持的功能特性 ## 支持的功能特性
1. 连接管理 1. 连接管理
2. 同步查询 2. 普通查询
3. 异步查询 3. 连续查询
4. 参数绑定 4. 参数绑定
5. 订阅功能 5. 订阅功能
6. Schemaless 6. Schemaless
...@@ -147,4 +142,5 @@ namespace TDengineExample ...@@ -147,4 +142,5 @@ namespace TDengineExample
一般是因为程序没有找到依赖的客户端驱动。解决方法为:Windows 下可以将 `C:\TDengine\driver\taos.dll` 拷贝到 `C:\Windows\System32\ ` 目录下,Linux 下建立如下软链接 `ln -s /usr/local/taos/driver/libtaos.so.x.x.x.x /usr/lib/libtaos.so` 即可。 一般是因为程序没有找到依赖的客户端驱动。解决方法为:Windows 下可以将 `C:\TDengine\driver\taos.dll` 拷贝到 `C:\Windows\System32\ ` 目录下,Linux 下建立如下软链接 `ln -s /usr/local/taos/driver/libtaos.so.x.x.x.x /usr/lib/libtaos.so` 即可。
## API 参考 ## API 参考
[API 参考](https://docs.taosdata.com/api/connector-csharp/html/860d2ac1-dd52-39c9-e460-0829c4e5a40b.htm) [API 参考](https://docs.taosdata.com/api/connector-csharp/html/860d2ac1-dd52-39c9-e460-0829c4e5a40b.htm)
...@@ -8,31 +8,25 @@ import Preparition from "./_preparition.mdx" ...@@ -8,31 +8,25 @@ import Preparition from "./_preparition.mdx"
## 总体介绍 ## 总体介绍
`driver-go` TDengine 的官方 Go 语言连接器。Go 语言开发人员可以通过它开发存取 TDengine 数据库的应用软件。`driver-go` 实现了 Go 语言[ database/sql ](https://golang.org/pkg/database/sql/) 包的接口。`driver-go` 支持通过客户端驱动程序(taosc)原生连接 TDengine 服务端,支持数据写入、查询、订阅、schemaless 接口和参数绑定接口等功能。也支持使用 REST 连接 TDengine 数据库。REST 连接实现的功能特性集合和原生连接有少量不同。 `driver-go` TDengine 的官方 Go 语言连接器。Go 开发人员可以通过它开发存取 TDengine 集群数据的应用软件。`driver-go` 实现了 Go 语言[ database/sql ](https://golang.org/pkg/database/sql/) 包的接口。`driver-go` 支持通过客户端驱动程序(taosc)原生连接 TDengine 集群,支持数据写入、查询、订阅、schemaless 接口和参数绑定接口等功能。也支持使用 REST 接口连接 TDengine 集群。REST 接口实现的功能特性集合和原生接口有少量不同。
本文介绍如何在 Windows Linux 环境中安装 `driver-go`,并通过 `driver-go` 连接 TDengine 数据库、进行数据查询、数据写入等基本操作。 本文介绍如何在 Windows Linux 环境中安装 `driver-go`,并通过 `driver-go` 连接 TDengine 集群、进行数据查询、数据写入等基本操作。
Go 连接器的源码托管在 GitHub。项目名称:driver-go。欢迎 [贡献源码](https://github.com/taosdata/driver-go) [报告问题](https://github.com/taosdata/driver-go/issues) Go 连接器的源码托管在 GitHub。项目名称:driver-go。欢迎 [贡献源码](https://github.com/taosdata/driver-go) [报告问题](https://github.com/taosdata/driver-go/issues)
## 支持的平台 ## 支持的平台
| **CPU 类型** | x6464bit | | | aarch64 | aarch32 | 请参考[支持的平台列表](/reference/connector#支持的平台)
|------------|------------|--------|--------|---------|---------|
| **OS 类型** | Linux | Win64 | Win32 | Linux | Linux |
| **支持与否** | **支持** | **支持** | **支持** | **支持** | **支持** |
## 版本支持 ## 版本支持
| 分支 | 功能 | 建议 taosd 版本 | 请参考[版本支持列表](/reference/connector#版本支持)
|:-------:|:---------------------------------------------:|:-----------:|
| master | database/sqlcgo)、订阅、schemaless写入、stmt | 2.2.0.0 及以上 |
| develop | database/sqlcgo & REST)、订阅、schemaless写入、stmt | 2.4.0.4及以上 |
## 支持的功能特性 ## 支持的功能特性
### 原生连接 ### 原生连接
“原生连接”指连接器通过客户端驱动(taosc)直接与 TDengine 数据库建立连接。 “原生连接”指连接器通过客户端驱动(taosc)直接与 TDengine 集群建立连接。
* database/sql (cgo 模式) * database/sql (cgo 模式)
* 订阅 * 订阅
...@@ -235,10 +229,6 @@ REST 不支持 stmt 相关接口,建议使用`db.Exec`和`db.Query`。 ...@@ -235,10 +229,6 @@ REST 不支持 stmt 相关接口,建议使用`db.Exec`和`db.Query`。
设置 Go 代理 `go env -w GOPROXY=https://goproxy.cn,direct` 设置 Go 代理 `go env -w GOPROXY=https://goproxy.cn,direct`
## API
全部 API [driver-go 文档](https://pkg.go.dev/github.com/taosdata/driver-go/v2)
### 常用 API ### 常用 API
#### `database/sql` #### `database/sql`
...@@ -342,3 +332,7 @@ stmt 查询,返回 `database/sql/driver` 包的 `Rows` 结构。 ...@@ -342,3 +332,7 @@ stmt 查询,返回 `database/sql/driver` 包的 `Rows` 结构。
* `func (stmt *InsertStmt) Close() error` * `func (stmt *InsertStmt) Close() error`
结束 stmt 结束 stmt
## API 参考
全部 API [driver-go 文档](https://pkg.go.dev/github.com/taosdata/driver-go/v2)
...@@ -8,39 +8,27 @@ import Preparition from "./_preparition.mdx" ...@@ -8,39 +8,27 @@ import Preparition from "./_preparition.mdx"
## 总体介绍 ## 总体介绍
`td2.0-connector` 是 TDengine 的官方 Node.js 连接器。Node.js 开发人员可以通过它开发可以存取 TDengine 数据的应用软件。 `td2.0-connector` 是 TDengine 的官方 Node.js 语言连接器。Node.js 开发人员可以通过它开发可以存取 TDengine 集群数据的应用软件。
## 支持的平台 ## 支持的平台
Node.js 连接器支持的系统有: 请参考[支持的平台列表](/reference/connector#支持的平台)
| **CPU 类型** | x64(64bit) | | | aarch64 | aarch32 |
| ------------ | ------------ | -------- | -------- | -------- | -------- |
| **OS 类型** | Linux | Win64 | Win32 | Linux | Linux |
| **支持与否** | **支持** | **支持** | **支持** | **支持** | **支持** |
## 版本支持 ## 版本支持
| td2.0-connector 版本 | TDengine 版本 | 请参考[版本支持列表](/reference/connector#版本支持)
|--------------------|------------------------------------------------------------------|
| 2.0.7 | ver-2.5.0.x、ver-2.4.x.x、ver-2.3.x.x、ver-2.2.x.x、>ver-2.1.1.0 |
| 2.0.8 | ver-2.5.0.x、ver-2.4.x.x、ver-2.3.x.x、ver-2.2.x.x、>ver-2.1.4.1 |
| 2.0.9 | ver-2.5.0.x、ver-2.4.x.x、ver-2.3.x.x、ver-2.2.x.x、>ver-2.1.4.1 |
| 2.0.10 | 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 |
## 支持的功能特性 ## 支持的功能特性
### 原生连接 ### 原生连接
“原生连接”指连接器通过客户端驱动程序 taosc 直接与 TDengine 数据库建立连接 “原生连接”指连接器通过客户端驱动程序 taosc 直接与 TDengine 集群建立连接
原生连接支持的功能特性如下: 原生连接支持的功能特性如下:
1. 连接管理 1. 连接管理
2. 同步查询 2. 普通查询
3. 异步查询 3. 连续查询
4. 参数绑定 4. 参数绑定
5. 订阅功能 5. 订阅功能
6. Schemaless 6. Schemaless
...@@ -48,8 +36,8 @@ Node.js 连接器支持的系统有: ...@@ -48,8 +36,8 @@ Node.js 连接器支持的系统有:
### REST 连接 ### REST 连接
1. 连接管理 1. 连接管理
2. 同步查询 2. 普通查询
3. Schemaless 3. 连续查询
## 安装步骤 ## 安装步骤
...@@ -59,7 +47,7 @@ Node.js 连接器支持的系统有: ...@@ -59,7 +47,7 @@ Node.js 连接器支持的系统有:
<Preparition /> <Preparition />
- 应用驱动安装请参考[安装连接器驱动步骤](/reference/connector/#安装客户端驱动)。 - 应用驱动安装请参考[安装连接器驱动步骤](/reference/connector/#安装客户端驱动)。
我们使用[node-gyp](https://github.com/nodejs/node-gyp)和 TDengine 服务端进行交互。安装 Node.js 连接器之前,还需要根据具体操作系统来安装下文提到的一些依赖工具。如果要安装的是 REST 连接器则可以跳过以下步骤,直接只用 npm 安装。 我们使用[node-gyp](https://github.com/nodejs/node-gyp)和 TDengine 集群进行交互。安装 Node.js 连接器之前,还需要根据具体操作系统来安装下文提到的一些依赖工具。如果要安装的是 REST 连接器则可以跳过以下步骤,直接只用 npm 安装。
### Linux ### Linux
......
...@@ -8,13 +8,11 @@ import Preparition from "./_preparition.mdx" ...@@ -8,13 +8,11 @@ import Preparition from "./_preparition.mdx"
[![Crates.io](https://img.shields.io/crates/v/libtaos)](https://crates.io/crates/libtaos) ![Crates.io](https://img.shields.io/crates/d/libtaos) [![docs.rs](https://img.shields.io/docsrs/libtaos)](https://docs.rs/libtaos) [![Crates.io](https://img.shields.io/crates/v/libtaos)](https://crates.io/crates/libtaos) ![Crates.io](https://img.shields.io/crates/d/libtaos) [![docs.rs](https://img.shields.io/docsrs/libtaos)](https://docs.rs/libtaos)
`libtaos` 是 TDengine 的官方 Rust 语言连接器。Rust 语言开发人员可以通过它开发存取 TDengine 数据库的应用软件。`libtaos` 使用不同的 “特性(Rust Cargo 包管理关键字 features)” 提供对通过客户端驱动程序(taosc)原生连接和使用 REST 连接 TDengine 数据库。以下是可使用的特性列表: `libtaos` 是 TDengine 的官方 Rust 语言连接器。Rust 开发人员可以通过它开发存取 TDengine 数据库的应用软件。`libtaos` 使用不同的 “特性(Cargo 关键字 features)” 提供对通过客户端驱动程序(taosc)原生连接和使用 REST 连接 TDengine 集群。以下是可使用的特性列表:
| 启用特性 | 支持平台 | 说明 | ## 支持的平台
| -------- | --------------------- | ----------------------------------------------------------------- |
| default | Windows, Linux | 使用 TDengine 客户端驱动(taosc),支持 STMT 接口和行协议接口 | 请参考[支持的平台列表](/reference/connector#支持的平台)
| rest | Windows, Linux, macOS | 使用 HTTP REST API 接口(rest),适用于全平台 |
| (+)r2d2 | - | 使用 [r2d2] 提供的连接池接口,需要与 default 或 rest 特性配合使用 |
:::warning :::warning
...@@ -24,11 +22,7 @@ Rust 连接器仍然在快速开发中,1.0 之前无法保证其向后兼容 ...@@ -24,11 +22,7 @@ Rust 连接器仍然在快速开发中,1.0 之前无法保证其向后兼容
## 版本支持 ## 版本支持
| 驱动 | 平台 | 最小支持版本 | 请参考[版本支持列表](/reference/connector#版本支持)
| :---: | :-----: | :--------------------------------: |
| taosc | Windows | 2.0.20.10 (行协议接口 >= 2.4.0.0) |
| taosc | Linux | 2.0.6.0 (行协议接口 >= 2.4.0.0) |
| rest | All | 2.0.0.0 (不支持 STMT 和行协议接口) |
建议使用 2.4 版本以上的 TDengine,以避免已知问题。 建议使用 2.4 版本以上的 TDengine,以避免已知问题。
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册