From 3ddca68ec4f716ab26a088c937e0e98460a69399 Mon Sep 17 00:00:00 2001 From: Shuduo Sang Date: Wed, 27 Apr 2022 13:25:31 +0800 Subject: [PATCH] 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] --- docs-cn/14-reference/03-connector/csharp.mdx | 8 ++++-- docs-cn/14-reference/03-connector/go.mdx | 10 ++++++-- docs-cn/14-reference/03-connector/node.mdx | 26 ++++++++++++++++---- docs-cn/14-reference/03-connector/rust.mdx | 12 +++++++-- 4 files changed, 45 insertions(+), 11 deletions(-) diff --git a/docs-cn/14-reference/03-connector/csharp.mdx b/docs-cn/14-reference/03-connector/csharp.mdx index 66a3fc7c88..3f81320a64 100644 --- a/docs-cn/14-reference/03-connector/csharp.mdx +++ b/docs-cn/14-reference/03-connector/csharp.mdx @@ -49,7 +49,8 @@ import CSAsyncQuery from "../../04-develop/04-query-data/_cs_async.mdx" ### 使用 dotnet CLI 安装 -#### 使用 dotnet CLI 获取 C# 驱动 + + 可以在当前 .NET 项目的路径下，通过 dotnet 命令引用 Nuget 中发布的 `TDengine.Connector` 到当前项目。 @@ -57,7 +58,8 @@ import CSAsyncQuery from "../../04-develop/04-query-data/_cs_async.mdx" dotnet add package TDengine.Connector ``` -#### 使用源码获取 C# 驱动 + + 可以下载 TDengine 的源码，直接引用最新版本的 TDengine.Connector 库 @@ -69,6 +71,8 @@ cp -r TDengineDriver/ myProject cd myProject dotnet add TDengineDriver/TDengineDriver.csproj ``` + + ## 建立连接 diff --git a/docs-cn/14-reference/03-connector/go.mdx b/docs-cn/14-reference/03-connector/go.mdx index 2b4c548ad5..2f79ded05c 100644 --- a/docs-cn/14-reference/03-connector/go.mdx +++ b/docs-cn/14-reference/03-connector/go.mdx @@ -77,7 +77,9 @@ REST 连接指连接器通过 taosAdapter 组件提供的 REST API 建立与 tao username:password@protocol(address)/dbname?param=value ``` -### 建立原生连接 + + +### 原生连接 _taosSql_ 通过 cgo 实现了 Go 的 `database/sql/driver` 接口。只需要引入驱动就可以使用 [`database/sql`](https://golang.org/pkg/database/sql/) 的接口。 @@ -107,7 +109,9 @@ func main() { } ``` -### 建立 REST 连接 + + +### REST 连接 _taosRestful_ 通过 `http client` 实现了 Go 的 `database/sql/driver` 接口。只需要引入驱动就可以使用[`database/sql`](https://golang.org/pkg/database/sql/)的接口。 @@ -137,6 +141,8 @@ func main() { } } ``` + + ## 使用示例 diff --git a/docs-cn/14-reference/03-connector/node.mdx b/docs-cn/14-reference/03-connector/node.mdx index a58ca824f0..919253999c 100644 --- a/docs-cn/14-reference/03-connector/node.mdx +++ b/docs-cn/14-reference/03-connector/node.mdx @@ -58,14 +58,16 @@ import NodeAsyncQuery from "../../04-develop/04-query-data/_js_async.mdx" - 应用驱动安装请参考[安装连接器驱动步骤](/reference/connector/#安装客户端驱动)。 我们使用[node-gyp](https://github.com/nodejs/node-gyp)和 TDengine 集群进行交互。安装 Node.js 连接器之前，还需要根据具体操作系统来安装下文提到的一些依赖工具。如果要安装的是 REST 连接器则可以跳过以下步骤，直接只用 npm 安装。 -### Linux + + - `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 版本。其他版本可能存在包兼容性的问题 - `make` - C 语言编译器，[GCC](https://gcc.gnu.org) v4.8.5 或更高版本 -### Windows + + #### 安装方法 1 @@ -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)。 如果在 Windows 10 ARM 上使用 ARM64 Node.js，还需添加 "Visual C++ compilers and libraries for ARM64" 和 "Visual C++ ATL for ARM64"。 + + ### 使用 npm 安装 + + + - 安装客户端驱动连接器 ``` bash npm install td2.0-connector ``` -- 安装 REST 连接器 + + ```bash npm i td2.0-rest-connector ``` + + ### 安装验证 @@ -117,7 +127,9 @@ node nodejsChecker.js host=localhost ## 建立连接 -### 建立连接 + + +### 原生连接 安装并引用 `td2.0-connector` 包。 @@ -131,7 +143,9 @@ var cursor = conn.cursor(); // Initializing a new cursor conn.close(); ``` -### 建立 REST 连接 + + +### REST 连接 安装并引用 `td2.0-rest-connector` 包。 @@ -147,6 +161,8 @@ let conn = connect(options); let cursor = conn.cursor(); ``` + + ## 使用示例 diff --git a/docs-cn/14-reference/03-connector/rust.mdx b/docs-cn/14-reference/03-connector/rust.mdx index 91d78b3c7b..fcbcf86109 100644 --- a/docs-cn/14-reference/03-connector/rust.mdx +++ b/docs-cn/14-reference/03-connector/rust.mdx @@ -43,7 +43,9 @@ Rust 连接器仍然在快速开发中，1.0 之前无法保证其向后兼容 之后可以按照如下说明在 [Rust](https://rust-lang.org) 项目中添加 [libtaos][libtaos] 依赖： -### 使用客户端驱动 + + +### 原生连接 在 `Cargo.toml` 文件中添加 [libtaos][libtaos]： @@ -53,7 +55,9 @@ Rust 连接器仍然在快速开发中，1.0 之前无法保证其向后兼容 libtaos = "*" ``` -### 使用 REST 接口 + + +### REST 连接 在 `Cargo.toml` 文件中添加 [libtaos][libtaos]，并启用 `rest` 特性。 @@ -63,6 +67,8 @@ libtaos = "*" libtaos = { version = "*", features = ["rest"]} ``` + + ### 使用连接池 选择使用客户端驱动或 REST 接口，并在 `Cargo.toml` 中启用 `r2d2` 特性。 @@ -74,6 +80,8 @@ libtaos = { version = "*", features = ["r2d2"] } # or rest libtaos = { version = "*", features = ["rest", "r2d2"] } ``` + + ## 建立连接 -- GitLab