From e2b660c0832508fb4846adbe14aed3b3e78ca357 Mon Sep 17 00:00:00 2001 From: dingbo Date: Sun, 1 May 2022 11:48:04 +0800 Subject: [PATCH] docs: unifiy name of native/rest connect --- docs-cn/14-reference/03-connector/go.mdx | 14 +++++++------- docs-cn/14-reference/03-connector/java.mdx | 12 ++++++------ docs-cn/14-reference/03-connector/node.mdx | 8 ++++---- docs-cn/14-reference/03-connector/python.mdx | 4 ++-- docs-cn/14-reference/03-connector/rust.mdx | 14 +++++++------- 5 files changed, 26 insertions(+), 26 deletions(-) diff --git a/docs-cn/14-reference/03-connector/go.mdx b/docs-cn/14-reference/03-connector/go.mdx index 2c73443a1c..c5f448916a 100644 --- a/docs-cn/14-reference/03-connector/go.mdx +++ b/docs-cn/14-reference/03-connector/go.mdx @@ -17,7 +17,7 @@ import GoQuery from "../../04-develop/04-query-data/_go.mdx" `driver-go` 是 TDengine 的官方 Go 语言连接器，实现了 Go 语言[ database/sql ](https://golang.org/pkg/database/sql/) 包的接口。Go 开发人员可以通过它开发存取 TDengine 集群数据的应用软件。 -`driver-go` 提供两种形式的连接器。一种是**原生连接器**，它通过 TDengine 客户端驱动程序（taosc）原生连接 TDengine 运行实例，支持数据写入、查询、订阅、schemaless 接口和参数绑定接口等功能。另外一种是 **REST 连接器**，它通过 taosAdapter 提供的 REST 接口连接 TDengine 运行实例。REST 连接实现的功能特性集合和原生连接有少量不同。 +`driver-go` 提供两种建立连接的方式。一种是**原生连接**，它通过 TDengine 客户端驱动程序（taosc）原生连接 TDengine 运行实例，支持数据写入、查询、订阅、schemaless 接口和参数绑定接口等功能。另外一种是 **REST 连接**，它通过 taosAdapter 提供的 REST 接口连接 TDengine 运行实例。REST 连接实现的功能特性集合和原生连接有少量不同。 本文介绍如何安装 `driver-go`，并通过 `driver-go` 连接 TDengine 集群、进行数据查询、数据写入等基本操作。 @@ -25,8 +25,8 @@ import GoQuery from "../../04-develop/04-query-data/_go.mdx" ## 支持的平台 -原生连接器支持的平台和 TDengine 客户端驱动支持的平台一致。 -REST 连接器支持所有能运行 Go 的平台。 +原生连接支持的平台和 TDengine 客户端驱动支持的平台一致。 +REST 连接支持所有能运行 Go 的平台。 ## 版本支持 @@ -34,7 +34,7 @@ REST 连接器支持所有能运行 Go 的平台。 ## 支持的功能特性 -### 原生连接器 +### 原生连接 “原生连接”指连接器通过 TDengine 客户端驱动（taosc）直接与 TDengine 运行实例建立的连接。支持的功能特性有： @@ -44,7 +44,7 @@ REST 连接器支持所有能运行 Go 的平台。 * schemaless 接口 * 参数绑定接口 -### REST 连接器 +### REST 连接 "REST 连接"指连接器通过 taosAdapter 组件提供的 REST API 与 TDengine 运行实例建立的连接。支持的功能特性有： @@ -115,7 +115,7 @@ username:password@protocol(address)/dbname?param=value ### 使用连接器进行连接 - + _taosSql_ 通过 cgo 实现了 Go 的 `database/sql/driver` 接口。只需要引入驱动就可以使用 [`database/sql`](https://golang.org/pkg/database/sql/) 的接口。 @@ -146,7 +146,7 @@ func main() { ``` - + _taosRestful_ 通过 `http client` 实现了 Go 的 `database/sql/driver` 接口。只需要引入驱动就可以使用[`database/sql`](https://golang.org/pkg/database/sql/)的接口。 diff --git a/docs-cn/14-reference/03-connector/java.mdx b/docs-cn/14-reference/03-connector/java.mdx index 293deb4fe6..970f8aeb7f 100644 --- a/docs-cn/14-reference/03-connector/java.mdx +++ b/docs-cn/14-reference/03-connector/java.mdx @@ -18,7 +18,7 @@ import TabItem from '@theme/TabItem'; - JDBC 原生连接：Java 应用在物理节点 1（pnode1）上使用 TSDBDriver 直接调用客户端驱动（libtaos.so 或 taos.dll）的 API 将写入和查询请求发送到位于物理节点 2（pnode2）上的 taosd 实例。 - JDBC REST 连接：Java 应用通过 RestfulDriver 将 SQL 封装成一个 REST 请求，发送给物理节点 2 的 REST 服务器（taosAdapter），通过 REST 服务器请求 taosd 并返回结果。 -使用 REST 连接器，不依赖 TDengine 客户端驱动，可以跨平台，更加方便灵活，但性能比原生连接器低约 30%。 +使用 REST 连接，不依赖 TDengine 客户端驱动，可以跨平台，更加方便灵活，但性能比原生连接器低约 30%。 :::info TDengine 的 JDBC 驱动实现尽可能与关系型数据库驱动保持一致，但 TDengine 与关系对象型数据库的使用场景和技术特征存在差异，所以`taos-jdbcdriver` 与传统的 JDBC driver 也存在一定差异。在使用时需要注意以下几点： @@ -30,8 +30,8 @@ TDengine 的 JDBC 驱动实现尽可能与关系型数据库驱动保持一致 ## 支持的平台 -原生连接器支持的平台和 TDengine 客户端驱动支持的平台一致。 -REST 连接器支持所有能运行 Java 的平台。 +原生连接支持的平台和 TDengine 客户端驱动支持的平台一致。 +REST 连接支持所有能运行 Java 的平台。 ## 版本支持 @@ -108,10 +108,10 @@ mvn clean install -Dmaven.test.skip=true TDengine 的 JDBC URL 规范格式为： `jdbc:[TAOS|TAOS-RS]://[host_name]:[port]/[database_name]?[user={user}|&password={password}|&charset={charset}|&cfgdir={config_dir}|&locale={locale}|&timezone={timezone}]` -对于建立连接，原生连接器与 REST 连接器有细微不同。 +对于建立连接，原生连接与 REST 连接有细微不同。 - + ```java Class.forName("com.taosdata.jdbc.TSDBDriver"); @@ -178,7 +178,7 @@ TDengine 中，只要保证 firstEp 和 secondEp 中一个节点有效，就可 > **注意**：这里的配置文件指的是调用 JDBC Connector 的应用程序所在机器上的配置文件，Linux OS 上默认值 /etc/taos/taos.cfg ，Windows OS 上默认值 C://TDengine/cfg/taos.cfg。 - + ```java Class.forName("com.taosdata.jdbc.rs.RestfulDriver"); diff --git a/docs-cn/14-reference/03-connector/node.mdx b/docs-cn/14-reference/03-connector/node.mdx index c95e0dfaed..3a79e78ed0 100644 --- a/docs-cn/14-reference/03-connector/node.mdx +++ b/docs-cn/14-reference/03-connector/node.mdx @@ -127,7 +127,7 @@ node nodejsChecker.js host=localhost 请选择使用一种连接器。 - + 安装并引用 `td2.0-connector` 包。 @@ -148,7 +148,7 @@ conn.close(); ``` - + 安装并引用 `td2.0-rest-connector` 包。 @@ -240,7 +240,7 @@ Node.js 连接器的使用参见[视频教程](https://www.taosdata.com/blog/202 ## 重要更新记录 -### 原生接口连接器 +### 原生连接器 | td2.0-connector 版本 | 说明 | | -------------------- | ---------------------------------------------------------------- | @@ -248,7 +248,7 @@ Node.js 连接器的使用参见[视频教程](https://www.taosdata.com/blog/202 | 2.0.11 | 支持绑定参数、json tag、schemaless 接口等功能。 | | 2.0.10 | 支持连接管理，普通查询、连续查询、获取系统信息、订阅功能等功能。 | -### REST 接口连接器 +### REST 连接器 | td2.0-rest-connector 版本 | 说明 | | ------------------------- | ---------------------------------------------------------------- | diff --git a/docs-cn/14-reference/03-connector/python.mdx b/docs-cn/14-reference/03-connector/python.mdx index 5965e3d04e..53928baa84 100644 --- a/docs-cn/14-reference/03-connector/python.mdx +++ b/docs-cn/14-reference/03-connector/python.mdx @@ -26,8 +26,8 @@ Python 连接器的源码托管在 [GitHub](https://github.com/taosdata/taos-con ## 支持的功能 -- 原生连接支持 TDeingine 的所有核心功能， 包括： 连接管理、查询(包括写入)、参数绑定、订阅、无模式写入（Schemaless）。 -- REST 连接目前仅支持查询功能。 +- 原生连接支持 TDeingine 的所有核心功能， 包括： 连接管理、执行 SQL、参数绑定、订阅、无模式写入（schemaless）。 +- REST 连接支持的功能包括：连接管理、执行 SQL。 (通过执行 SQL 可以： 管理数据库、管理表和超级表、写入数据、查询数据、创建连续查询等)。 ## 安装 diff --git a/docs-cn/14-reference/03-connector/rust.mdx b/docs-cn/14-reference/03-connector/rust.mdx index 2f7f466ca2..b6aac45c6a 100644 --- a/docs-cn/14-reference/03-connector/rust.mdx +++ b/docs-cn/14-reference/03-connector/rust.mdx @@ -19,14 +19,14 @@ import RustQuery from "../../04-develop/04-query-data/_rust.mdx" `libtaos` 是 TDengine 的官方 Rust 语言连接器。Rust 开发人员可以通过它开发存取 TDengine 数据库的应用软件。 -`libtaos` 提供两种形式的连接器。一种是**原生连接器**，它通过 TDengine 客户端驱动程序（taosc）连接 TDengine 运行实例。另外一种是 **REST 连接器**，它通过 taosAdapter 的 REST 接口连接 TDengine 运行实例。你可以通过不同的 “特性（即 Cargo 关键字 features）” 来指定使用哪种连接器。REST 连接器可以在任何平台运行，但原生连接器依赖 TDengine 客户端能运行的平台。 +`libtaos` 提供两种建立连接的方式。一种是**原生连接**，它通过 TDengine 客户端驱动程序（taosc）连接 TDengine 运行实例。另外一种是 **REST 连接**，它通过 taosAdapter 的 REST 接口连接 TDengine 运行实例。你可以通过不同的 “特性（即 Cargo 关键字 features）” 来指定使用哪种连接器。REST 连接支持任何平台，但原生连接支持所有 TDengine 客户端能运行的平台。 `libtaos` 的源码托管在 [GitHub](https://github.com/taosdata/libtaos-rs)。 ## 支持的平台 -原生连接器支持的平台和 TDengine 客户端驱动支持的平台一致。 -REST 连接器支持所有能运行 Rust 的平台。 +原生连接支持的平台和 TDengine 客户端驱动支持的平台一致。 +REST 连接支持所有能运行 Rust 的平台。 ## 版本支持 @@ -38,14 +38,14 @@ Rust 连接器仍然在快速开发中，1.0 之前无法保证其向后兼容 ### 安装前准备 * 安装 Rust 开发工具链 -* 如果使用原生连接器，请安装 TDengine 客户端驱动，具体步骤请参考[安装客户端驱动](/reference/connector#安装客户端驱动) +* 如果使用原生连接，请安装 TDengine 客户端驱动，具体步骤请参考[安装客户端驱动](/reference/connector#安装客户端驱动) ### 添加 libtaos 依赖 -根据选择的连接器，按照如下说明在 [Rust](https://rust-lang.org) 项目中添加 [libtaos][libtaos] 依赖： +根据选择的连接方式，按照如下说明在 [Rust](https://rust-lang.org) 项目中添加 [libtaos][libtaos] 依赖： - + 在 `Cargo.toml` 文件中添加 [libtaos][libtaos]： @@ -56,7 +56,7 @@ libtaos = "*" ``` - + 在 `Cargo.toml` 文件中添加 [libtaos][libtaos]，并启用 `rest` 特性。 -- GitLab