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

docs: connector refine (#11925)

* 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

* docs: refine connector docs

[TD-14839]

* docs: refine connector doc

[TD-14839]

* docs: refine connector docs

[TD-14839]

* docs: fix node.mdx

[TD-14839]

* docs: refine connector

[TD-14839]

* docs: refine cpp connector

[TD-14839]

* docs: correct bind parameter interface name

[TD-14839]

* docs: refine connector docs

[TD-14839]

* docs: refine connector

[TD-14839]

* docs: refine connector

[TD-14839]

* docs: refine connector docs

[TD-14839]

* docs: refine connector

[TD-14839]
上级 976228e5
...@@ -49,7 +49,8 @@ import CSAsyncQuery from "../../04-develop/04-query-data/_cs_async.mdx" ...@@ -49,7 +49,8 @@ import CSAsyncQuery from "../../04-develop/04-query-data/_cs_async.mdx"
### 使用 dotnet CLI 安装 ### 使用 dotnet CLI 安装
#### 使用 dotnet CLI 获取 C# 驱动 <Tabs defaultValue="CLI">
<TabItem value="CLI" label="使用 dotnet CLI 获取 C# 驱动">
可以在当前 .NET 项目的路径下,通过 dotnet 命令引用 Nuget 中发布的 `TDengine.Connector` 到当前项目。 可以在当前 .NET 项目的路径下,通过 dotnet 命令引用 Nuget 中发布的 `TDengine.Connector` 到当前项目。
...@@ -57,7 +58,8 @@ import CSAsyncQuery from "../../04-develop/04-query-data/_cs_async.mdx" ...@@ -57,7 +58,8 @@ import CSAsyncQuery from "../../04-develop/04-query-data/_cs_async.mdx"
dotnet add package TDengine.Connector dotnet add package TDengine.Connector
``` ```
#### 使用源码获取 C# 驱动 </TabItem>
<TabItem value="source" label="使用源码获取 C# 驱动">
可以下载 TDengine 的源码,直接引用最新版本的 TDengine.Connector 库 可以下载 TDengine 的源码,直接引用最新版本的 TDengine.Connector 库
...@@ -69,6 +71,8 @@ cp -r TDengineDriver/ myProject ...@@ -69,6 +71,8 @@ cp -r TDengineDriver/ myProject
cd myProject cd myProject
dotnet add TDengineDriver/TDengineDriver.csproj dotnet add TDengineDriver/TDengineDriver.csproj
``` ```
</TabItem>
</Tabs>
## 建立连接 ## 建立连接
......
...@@ -77,7 +77,9 @@ REST 连接指连接器通过 taosAdapter 组件提供的 REST API 建立与 tao ...@@ -77,7 +77,9 @@ REST 连接指连接器通过 taosAdapter 组件提供的 REST API 建立与 tao
username:password@protocol(address)/dbname?param=value username:password@protocol(address)/dbname?param=value
``` ```
### 建立原生连接 <Tabs defaultValue="native">
<TabItem value="native" label="原生连接">
### 原生连接
_taosSql_ 通过 cgo 实现了 Go `database/sql/driver` 接口。只需要引入驱动就可以使用 [`database/sql`](https://golang.org/pkg/database/sql/) 的接口。 _taosSql_ 通过 cgo 实现了 Go `database/sql/driver` 接口。只需要引入驱动就可以使用 [`database/sql`](https://golang.org/pkg/database/sql/) 的接口。
...@@ -107,7 +109,9 @@ func main() { ...@@ -107,7 +109,9 @@ func main() {
} }
``` ```
### 建立 REST 连接 </TabItem>
<TabItem value="rest" label="REST 连接">
### REST 连接
_taosRestful_ 通过 `http client` 实现了 Go `database/sql/driver` 接口。只需要引入驱动就可以使用[`database/sql`](https://golang.org/pkg/database/sql/)的接口。 _taosRestful_ 通过 `http client` 实现了 Go `database/sql/driver` 接口。只需要引入驱动就可以使用[`database/sql`](https://golang.org/pkg/database/sql/)的接口。
...@@ -137,6 +141,8 @@ func main() { ...@@ -137,6 +141,8 @@ func main() {
} }
} }
``` ```
</TabItem>
</Tabs>
## 使用示例 ## 使用示例
......
...@@ -58,14 +58,16 @@ import NodeAsyncQuery from "../../04-develop/04-query-data/_js_async.mdx" ...@@ -58,14 +58,16 @@ import NodeAsyncQuery from "../../04-develop/04-query-data/_js_async.mdx"
- 应用驱动安装请参考[安装连接器驱动步骤](/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 <Tabs defaultValue="Linux">
<TabItem value="Linux" label="Linux">
- `python` (建议`v2.7` , `v3.x.x` 目前还不支持) - `python` (建议`v2.7` , `v3.x.x` 目前还不支持)
- `td2.0-connector` 2.0.6 支持 Node.js LTS v10.9.0 或更高版本, Node.js LTS v12.8.0 或更高版本;2.0.5 及更早版本支持 Node.js LTS v10.x 版本。其他版本可能存在包兼容性的问题 - `td2.0-connector` 2.0.6 支持 Node.js LTS v10.9.0 或更高版本, Node.js LTS v12.8.0 或更高版本;2.0.5 及更早版本支持 Node.js LTS v10.x 版本。其他版本可能存在包兼容性的问题
- `make` - `make`
- C 语言编译器,[GCC](https://gcc.gnu.org) v4.8.5 或更高版本 - C 语言编译器,[GCC](https://gcc.gnu.org) v4.8.5 或更高版本
### Windows </TabItem>
<TabItem value="Windows" label="Windows">
#### 安装方法 1 #### 安装方法 1
...@@ -82,20 +84,28 @@ import NodeAsyncQuery from "../../04-develop/04-query-data/_js_async.mdx" ...@@ -82,20 +84,28 @@ import NodeAsyncQuery from "../../04-develop/04-query-data/_js_async.mdx"
参考微软的 Node.js 用户手册[ Microsoft's Node.js Guidelines for Windows](https://github.com/Microsoft/nodejs-guidelines/blob/master/windows-environment.md#compiling-native-addon-modules)。 参考微软的 Node.js 用户手册[ Microsoft's Node.js Guidelines for Windows](https://github.com/Microsoft/nodejs-guidelines/blob/master/windows-environment.md#compiling-native-addon-modules)。
如果在 Windows 10 ARM 上使用 ARM64 Node.js,还需添加 "Visual C++ compilers and libraries for ARM64" 和 "Visual C++ ATL for ARM64"。 如果在 Windows 10 ARM 上使用 ARM64 Node.js,还需添加 "Visual C++ compilers and libraries for ARM64" 和 "Visual C++ ATL for ARM64"。
</TabItem>
</Tabs>
### 使用 npm 安装 ### 使用 npm 安装
<Tabs defaultValue="native">
<TabItem value="native" label="安装客户端驱动连接器">
- 安装客户端驱动连接器 - 安装客户端驱动连接器
``` bash ``` bash
npm install td2.0-connector npm install td2.0-connector
``` ```
- 安装 REST 连接器 </TabItem>
<TabItem value="REST" label="安装 REST 连接器">
```bash ```bash
npm i td2.0-rest-connector npm i td2.0-rest-connector
``` ```
</TabItem>
</Tabs>
### 安装验证 ### 安装验证
...@@ -117,7 +127,9 @@ node nodejsChecker.js host=localhost ...@@ -117,7 +127,9 @@ node nodejsChecker.js host=localhost
## 建立连接 ## 建立连接
### 建立连接 <Tabs defaultValue="native">
<TabItem value="native" label="原生连接">
### 原生连接
安装并引用 `td2.0-connector` 包。 安装并引用 `td2.0-connector` 包。
...@@ -131,7 +143,9 @@ var cursor = conn.cursor(); // Initializing a new cursor ...@@ -131,7 +143,9 @@ var cursor = conn.cursor(); // Initializing a new cursor
conn.close(); conn.close();
``` ```
### 建立 REST 连接 </TabItem>
<TabItem value="rest" label="REST 连接">
### REST 连接
安装并引用 `td2.0-rest-connector` 包。 安装并引用 `td2.0-rest-connector` 包。
...@@ -147,6 +161,8 @@ let conn = connect(options); ...@@ -147,6 +161,8 @@ let conn = connect(options);
let cursor = conn.cursor(); let cursor = conn.cursor();
``` ```
</TabItem>
</Tabs>
## 使用示例 ## 使用示例
......
...@@ -43,7 +43,9 @@ Rust 连接器仍然在快速开发中,1.0 之前无法保证其向后兼容 ...@@ -43,7 +43,9 @@ Rust 连接器仍然在快速开发中,1.0 之前无法保证其向后兼容
之后可以按照如下说明在 [Rust](https://rust-lang.org) 项目中添加 [libtaos][libtaos] 依赖: 之后可以按照如下说明在 [Rust](https://rust-lang.org) 项目中添加 [libtaos][libtaos] 依赖:
### 使用客户端驱动 <Tabs defaultValue="native">
<TabItem value="native" label="原生连接">
### 原生连接
在 `Cargo.toml` 文件中添加 [libtaos][libtaos]: 在 `Cargo.toml` 文件中添加 [libtaos][libtaos]:
...@@ -53,7 +55,9 @@ Rust 连接器仍然在快速开发中,1.0 之前无法保证其向后兼容 ...@@ -53,7 +55,9 @@ Rust 连接器仍然在快速开发中,1.0 之前无法保证其向后兼容
libtaos = "*" libtaos = "*"
``` ```
### 使用 REST 接口 </TabItem>
<TabItem value="rest" label="REST 连接">
### REST 连接
在 `Cargo.toml` 文件中添加 [libtaos][libtaos],并启用 `rest` 特性。 在 `Cargo.toml` 文件中添加 [libtaos][libtaos],并启用 `rest` 特性。
...@@ -63,6 +67,8 @@ libtaos = "*" ...@@ -63,6 +67,8 @@ libtaos = "*"
libtaos = { version = "*", features = ["rest"]} libtaos = { version = "*", features = ["rest"]}
``` ```
</TabItem>
<TabItem value="rest" label="使用连接池">
### 使用连接池 ### 使用连接池
选择使用客户端驱动或 REST 接口,并在 `Cargo.toml` 中启用 `r2d2` 特性。 选择使用客户端驱动或 REST 接口,并在 `Cargo.toml` 中启用 `r2d2` 特性。
...@@ -74,6 +80,8 @@ libtaos = { version = "*", features = ["r2d2"] } ...@@ -74,6 +80,8 @@ libtaos = { version = "*", features = ["r2d2"] }
# or rest # or rest
libtaos = { version = "*", features = ["rest", "r2d2"] } libtaos = { version = "*", features = ["rest", "r2d2"] }
``` ```
</TabItem>
</Tabs>
## 建立连接 ## 建立连接
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册