未验证 提交 d3993861 编写于 作者: W wade zhang 提交者: GitHub

Merge pull request #11931 from taosdata/docs/wade-20220427-c++

docs: format using prettier
...@@ -4,7 +4,7 @@ sidebar_label: C/C++ ...@@ -4,7 +4,7 @@ sidebar_label: C/C++
title: C/C++ Connector title: C/C++ Connector
--- ---
C/C++ 开发人员可以使用 TDengine 的客户端驱动,即C/C++连接器 (以下都用 TDengine 客户端驱动表示),开发自己的应用来连接 TDengine 集群完成数据存储、查询以及其他功能。TDengine 客户端驱动的 API 类似于 MySQL 的 C API。应用程序使用时,需要包含 TDengine 头文件 _taos.h_,里面列出了提供的 API 的函数原型;应用程序还要链接到所在平台上对应的动态库。 C/C++ 开发人员可以使用 TDengine 的客户端驱动,即 C/C++连接器 (以下都用 TDengine 客户端驱动表示),开发自己的应用来连接 TDengine 集群完成数据存储、查询以及其他功能。TDengine 客户端驱动的 API 类似于 MySQL 的 C API。应用程序使用时,需要包含 TDengine 头文件 _taos.h_,里面列出了提供的 API 的函数原型;应用程序还要链接到所在平台上对应的动态库。
```c ```c
#include <taos.h> #include <taos.h>
...@@ -16,6 +16,7 @@ TDengine 服务端或客户端安装后,`taos.h` 位于: ...@@ -16,6 +16,7 @@ TDengine 服务端或客户端安装后,`taos.h` 位于:
- Windows:`C:\TDengine\include` - Windows:`C:\TDengine\include`
TDengine 客户端驱动的动态库位于: TDengine 客户端驱动的动态库位于:
- Linux: `/usr/local/taos/driver/libtaos.so` - Linux: `/usr/local/taos/driver/libtaos.so`
- Windows: `C:\TDengine\taos.dll` - Windows: `C:\TDengine\taos.dll`
...@@ -53,6 +54,7 @@ TDengine 客户端驱动的安装请参考 [安装指南](/reference/connector# ...@@ -53,6 +54,7 @@ TDengine 客户端驱动的安装请参考 [安装指南](/reference/connector#
在上面的示例代码中, `taos_connect` 建立到客户端程序所在主机的 6030 端口的连接,`taos_close`关闭当前连接,`taos_cleanup`清除客户端驱动所申请和使用的资源。 在上面的示例代码中, `taos_connect` 建立到客户端程序所在主机的 6030 端口的连接,`taos_close`关闭当前连接,`taos_cleanup`清除客户端驱动所申请和使用的资源。
:::note :::note
- 如未特别说明,当 API 的返回值是整数时,_0_ 代表成功,其它是代表失败原因的错误码,当返回值是指针时, _NULL_ 表示失败。 - 如未特别说明,当 API 的返回值是整数时,_0_ 代表成功,其它是代表失败原因的错误码,当返回值是指针时, _NULL_ 表示失败。
- 所有的错误码以及对应的原因描述在 taoserror.h 文件中。 - 所有的错误码以及对应的原因描述在 taoserror.h 文件中。
...@@ -63,6 +65,7 @@ TDengine 客户端驱动的安装请参考 [安装指南](/reference/connector# ...@@ -63,6 +65,7 @@ TDengine 客户端驱动的安装请参考 [安装指南](/reference/connector#
本节展示了使用客户端驱动访问 TDengine 集群的常见访问方式的示例代码。 本节展示了使用客户端驱动访问 TDengine 集群的常见访问方式的示例代码。
### 同步查询示例 ### 同步查询示例
<details> <details>
<summary>同步查询</summary> <summary>同步查询</summary>
...@@ -116,7 +119,6 @@ TDengine 客户端驱动的安装请参考 [安装指南](/reference/connector# ...@@ -116,7 +119,6 @@ TDengine 客户端驱动的安装请参考 [安装指南](/reference/connector#
</details> </details>
:::info :::info
更多示例代码及下载请见 [github](https://github.com/taosdata/TDengine/tree/develop/examples/c) 更多示例代码及下载请见 [github](https://github.com/taosdata/TDengine/tree/develop/examples/c)
也可以在安装目录下的 examples/c 路径下找到。 该目录下有 makefile,在 Linux 环境下,直接执行 make 就可以编译得到执行文件。 也可以在安装目录下的 examples/c 路径下找到。 该目录下有 makefile,在 Linux 环境下,直接执行 make 就可以编译得到执行文件。
...@@ -383,11 +385,13 @@ TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多 ...@@ -383,11 +385,13 @@ TDengine 的异步 API 均采用非阻塞调用模式。应用程序可以用多
**说明** **说明**
协议类型是枚举类型,包含以下三种格式: 协议类型是枚举类型,包含以下三种格式:
- TSDB_SML_LINE_PROTOCOL:InfluxDB 行协议(Line Protocol) - TSDB_SML_LINE_PROTOCOL:InfluxDB 行协议(Line Protocol)
- TSDB_SML_TELNET_PROTOCOL: OpenTSDB Telnet 文本行协议 - TSDB_SML_TELNET_PROTOCOL: OpenTSDB Telnet 文本行协议
- TSDB_SML_JSON_PROTOCOL: OpenTSDB Json 协议格式 - TSDB_SML_JSON_PROTOCOL: OpenTSDB Json 协议格式
时间戳分辨率的定义,定义在 taos.h 文件中,具体内容如下: 时间戳分辨率的定义,定义在 taos.h 文件中,具体内容如下:
- TSDB_SML_TIMESTAMP_NOT_CONFIGURED = 0, - TSDB_SML_TIMESTAMP_NOT_CONFIGURED = 0,
- TSDB_SML_TIMESTAMP_HOURS, - TSDB_SML_TIMESTAMP_HOURS,
- TSDB_SML_TIMESTAMP_MINUTES, - TSDB_SML_TIMESTAMP_MINUTES,
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册