[doc] Update Broker doc

docs/sql-manual/sql-statements/Cluster-Management-Statements/ALTER-SYSTEM-ADD-BROKER.md

@@ -25,38 +25,44 @@ specific language governing permissions and limitations
 under the License.
 -->
 
-## ALTER-SYSTEM-ADD-BROKER
+## Description
 
-### Name
+This statement is used to add one or more BROKER nodes. (For administrators only!)
 
-ALTER SYSTEM ADD BROKER
+## Syntax
 
-### Description
+```sql
+ALTER SYSTEM ADD BROKER broker_name "<host1>:<ipc_port>","<host2>:<ipc_port>", ...;
+```
 
-This statement is used to add a BROKER node. (Administrator only!)
+## Required Parameters
 
-grammar:
+**1. broker_name**
+The name given to the added broker process. It is recommended to keep the broker_name consistent within the same cluster.
 
-```sql
-ALTER SYSTEM ADD BROKER broker_name "broker_host1:broker_ipc_port1","broker_host2:broker_ipc_port2",...;
-```
+**2. host**
+The IP of the node where the broker process needs to be added. If FQDN is enabled, use the FQDN of the node.
 
-### Example
+**3. ipc_port**
+The PORT of the node where the broker process needs to be added, and the default value of this port is 8000.
 
-1. Add two brokers
+## Output
+No Output Fields
 
-    ```sql
-     ALTER SYSTEM ADD BROKER "host1:port", "host2:port";
-    ```
-2. When fe enable fqdn([fqdn](../../../admin-manual/cluster-management/fqdn.md)),add one Broker
+## Access Control Requirements
+The user who executes this operation needs to have the NODE_PRIV permission.
 
-   ```sql
-    ALTER SYSTEM ADD BROKER "broker_fqdn1:port";
-   ```
+## Examples
 
-### Keywords
+1. Add two Brokers
 
-    ALTER, SYSTEM, ADD, FOLLOWER, ALTER SYSTEM
+```sql
+ALTER SYSTEM ADD BROKER "host1:port", "host2:port";
+```
+2. Add a Broker using FQDN
+
+```sql
+ALTER SYSTEM ADD BROKER "broker_fqdn1:port";
+```
 
-### Best Practice
 

docs/sql-manual/sql-statements/Cluster-Management-Statements/ALTER-SYSTEM-DROP-BROKER.md

@@ -25,42 +25,48 @@ specific language governing permissions and limitations
 under the License.
 -->
 
-## ALTER-SYSTEM-DROP-BROKER
+## Description
 
-### Name
+This statement is used to delete BROKER nodes. (For administrators only)
 
-ALTER SYSTEM DROP BROKER
+## Syntax
 
-### Description
-
-This statement is to delete the BROKER node, (administrator only)
-
-grammar:
+1. Drop all Brokers
+```sql
+ALTER SYSTEM DROP ALL BROKER broker_name;
+```
 
+2. Drop one or more Broker nodes
 ```sql
--- Delete all brokers
-ALTER SYSTEM DROP ALL BROKER broker_name
--- Delete a Broker node
-ALTER SYSTEM DROP BROKER broker_name "host:port"[,"host:port"...];
+ALTER SYSTEM DROP BROKER broker_name "<host1>:<ipc_port>"[,"<host2>:<ipc_port>", ...];
 ```
+## Required Parameters
 
-### Example
+**1. broker_name**
+The name of the broker process to be deleted.
 
-1. Delete all brokers
+**2. host**
+The IP of the node where the broker process to be deleted is located. If FQDN is enabled, use the FQDN of the node.
 
-    ```sql
-    ALTER SYSTEM DROP ALL BROKER broker_name
-    ```
+**3. ipc_port**
+The PORT of the node where the broker process to be deleted is located, and the default value of this port is 8000.
 
-2. Delete a Broker node
+## Output
+No Output Fields
 
-    ```sql
-    ALTER SYSTEM DROP BROKER broker_name "host:port"[,"host:port"...];
-    ```
+## Access Control Requirements
+The user who executes this operation needs to have the NODE_PRIV permission.
 
-### Keywords
+## Examples
 
-    ALTER, SYSTEM, DROP, FOLLOWER, ALTER SYSTEM
+1. Delete all Brokers
 
-### Best Practice
+```sql
+ALTER SYSTEM DROP ALL BROKER broker_name；
+```
+
+2. Delete a specific Broker node
 
+```sql
+ALTER SYSTEM DROP BROKER broker_name "10.10.10.1:8000";
+```

docs/sql-manual/sql-statements/Show-Statements/SHOW-BROKER.md

@@ -24,34 +24,45 @@ specific language governing permissions and limitations
 under the License.
 -->
 
-## SHOW-BROKER
+## Description
 
-### Name
+This statement is used to view the status of the currently existing broker processes.
 
-SHOW BROKER
-
-### Description
-
-This statement is used to view the currently existing broker
-
-grammar:
+## Syntax：
 
 ```sql
 SHOW BROKER;
 ```
 
-illustrate:
+## Required Parameters
+No Required Parameters
 
-1. LastStartTime indicates the last BE start time.
-2. LastHeartbeat indicates the last heartbeat.
-3.  Alive indicates whether the node is alive or not.
-4.  ErrMsg is used to display the error message when the heartbeat fails.
+## Output
+| Column    | DateType | Note                            |
+ |-------|----|---------------------------------|
+| Name  | varchar | Broker Process Name             |
+| Host  | varchar | Broker Process Node IP          |
+| Port  | varchar | Broker Process Node Port        |
+| Alive | varchar | Broker Process Node Status      |
+| LastStartTime | varchar | Broker Process Last Start Time  |
+|LastUpdateTime | varchar | Broker Process Last Update Time |
+|ErrMsg | varchar | Error message of the last failed startup of the Broker process            |
 
-### Example
 
-### Keywords
+## Access Control Requirements
+The user executing this statement needs to have the `ADMIN/OPERATOR` permission.
 
-    SHOW, BROKER
+## Examples
 
-### Best Practice
+1. View the status of the currently existing broker processes
+```sql
+show broker;
+```
+```text
++-------------+------------+------+-------+---------------------+---------------------+--------+
+| Name        | Host       | Port | Alive | LastStartTime       | LastUpdateTime      | ErrMsg |
++-------------+------------+------+-------+---------------------+---------------------+--------+
+| broker_test | 10.10.10.1 | 8196 | true  | 2025-01-21 11:30:10 | 2025-01-21 11:31:40 |        |
++-------------+------------+------+-------+---------------------+---------------------+--------+
+```
 

i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/Cluster-Management-Statements/ALTER-SYSTEM-ADD-BROKER.md

@@ -25,39 +25,43 @@ specific language governing permissions and limitations
 under the License.
 -->
 
-## ALTER-SYSTEM-ADD-BROKER
-
-### Name
-
-ALTER SYSTEM ADD BROKER
-
 ## 描述
 
-该语句用于添加一个 BROKER 节点。（仅管理员使用！）
+该语句用于添加一个或者多个 BROKER 节点。（仅管理员使用！）
 
-语法：
+## 语法
 
 ```sql
-ALTER SYSTEM ADD BROKER broker_name "broker_host1:broker_ipc_port1","broker_host2:broker_ipc_port2",...;
+ALTER SYSTEM ADD BROKER broker_name "<host1>:<ipc_port>","<host2>:<ipc_port>", ...;
 ```
 
-## 举例
+## 必选参数
+**1. broker_name**
+给添加的 `broker` 进程起的名字。同一个集群中的 broker_name 建议保持一致。
 
-1. 增加两个 Broker
+**2. host**
+需要添加的 `broker` 进程所在节点的 `IP` ，如果启用了 `FQDN`，则使用该节点的 `FQDN`。
+
+**3. ipc_port**
+需要添加的 `broker` 进程所在节点的 `PORT` ，该端口默认值为 `8000`。
 
-   ```sql
-    ALTER SYSTEM ADD BROKER "host1:port", "host2:port";
-   ```
-2. fe开启fqdn([fqdn](../../../admin-manual/cluster-management/fqdn.md))时添加一个Broker
+## 输出字段
+无
 
-   ```sql
-    ALTER SYSTEM ADD BROKER "broker_fqdn1:port";
-   ```
+## 权限控制
+执行该操作的用户需要具备 `NODE_PRIV` 的权限。
 
+## 示例
 
-### Keywords
+1. 增加两个 Broker
 
-    ALTER, SYSTEM, ADD, FOLLOWER, ALTER SYSTEM
+```sql
+ALTER SYSTEM ADD BROKER "host1:port", "host2:port";
+```
+2. 增加一个 Broker，使用 FQDN
+
+```sql
+ALTER SYSTEM ADD BROKER "broker_fqdn1:port";
+```
 
-### Best Practice
 

i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/Cluster-Management-Statements/ALTER-SYSTEM-DROP-BROKER.md

@@ -25,42 +25,47 @@ specific language governing permissions and limitations
 under the License.
 -->
 
-## ALTER-SYSTEM-DROP-BROKER
-
-### Name
-
-ALTER SYSTEM DROP BROKER
-
 ## 描述
 
 该语句是删除 BROKER 节点，（仅限管理员使用）
 
-语法：
+## 语法
 
+1. 删除所有 Broker
 ```sql
-删除所有 Broker
-ALTER SYSTEM DROP ALL BROKER broker_name
-删除某一个 Broker 节点
-ALTER SYSTEM DROP BROKER broker_name "host:port"[,"host:port"...];
+ALTER SYSTEM DROP ALL BROKER broker_name;
 ```
 
-## 举例
+2. 删除某一个 Broker 节点
+```sql
+ALTER SYSTEM DROP BROKER broker_name "<host1>:<ipc_port>"[,"<host2>:<ipc_port>", ...];
+```
+## 必选参数
 
-1. 删除所有 Broker
+**1. broker_name**
+需要删除的 `broker` 进程的名字。
 
-   ```sql
-   ALTER SYSTEM DROP ALL BROKER broker_name
-   ```
+**2. host**
+需要删除的 `broker` 进程所在节点的 `IP` ，如果启用了 `FQDN`，则使用该节点的 `FQDN`。
 
-2. 删除某一个 Broker 节点
+**3. ipc_port**
+需要删除的 `broker` 进程所在节点的 `PORT` ，该端口默认值为 `8000`。
 
-   ```sql
-   ALTER SYSTEM DROP BROKER broker_name "host:port"[,"host:port"...];
-   ```
+## 输出字段
+无
+## 权限控制
+执行该操作的用户需要具备 `NODE_PRIV` 的权限。
 
-### Keywords
+## 示例
 
-    ALTER, SYSTEM, DROP, FOLLOWER, ALTER SYSTEM
+1. 删除所有 Broker
 
-### Best Practice
+```sql
+ALTER SYSTEM DROP ALL BROKER broker_name；
+```
 
+2. 删除某一个 Broker 节点
+
+```sql
+ALTER SYSTEM DROP BROKER broker_name "10.10.10.1:8000";
+```