diff --git a/docs-cn/14-reference/03-connector/_linux_install.mdx b/docs-cn/14-reference/03-connector/_linux_install.mdx index bcdd85465f168b59afa25ce253c3f37b9f64f67f..be363395cb6340a00ea0e51a0facc57a0340b301 100644 --- a/docs-cn/14-reference/03-connector/_linux_install.mdx +++ b/docs-cn/14-reference/03-connector/_linux_install.mdx @@ -21,6 +21,6 @@ :::tip 1. 如本机没有部署 TDengine 服务，仅安装了应用驱动，则 taos.cfg 中仅需配置 firstEP，无需在本机配置 FQDN。 -2. 为防止与服务器端连接时出现“unable to resolve FQDN”错误，建议确认本机的 hosts 文件已经配置了服务器正确的 FQDN 值，或配置好了 DNS 服务。 +2. 为防止与服务器端连接时出现“Unable to resolve FQDN”错误，建议确认本机的 hosts 文件已经配置了服务器正确的 FQDN 值，或配置好了 DNS 服务。 ::: diff --git a/docs-cn/14-reference/03-connector/_preparition.mdx b/docs-cn/14-reference/03-connector/_preparition.mdx index 2a055183ee2c128890cfb4cee5e521f8bd914420..1fe430683dc75e4edf9961950bbb8af52bd189d7 100644 --- a/docs-cn/14-reference/03-connector/_preparition.mdx +++ b/docs-cn/14-reference/03-connector/_preparition.mdx @@ -1,6 +1,10 @@ - 已安装客户端驱动（使用原生连接必须安装，使用 REST 连接无需安装） -**注意**：由于 TDengine 的应用驱动是使用 C 语言开发的，使用原生连接时需要依赖系统对应的安装在本地的函数库，包含在 TDengine 客户端安装包。TDengine Linux 服务端安装包附带了 TDengine 客户端，也可以单独安装 [Linux 客户端](/get-started/) 。在 Windows 环境开发时需要安装 TDengine 对应的 [Windows 客户端](https://www.taosdata.com/cn/all-downloads/#TDengine-Windows-Client) 连接远端 TDengine 集群。 +:::info + +由于 TDengine 的应用驱动是使用 C 语言开发的，使用原生连接时需要依赖系统对应的安装在本地的函数库，包含在 TDengine 客户端安装包。TDengine Linux 服务端安装包附带了 TDengine 客户端，也可以单独安装 [Linux 客户端](/get-started/) 。在 Windows 环境开发时需要安装 TDengine 对应的 [Windows 客户端](https://www.taosdata.com/cn/all-downloads/#TDengine-Windows-Client) 连接远端 TDengine 集群。 - libtaos.so 在 Linux 系统中成功安装 TDengine 后，依赖的 Linux 版客户端驱动 libtaos.so 文件会被自动拷贝至 /usr/lib/libtaos.so，该目录包含在 Linux 自动扫描路径上，无需单独指定。 - taos.dll 在 Windows 系统中安装完客户端之后，依赖的 Windows 版客户端驱动 taos.dll 文件会自动拷贝到系统默认搜索路径 C:/Windows/System32 下，同样无需要单独指定。 + +::: diff --git a/docs-cn/14-reference/03-connector/cpp.mdx b/docs-cn/14-reference/03-connector/cpp.mdx index ac5870186222973a680136bf6c660a81eb9ca7b8..f4057597dee27fbd7a4389b6dc65566d2150f684 100644 --- a/docs-cn/14-reference/03-connector/cpp.mdx +++ b/docs-cn/14-reference/03-connector/cpp.mdx @@ -48,7 +48,7 @@ TDengine 服务端或客户端安装后，taos.h 位于： - `void taos_init()` - 初始化运行环境。如果应用没有主动调用该 API，那么应用在调用`taos_connect()`时将自动调用，故应用程序一般无需手动调用该 API。 + 初始化运行环境。如果应用没有主动调用该 API，那么应用在调用 `taos_connect()` 时将自动调用，故应用程序一般无需手动调用该 API。 - `void taos_cleanup()` @@ -75,7 +75,7 @@ TDengine 服务端或客户端安装后，taos.h 位于： 返回值为空表示失败。应用程序需要保存返回的参数，以便后续 API 调用。 :::info - 同一进程可以根据不同的 host/port 连接多个 taosd 集群 + 同一进程可以根据不同的 host/port 连接多个 TDengine 集群 ::: @@ -89,7 +89,7 @@ TDengine 服务端或客户端安装后，taos.h 位于： - `void taos_close(TAOS *taos)` - 关闭连接，其中`taos`是`taos_connect`函数返回的指针。 + 关闭连接，其中`taos`是 `taos_connect()` 函数返回的指针。 ## 同步查询 API @@ -97,7 +97,7 @@ TDengine 服务端或客户端安装后，taos.h 位于： - `TAOS_RES* taos_query(TAOS *taos, const char *sql)` - 该 API 用来执行 SQL 语句，可以是 DQL、DML 或 DDL 语句。 其中的 `taos` 参数是通过 `taos_connect()` 获得的指针。不能通过返回值是否是 NULL 来判断执行结果是否失败，而是需要用 `taos_errno()` 函数解析结果集中的错误代码来进行判断。 + 该 API 用来执行 SQL 语句，可以是 DQL、DML 或 DDL 语句。 其中的 `taos` 参数是通过 `taos_connect()` 获得的指针。不能通过返回值是否是 `NULL` 来判断执行结果是否失败，而是需要用 `taos_errno()` 函数解析结果集中的错误代码来进行判断。 - `int taos_result_precision(TAOS_RES *res)` @@ -170,7 +170,7 @@ typedef struct taosField { - taos：调用 `taos_connect()` 返回的数据库连接 - sql：需要执行的 SQL 语句 - - fp：用户定义的回调函数，其第三个参数 `code` 用于指示操作是否成功，`0` 表示成功，负数表示失败(调用 `taos_errstr()` 获取失败原因)。应用在定义回调函数的时候，主要处理第二个参数 `TAOS_RES *`，该参数是查询返回的结果集 + - fp：用户定义的回调函数，其第三个参数 `code` 用于指示操作是否成功，`0` 表示成功，负数表示失败（调用 `taos_errstr()` 可获取失败原因）。应用在定义回调函数的时候，主要处理第二个参数 `TAOS_RES *`，该参数是查询返回的结果集 - param：应用提供一个用于回调的参数 - `void taos_fetch_rows_a(TAOS_RES *res, void (*fp)(void *param, TAOS_RES *, int numOfRows), void *param);` @@ -178,7 +178,7 @@ typedef struct taosField { 批量获取异步查询的结果集，只能与 `taos_query_a()` 配合使用。其中： - res：`taos_query_a()` 回调时返回的结果集 - - fp：回调函数。其参数`param`是用户可定义的传递给回调函数的参数结构体；`numOfRows`是获取到的数据的行数（不是整个查询结果集的函数）。 在回调函数中，应用可以通过调用 `taos_fetch_row()` 前向迭代获取批量记录中每一行记录。读完一块内的所有记录后，应用需要在回调函数中继续调用`taos_fetch_rows_a`获取下一批记录进行处理，直到返回的记录数（numOfRows）为零（结果返回完成）或记录数为负值（查询出错）。 + - fp：回调函数。其参数 `param` 是用户可定义的传递给回调函数的参数结构体；`numOfRows` 是获取到的数据的行数（不是整个查询结果集的函数）。 在回调函数中，应用可以通过调用 `taos_fetch_row()` 前向迭代获取批量记录中每一行记录。读完一块内的所有记录后，应用需要在回调函数中继续调用 `taos_fetch_rows_a()` 获取下一批记录进行处理，直到返回的记录数 `numOfRows` 为零（结果返回完成）或记录数为负值（查询出错）。 TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多线程同时打开多张表，并可以同时对每张打开的表进行查询或者插入操作。需要指出的是，**客户端应用必须确保对同一张表的操作完全串行化**，即对同一个表的插入或查询操作未完成时（未返回时），不能够执行第二个插入或查询操作。 @@ -272,7 +272,7 @@ TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多 - `char * taos_stmt_errstr(TAOS_STMT *stmt)` （2.1.3.0 版本新增） - 用于在其他 stmt API 返回错误（返回错误码或空指针）时获取错误信息。 + 用于在其他 STMT API 返回错误（返回错误码或空指针）时获取错误信息。 ## Schemaless 方式写入接口 @@ -284,7 +284,7 @@ TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多 该接口将行协议的文本数据写入到 TDengine 中。 **参数说明** - taos: 数据库连接，通过 taos_connect 函数建立的数据库连接。 + taos: 数据库连接，通过 `taos_connect()` 函数建立的数据库连接。 lines：文本数据。满足解析格式要求的无模式文本字符串。 numLines:文本数据的行数，不能为 0 。 protocol: 行协议类型，用于标识文本数据格式。 @@ -292,25 +292,25 @@ TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多 **返回值** TAOS_RES 结构体，应用可以通过使用 `taos_errstr()` 获得错误信息，也可以使用 `taos_errno()` 获得错误码。 - 在某些情况下，返回的 TAOS_RES 为 NULL，此时仍然可以调用 `taos_errno()` 来安全地获得错误码信息。 + 在某些情况下，返回的 TAOS_RES 为 `NULL`，此时仍然可以调用 `taos_errno()` 来安全地获得错误码信息。 返回的 TAOS_RES 需要调用方来负责释放，否则会出现内存泄漏。 **说明** 协议类型是枚举类型，包含以下三种格式： - TSDB_SML_LINE_PROTOCOL：InfluxDB 行协议（Line Protocol) - TSDB_SML_TELNET_PROTOCOL: OpenTSDB 文本行协议 - TSDB_SML_JSON_PROTOCOL: OpenTSDB Json 协议格式 + - TSDB_SML_LINE_PROTOCOL：InfluxDB 行协议（Line Protocol) + - TSDB_SML_TELNET_PROTOCOL: OpenTSDB Telnet 文本行协议 + - TSDB_SML_JSON_PROTOCOL: OpenTSDB Json 协议格式 时间戳分辨率的定义，定义在 taos.h 文件中，具体内容如下： - TSDB_SML_TIMESTAMP_NOT_CONFIGURED = 0, - TSDB_SML_TIMESTAMP_HOURS, - TSDB_SML_TIMESTAMP_MINUTES, - TSDB_SML_TIMESTAMP_SECONDS, - TSDB_SML_TIMESTAMP_MILLI_SECONDS, - TSDB_SML_TIMESTAMP_MICRO_SECONDS, - TSDB_SML_TIMESTAMP_NANO_SECONDS - - 需要注意的是，时间戳分辨率参数只在协议类型为 SML_LINE_PROTOCOL 的时候生效。 + - TSDB_SML_TIMESTAMP_NOT_CONFIGURED = 0, + - TSDB_SML_TIMESTAMP_HOURS, + - TSDB_SML_TIMESTAMP_MINUTES, + - TSDB_SML_TIMESTAMP_SECONDS, + - TSDB_SML_TIMESTAMP_MILLI_SECONDS, + - TSDB_SML_TIMESTAMP_MICRO_SECONDS, + - TSDB_SML_TIMESTAMP_NANO_SECONDS + + 需要注意的是，时间戳分辨率参数只在协议类型为 `SML_LINE_PROTOCOL` 的时候生效。 对于 OpenTSDB 的文本协议，时间戳的解析遵循其官方解析规则 — 按照时间戳包含的字符的数量来确认时间精度。 **支持版本** @@ -363,7 +363,7 @@ TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多 - sql：订阅的查询语句，此语句只能是 `select` 语句，只应查询原始数据，只能按时间正序查询数据 - fp：收到查询结果时的回调函数（稍后介绍函数原型），只在异步调用时使用，同步调用时此参数应该传 `NULL` - param：调用回调函数时的附加参数，系统 API 将其原样传递到回调函数，不进行任何处理 - - interval：轮询周期，单位为毫秒。异步调用时，将根据此参数周期性的调用回调函数，为避免对系统性能造成影响，不建议将此参数设置的过小；同步调用时，如两次调用`taos_consume`的间隔小于此周期，API 将会阻塞，直到时间间隔超过此周期。 + - interval：轮询周期，单位为毫秒。异步调用时，将根据此参数周期性的调用回调函数，为避免对系统性能造成影响，不建议将此参数设置的过小；同步调用时，如两次调用 `taos_consume()` 的间隔小于此周期，API 将会阻塞，直到时间间隔超过此周期。 - `typedef void (*TAOS_SUBSCRIBE_CALLBACK)(TAOS_SUB* tsub, TAOS_RES *res, void* param, int code)` @@ -371,7 +371,7 @@ TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多 - tsub：订阅对象 - res：查询结果集，注意结果集中可能没有记录 - - param：调用 `taos_subscribe`时客户程序提供的附加参数 + - param：调用 `taos_subscribe()` 时客户程序提供的附加参数 - code：错误码 :::note diff --git a/docs-cn/14-reference/03-connector/csharp.mdx b/docs-cn/14-reference/03-connector/csharp.mdx index 764382e3f88454b65667fec480c2494c43ab377e..66a3fc7c882eb26fd517a876003341b8ba24bf45 100644 --- a/docs-cn/14-reference/03-connector/csharp.mdx +++ b/docs-cn/14-reference/03-connector/csharp.mdx @@ -19,7 +19,7 @@ import CSAsyncQuery from "../../04-develop/04-query-data/_cs_async.mdx" 本文介绍如何在 Linux 或 Windows 环境中安装 `TDengine.Connector`，并通过 `TDengine.Connector` 连接 TDengine 集群，进行数据写入、查询等基本操作。 -`TDengine.Connector` 连接器的源码托管在 [GitHub](https://github.com/taosdata/taos-connector-dotnet)。 +`TDengine.Connector` 的源码托管在 [GitHub](https://github.com/taosdata/taos-connector-dotnet)。 ## 支持的平台 diff --git a/docs-cn/14-reference/03-connector/go.mdx b/docs-cn/14-reference/03-connector/go.mdx index a5d5b667281f4bd625963607c686f67b42d6f9c9..2b4c548ad56855130f2089822db14a88e921584b 100644 --- a/docs-cn/14-reference/03-connector/go.mdx +++ b/docs-cn/14-reference/03-connector/go.mdx @@ -16,9 +16,9 @@ import GoQuery from "../../04-develop/04-query-data/_go.mdx" `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 集群、进行数据查询、数据写入等基本操作。 +本文介绍如何安装 `driver-go`，并通过 `driver-go` 连接 TDengine 集群、进行数据查询、数据写入等基本操作。 -Go 连接器的源码托管在 [GitHub](https://github.com/taosdata/driver-go)。 +`driver-go` 的源码托管在 [GitHub](https://github.com/taosdata/driver-go)。 ## 支持的平台 @@ -79,7 +79,7 @@ username:password@protocol(address)/dbname?param=value ### 建立原生连接 -_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/) 的接口。 使用 `taosSql` 作为 `driverName` 并且使用一个正确的 [DSN](#DSN) 作为 `dataSourceName`，DSN 支持的参数： diff --git a/docs-cn/14-reference/03-connector/node.mdx b/docs-cn/14-reference/03-connector/node.mdx index c408f82fe45ed73e9e112290d81f0a5e4b7628a0..a58ca824f03df28a852331cf144a318b0eec6a4c 100644 --- a/docs-cn/14-reference/03-connector/node.mdx +++ b/docs-cn/14-reference/03-connector/node.mdx @@ -15,7 +15,9 @@ import NodeAsyncQuery from "../../04-develop/04-query-data/_js_async.mdx" `td2.0-connector` 是 TDengine 的官方 Node.js 语言连接器。Node.js 开发人员可以通过它开发可以存取 TDengine 集群数据的应用软件。 -Node.js 连接器的源码托管在 [GitHub](https://github.com/taosdata/taos-connector-node)。 +`td2.0-connector` 支持通过客户端驱动程序（taosc）原生连接 TDengine 集群，支持数据写入、查询、订阅、schemaless 接口和参数绑定接口等功能。也支持使用 REST 接口连接 TDengine 集群。REST 接口实现的功能特性集合和原生接口有少量不同。 + +`td2.0-connector` 的源码托管在 [GitHub](https://github.com/taosdata/taos-connector-node)。 ## 支持的平台 diff --git a/docs-cn/14-reference/03-connector/rust.mdx b/docs-cn/14-reference/03-connector/rust.mdx index 2d0395b4a8d3b258d32b6a7261c3f01b4e4368f3..91d78b3c7be02f119b6af1727713f4cfc2c5e62d 100644 --- a/docs-cn/14-reference/03-connector/rust.mdx +++ b/docs-cn/14-reference/03-connector/rust.mdx @@ -16,9 +16,9 @@ import RustQuery from "../../04-develop/04-query-data/_rust.mdx" `libtaos` 是 TDengine 的官方 Rust 语言连接器。Rust 开发人员可以通过它开发存取 TDengine 数据库的应用软件。 -`libtaos` 使用不同的 “特性（Cargo 关键字 features）” 提供对通过客户端驱动程序（taosc）原生连接和使用 REST 连接 TDengine 集群。 +`libtaos` 使用不同的 “特性（即 Cargo 关键字 features）” 提供对通过客户端驱动程序（taosc）原生连接和使用 REST 连接 TDengine 集群。 -Rust 连接器的源码托管在 [GitHub](https://github.com/taosdata/libtaos-rs)。 +`libtaos` 的源码托管在 [GitHub](https://github.com/taosdata/libtaos-rs)。 ## 支持的平台