docs: change macos client doc (#17420)

* docs: change macos client doc * docs: change macos client doc * docs: make taosadapter/taosbenchmark description align with prev * fix: chinese colon * fix: chinese colon Co-authored-by: Shuduo Sang <sangshuduo@gmail.com>

docs: change macos client doc (#17420)
* docs: change macos client doc * docs: change macos client doc * docs: make taosadapter/taosbenchmark description align with prev * fix: chinese colon * fix: chinese colon Co-authored-by: Shuduo Sang <sangshuduo@gmail.com>
fc9982de · wafwerar · GitHub · bb59553e · fc9982de · fc9982de
13 changed file
--- a/docs/en/05-get-started/03-package.md
+++ b/docs/en/05-get-started/03-package.md
@@ -116,7 +116,7 @@ Note: TDengine only supports Windows Server 2016/2019 and Windows 10/11 on the W

 1. Download the macOS installation package.
   <PkgListV3 type={7}/>
-2. Run the downloaded package to install TDengine.
+2. Run the downloaded package to install TDengine. If the installation is blocked, you can right-click or ctrl-click on the installation package and select `Open`.

 </TabItem>
 </Tabs>
@@ -179,12 +179,20 @@ The following `systemctl` commands can help you manage TDengine service:

 :::

+## Command Line Interface (CLI)
+
+You can use the TDengine CLI to monitor your TDengine deployment and execute ad hoc queries. To open the CLI, you can execute `taos` in terminal.
+
 </TabItem>

 <TabItem label="Windows" value="windows">

 After the installation is complete, run `C:\TDengine\taosd.exe` to start TDengine Server.

+## Command Line Interface (CLI)
+
+You can use the TDengine CLI to monitor your TDengine deployment and execute ad hoc queries. To open the CLI, you can run `taos.exe` in the `C:\TDengine` directory of the Windows terminal to start the TDengine command line.
+
 </TabItem>

 <TabItem label="macOS" value="macos">
@@ -206,12 +214,12 @@ The following `launchctl` commands can help you manage TDengine service:

 :::

-</TabItem>
-</Tabs>
-
 ## Command Line Interface (CLI)

-You can use the TDengine CLI to monitor your TDengine deployment and execute ad hoc queries. To open the CLI, you can execute `taos` in the Linux/macOS terminal where TDengine is installed, or you can run `taos.exe` in the `C:\TDengine` directory of the Windows terminal where TDengine is installed to start the TDengine command line.
+You can use the TDengine CLI to monitor your TDengine deployment and execute ad hoc queries. To open the CLI, you can execute `taos` in terminal.
+
+</TabItem>
+</Tabs>

 ```bash
 taos

--- a/docs/en/07-develop/01-connect/index.md
+++ b/docs/en/07-develop/01-connect/index.md
@@ -15,10 +15,12 @@ import ConnCSNative from "./_connect_cs.mdx";
 import ConnC from "./_connect_c.mdx";
 import ConnR from "./_connect_r.mdx";
 import ConnPHP from "./_connect_php.mdx";
-import InstallOnWindows from "../../14-reference/03-connector/_linux_install.mdx";
-import InstallOnLinux from "../../14-reference/03-connector/_windows_install.mdx";
+import InstallOnLinux from "../../14-reference/03-connector/_linux_install.mdx";
+import InstallOnWindows from "../../14-reference/03-connector/_windows_install.mdx";
+import InstallOnMacOS from "../../14-reference/03-connector/_macos_install.mdx";
 import VerifyLinux from "../../14-reference/03-connector/_verify_linux.mdx";
 import VerifyWindows from "../../14-reference/03-connector/_verify_windows.mdx";
+import VerifyMacOS from "../../14-reference/03-connector/_verify_macos.mdx";

 Any application running on any platform can access TDengine through the REST API provided by TDengine. For information, see [REST API](/reference/rest-api/). Applications can also use the connectors for various programming languages, including C/C++, Java, Python, Go, Node.js, C#, and Rust, to access TDengine. These connectors support connecting to TDengine clusters using both native interfaces (taosc). Some connectors also support connecting over a REST interface. Community developers have also contributed several unofficial connectors, such as the ADO.NET connector, the Lua connector, and the PHP connector.

@@ -44,10 +46,13 @@ If you are choosing to use the native connection and the the application is not

 <Tabs defaultValue="linux" groupId="os">
  <TabItem value="linux" label="Linux">
-    <InstallOnWindows />
+    <InstallOnLinux />
  </TabItem>
  <TabItem value="windows" label="Windows">
-    <InstallOnLinux />
+    <InstallOnWindows />
+  </TabItem>
+  <TabItem value="macos" label="MacOS">
+    <InstallOnMacOS />
  </TabItem>
 </Tabs>

@@ -62,6 +67,9 @@ After the above installation and configuration are done and making sure TDengine
  <TabItem value="windows" label="Windows">
    <VerifyWindows />
  </TabItem>
+  <TabItem value="macos" label="MacOS">
+    <VerifyMacOS />
+  </TabItem>
 </Tabs>

 ## Install Connectors

--- a/docs/en/14-reference/03-connector/_macos_install.mdx
+++ b/docs/en/14-reference/03-connector/_macos_install.mdx
+import PkgListV3 from "/components/PkgListV3";
+
+1. Download the client installation package
+
+  <PkgListV3 type={8} sys="MacOS" />
+
+   [All Downloads](../../releases/tdengine)
+
+2. Execute the installer, select the default value as prompted, and complete the installation. If the installation is blocked, you can right-click or ctrl-click on the installation package and select `Open`.
+3. configure taos.cfg
+
+   Edit `taos.cfg` file (full path is `/etc/taos/taos.cfg` by default), modify `firstEP` with actual TDengine server's End Point, for example `h1.tdengine.com:6030`
+
+:::tip
+
+1. If the computer does not run the TDengine service but installs the TDengine client driver, then you need to config `firstEP` in  `taos.cfg` only, and there is no need to configure `FQDN`;
+2. If you encounter the "Unable to resolve FQDN" error, please make sure the FQDN in the `/etc/hosts` file of the current computer is correctly configured, or the DNS service is correctly configured.
+
+:::
--- a/docs/en/14-reference/03-connector/_verify_macos.mdx
+++ b/docs/en/14-reference/03-connector/_verify_macos.mdx
+Execute TDengine CLI program `taos` directly from the macOS shell to connect to the TDengine service and enter the TDengine CLI interface, as shown in the following example.
+
+```text
+$ taos
+
+taos> show databases;
+              name              |
+=================================
+ information_schema             |
+ performance_schema             |
+ db                             |
+Query OK, 3 rows in database (0.019154s)
+
+taos>
+```
--- a/docs/en/14-reference/03-connector/_windows_install.mdx
+++ b/docs/en/14-reference/03-connector/_windows_install.mdx
@@ -10,12 +10,14 @@ import PkgListV3 from "/components/PkgListV3";

   The default installation path is C:\TDengine, including the following files (directories).

-   - _taos.exe_ : TDengine CLI command-line program
-   - _cfg_ : configuration file directory
+   - _taos.exe_: TDengine CLI command-line program
+   - _taosadapter.exe_: server-side executable that provides RESTful services and accepts writing requests from a variety of other softwares
+   - _taosBenchmark.exe_: TDengine testing tool
+   - _cfg_: configuration file directory
   - _driver_: client driver dynamic link library
   - _examples_: sample programs bash/C/C#/go/JDBC/Python/Node.js
   - _include_: header files
-   - _log_ : log file
+   - _log_: log file
   - _unins000.exe_: uninstaller

 4. configure taos.cfg

--- a/docs/en/14-reference/03-connector/index.mdx
+++ b/docs/en/14-reference/03-connector/index.mdx
@@ -74,10 +74,12 @@ The different database framework specifications for various programming language

 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
-import InstallOnWindows from "./_linux_install.mdx";
-import InstallOnLinux from "./_windows_install.mdx";
+import InstallOnLinux from "./_linux_install.mdx";
+import InstallOnWindows from "./_windows_install.mdx";
+import InstallOnMacOS from "./_macos_install.mdx";
 import VerifyWindows from "./_verify_windows.mdx";
 import VerifyLinux from "./_verify_linux.mdx";
+import VerifyMacOS from "./_verify_macos.mdx";

 ## Install Client Driver

@@ -90,10 +92,13 @@ The client driver needs to be installed if you use the native interface connecto

 <Tabs defaultValue="linux" groupId="os">
  <TabItem value="linux" label="Linux">
-    <InstallOnWindows />
+    <InstallOnLinux />
  </TabItem>
  <TabItem value="windows" label="Windows">
-    <InstallOnLinux />
+    <InstallOnWindows />
+  </TabItem>
+  <TabItem value="macos" label="MacOS">
+    <InstallOnMacOS />
  </TabItem>
 </Tabs>

@@ -108,5 +113,8 @@ After completing the above installation and configuration and you have confirmed
  <TabItem value="windows" label="Windows">
    <VerifyWindows />
  </TabItem>
+  <TabItem value="macos" label="MacOS">
+    <VerifyMacOS />
+  </TabItem>
 </Tabs>

--- a/docs/zh/05-get-started/03-package.md
+++ b/docs/zh/05-get-started/03-package.md
@@ -115,7 +115,7 @@ apt-get 方式只适用于 Debian 或 Ubuntu 系统。

 1. 从列表中下载获得 pkg 安装程序；
   <PkgListV3 type={7}/>
-2. 运行可执行程序来安装 TDengine。
+2. 运行可执行程序来安装 TDengine。如果安装被阻止，可以右键或者按 Ctrl 点击安装包，选择 `打开`。

 </TabItem>
 </Tabs>
@@ -178,12 +178,20 @@ Active: inactive (dead)

 :::

+## TDengine 命令行（CLI）
+
+为便于检查 TDengine 的状态，执行数据库（Database）的各种即席（Ad Hoc）查询，TDengine 提供一命令行应用程序（以下简称为 TDengine CLI）taos。要进入 TDengine 命令行，您只要在终端执行 `taos` 即可。
+
 </TabItem>

 <TabItem label="Windows 系统" value="windows">

 安装后，在 `C:\TDengine` 目录下，运行 `taosd.exe` 来启动 TDengine 服务进程。

+## TDengine 命令行（CLI）
+
+为便于检查 TDengine 的状态，执行数据库（Database）的各种即席（Ad Hoc）查询，TDengine 提供一命令行应用程序（以下简称为 TDengine CLI）taos。要进入 TDengine 命令行，您只要在终端执行 `taos` 即可。
+
 </TabItem>

 <TabItem label="macOS 系统" value="macos">
@@ -205,12 +213,12 @@ Active: inactive (dead)

 :::

-</TabItem>
-</Tabs>
-
 ## TDengine 命令行（CLI）

-为便于检查 TDengine 的状态，执行数据库（Database）的各种即席（Ad Hoc）查询，TDengine 提供一命令行应用程序（以下简称为 TDengine CLI）taos。要进入 TDengine 命令行，您只要在安装有 TDengine 的 Linux、macOS 终端执行 `taos` 即可，也可以在安装有 TDengine 的 Windows 终端的 C:\TDengine 目录下，运行 taos.exe 来启动 TDengine 命令行。
+为便于检查 TDengine 的状态，执行数据库（Database）的各种即席（Ad Hoc）查询，TDengine 提供一命令行应用程序（以下简称为 TDengine CLI）taos。要进入 TDengine 命令行，您只要在 Windows 终端的 C:\TDengine 目录下，运行 taos.exe 来启动 TDengine 命令行。
+
+</TabItem>
+</Tabs>

 ```bash
 taos

--- a/docs/zh/07-develop/01-connect/index.md
+++ b/docs/zh/07-develop/01-connect/index.md
@@ -14,9 +14,11 @@ import ConnCSNative from "./_connect_cs.mdx";
 import ConnC from "./_connect_c.mdx";
 import ConnR from "./_connect_r.mdx";
 import ConnPHP from "./_connect_php.mdx";
-import InstallOnWindows from "../../08-connector/_linux_install.mdx";
-import InstallOnLinux from "../../08-connector/_windows_install.mdx";
+import InstallOnLinux from "../../08-connector/_linux_install.mdx";
+import InstallOnWindows from "../../08-connector/_windows_install.mdx";
+import InstallOnMacOS from "../../08-connector/_macos_install.mdx";
 import VerifyLinux from "../../08-connector/_verify_linux.mdx";
+import VerifyMacOS from "../../08-connector/_verify_macos.mdx";
 import VerifyWindows from "../../08-connector/_verify_windows.mdx";

 TDengine 提供了丰富的应用程序开发接口，为了便于用户快速开发自己的应用，TDengine 支持了多种编程语言的连接器，其中官方连接器包括支持 C/C++、Java、Python、Go、Node.js、C#、Rust、Lua（社区贡献）和 PHP （社区贡献）的连接器。这些连接器支持使用原生接口（taosc）和 REST 接口（部分语言暂不支持）连接 TDengine 集群。社区开发者也贡献了多个非官方连接器，例如 ADO.NET 连接器、Lua 连接器和 PHP 连接器。
@@ -43,10 +45,13 @@ TDengine 提供了丰富的应用程序开发接口，为了便于用户快速

 <Tabs defaultValue="linux" groupId="os">
  <TabItem value="linux" label="Linux">
-    <InstallOnWindows />
+    <InstallOnLinux />
  </TabItem>
  <TabItem value="windows" label="Windows">
-    <InstallOnLinux />
+    <InstallOnWindows />
+  </TabItem>
+  <TabItem value="macos" label="macOS">
+    <InstallOnMacOS />
  </TabItem>
 </Tabs>

@@ -61,6 +66,9 @@ TDengine 提供了丰富的应用程序开发接口，为了便于用户快速
  <TabItem value="windows" label="Windows">
    <VerifyWindows />
  </TabItem>
+  <TabItem value="macos" label="macOS">
+    <VerifyMacOS />
+  </TabItem>
 </Tabs>

 ## 安装连接器

--- a/docs/zh/08-connector/_macos_install.mdx
+++ b/docs/zh/08-connector/_macos_install.mdx
+import PkgListV3 from "/components/PkgListV3";
+
+1. 下载客户端安装包
+
+  <PkgListV3 type={8} sys="MacOS" />
+
+   [所有下载](../../releases/tdengine)
+
+2. 执行安装程序，按提示选择默认值，完成安装。如果安装被阻止，可以右键或者按 Ctrl 点击安装包，选择 `打开`。
+3. 配置 taos.cfg
+
+   编辑 `taos.cfg` 文件（默认路径/etc/taos/taos.cfg），将 `firstEP` 修改为 TDengine 服务器的 End Point，例如：`h1.tdengine.com:6030`
+
+:::tip
+
+1. 如本机没有部署 TDengine 服务，仅安装了应用驱动，则 `taos.cfg` 中仅需配置 `firstEP`，无需在本机配置 `FQDN`。
+2. 为防止与服务器端连接时出现“Unable to resolve FQDN”错误，建议确认本机的 `/etc/hosts` 文件已经配置了服务器正确的 FQDN 值，或配置好了 DNS 服务。
+
+:::
--- a/docs/zh/08-connector/_verify_macos.mdx
+++ b/docs/zh/08-connector/_verify_macos.mdx
+在 macOS shell 下直接执行 `taos` 连接到 TDengine 服务，进入到 TDengine CLI 界面，示例如下：
+
+```text
+$ taos
+
+taos> show databases;
+              name              |
+=================================
+ information_schema             |
+ performance_schema             |
+ db                             |
+Query OK, 3 rows in database (0.019154s)
+
+taos>
+```
--- a/docs/zh/08-connector/_windows_install.mdx
+++ b/docs/zh/08-connector/_windows_install.mdx
@@ -12,6 +12,8 @@ import PkgListV3 from "/components/PkgListV3";
   默认安装路径为：C:\TDengine，其中包括以下文件(目录)：

   - _taos.exe_：TDengine CLI 命令行程序
+   - _taosadapter.exe_：提供 RESTful 服务和接受其他多种软件写入请求的服务端可执行文件
+   - _taosBenchmark.exe_：TDengine 测试程序
   - _cfg_ : 配置文件目录
   - _driver_: 应用驱动动态链接库
   - _examples_: 示例程序 bash/C/C#/go/JDBC/Python/Node.js

--- a/docs/zh/08-connector/index.md
+++ b/docs/zh/08-connector/index.md
@@ -74,10 +74,12 @@ TDengine 版本更新往往会增加新的功能特性，列表中的连接器

 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
-import InstallOnWindows from "./_linux_install.mdx";
-import InstallOnLinux from "./_windows_install.mdx";
+import InstallOnLinux from "./_linux_install.mdx";
+import InstallOnWindows from "./_windows_install.mdx";
+import InstallOnMacOS from "./_macos_install.mdx";
 import VerifyWindows from "./_verify_windows.mdx";
 import VerifyLinux from "./_verify_linux.mdx";
+import VerifyMacOS from "./_verify_macos.mdx";

 ## 安装客户端驱动

@@ -90,10 +92,13 @@ import VerifyLinux from "./_verify_linux.mdx";

 <Tabs defaultValue="linux" groupId="os">
  <TabItem value="linux" label="Linux">
-    <InstallOnWindows />
+    <InstallOnLinux />
  </TabItem>
  <TabItem value="windows" label="Windows">
-    <InstallOnLinux />
+    <InstallOnWindows />
+  </TabItem>
+  <TabItem value="macos" label="MacOS">
+    <InstallOnMacOS />
  </TabItem>
 </Tabs>

@@ -108,5 +113,8 @@ import VerifyLinux from "./_verify_linux.mdx";
  <TabItem value="windows" label="Windows">
    <VerifyWindows />
  </TabItem>
+  <TabItem value="macos" label="MacOS">
+    <VerifyMacOS />
+  </TabItem>
 </Tabs>

--- a/taosws-rs @ 1bdfca39
+++ b/taosws-rs @ 1bdfca39
-Subproject commit 7a94ffab45f08e16f09b3f430fe75d717054adb6
+Subproject commit 1bdfca396cd6730cdc334e06fc7b2156dd1239a0