This is an automated email from the ASF dual-hosted git repository.
kassiez pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/doris-website.git
The following commit(s) were added to refs/heads/master by this push:
new 8fd040c231a [doc] Update broker instance doc (#1977)
8fd040c231a is described below
commit 8fd040c231a7e92d0807083934aab601df58939c
Author: mklzl <[email protected]>
AuthorDate: Mon Feb 10 11:08:06 2025 +0800
[doc] Update broker instance doc (#1977)
## Versions
add broker drop broker show broker
- [x] dev
- [x] 3.0
- [x] 2.1
- [ ] 2.0
## Languages
- [x] Chinese
- [x] English
## Docs Checklist
- [ ] Checked by AI
- [ ] Test Cases Built
---
.../instance-management/ADD-BROKER.md | 47 +++++++++++-------
.../instance-management/DROP-BROKER.md | 56 +++++++++++++--------
.../instance-management/SHOW-BROKER.md | 50 ++++++++++++-------
.../instance-management/ADD-BROKER.md | 45 ++++++++++-------
.../instance-management/DROP-BROKER.md | 58 ++++++++++++++--------
.../instance-management/SHOW-BROKER.md | 43 ++++++++++------
.../instance-management/ADD-BROKER.md | 46 ++++++++++-------
.../instance-management/DROP-BROKER.md | 58 ++++++++++++++--------
.../instance-management/SHOW-BROKER.md | 43 ++++++++++------
.../instance-management/ADD-BROKER.md | 45 ++++++++++-------
.../instance-management/DROP-BROKER.md | 58 ++++++++++++++--------
.../instance-management/SHOW-BROKER.md | 43 ++++++++++------
.../instance-management/ADD-BROKER.md | 45 ++++++++++-------
.../instance-management/DROP-BROKER.md | 56 +++++++++++++--------
.../instance-management/SHOW-BROKER.md | 43 ++++++++++------
.../instance-management/ADD-BROKER.md | 48 +++++++++++-------
.../instance-management/DROP-BROKER.md | 56 +++++++++++++--------
.../instance-management/SHOW-BROKER.md | 50 ++++++++++++-------
18 files changed, 557 insertions(+), 333 deletions(-)
diff --git
a/docs/sql-manual/sql-statements/cluster-management/instance-management/ADD-BROKER.md
b/docs/sql-manual/sql-statements/cluster-management/instance-management/ADD-BROKER.md
index 89fb1703e93..279abb0e63d 100644
---
a/docs/sql-manual/sql-statements/cluster-management/instance-management/ADD-BROKER.md
+++
b/docs/sql-manual/sql-statements/cluster-management/instance-management/ADD-BROKER.md
@@ -1,7 +1,7 @@
---
{
- "title": "ADD BROKER",
- "language": "en"
+ "title": "ADD BROKER",
+ "language": "en"
}
---
@@ -27,34 +27,43 @@ under the License.
-
-
## Description
-This statement is used to add a BROKER node. (Administrator only!)
+This statement is used to add one or more BROKER nodes.
-grammar:
+## Syntax
```sql
-ALTER SYSTEM ADD BROKER broker_name
"broker_host1:broker_ipc_port1","broker_host2:broker_ipc_port2",...;
+ALTER SYSTEM ADD BROKER <broker_name> "<host>:<ipc_port>" [,
"host>:<ipc_port>" [, ... ] ];
```
-## Example
+## Required Parameters
-1. Add two brokers
+**1. `<broker_name>`**
- ```sql
- ALTER SYSTEM ADD BROKER "host1:port", "host2:port";
- ```
-2. When fe enable
fqdn([fqdn](../../../admin-manual/cluster-management/fqdn.md)),add one Broker
+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_fqdn1:port";
- ```
+**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.
+
+**3. `<ipc_port>`**
-## Keywords
+The PORT of the node where the broker process needs to be added, and the
default value of this port is 8000.
- ALTER, SYSTEM, ADD, FOLLOWER, ALTER SYSTEM
-## Best Practice
+## Access Control Requirements
+The user who executes this operation needs to have the NODE_PRIV permission.
+## Examples
+
+1. Add two Brokers
+
+ ```sql
+ ALTER SYSTEM ADD BROKER "host1:port", "host2:port";
+ ```
+2. Add a Broker using FQDN
+
+ ```sql
+ ALTER SYSTEM ADD BROKER "broker_fqdn1:port";
+ ```
\ No newline at end of file
diff --git
a/docs/sql-manual/sql-statements/cluster-management/instance-management/DROP-BROKER.md
b/docs/sql-manual/sql-statements/cluster-management/instance-management/DROP-BROKER.md
index a331ac571d7..ea2b8b6ea5e 100644
---
a/docs/sql-manual/sql-statements/cluster-management/instance-management/DROP-BROKER.md
+++
b/docs/sql-manual/sql-statements/cluster-management/instance-management/DROP-BROKER.md
@@ -1,7 +1,7 @@
---
{
- "title": "DROP BROKER",
- "language": "en"
+ "title": "DROP BROKER",
+ "language": "en"
}
---
@@ -30,34 +30,46 @@ under the License.
## Description
-This statement is to delete the BROKER node, (administrator only)
+This statement is used to delete BROKER nodes.
-grammar:
-
-```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"...];
-```
-
-## Example
-
-1. Delete all brokers
+## Syntax
+1. Drop all Brokers
```sql
- ALTER SYSTEM DROP ALL BROKER broker_name
+ ALTER SYSTEM DROP ALL BROKER broker_name;
```
-2. Delete a Broker node
-
+2. Drop one or more Broker nodes
```sql
- ALTER SYSTEM DROP BROKER broker_name "host:port"[,"host:port"...];
+ ALTER SYSTEM DROP BROKER <broker_name> "<host>:<ipc_port>"[,
"<host>:<ipc_port>" [, ...] ];
```
+## Required Parameters
+
+**1. `<broker_name>`**
+
+The name of the broker process to be deleted.
+
+**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.
-## Keywords
+**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.
- ALTER, SYSTEM, DROP, FOLLOWER, ALTER SYSTEM
-## Best Practice
+## Access Control Requirements
+The user who executes this operation needs to have the NODE_PRIV permission.
+## Examples
+
+1. Delete all Brokers
+
+ ```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";
+ ```
\ No newline at end of file
diff --git
a/docs/sql-manual/sql-statements/cluster-management/instance-management/SHOW-BROKER.md
b/docs/sql-manual/sql-statements/cluster-management/instance-management/SHOW-BROKER.md
index 6eb4f432476..4678c728252 100644
---
a/docs/sql-manual/sql-statements/cluster-management/instance-management/SHOW-BROKER.md
+++
b/docs/sql-manual/sql-statements/cluster-management/instance-management/SHOW-BROKER.md
@@ -1,7 +1,7 @@
---
{
- "title": "SHOW BROKER",
- "language": "en"
+ "title": "SHOW BROKER",
+ "language": "en"
}
---
@@ -29,26 +29,40 @@ under the License.
## Description
-This statement is used to view the currently existing broker
+This statement is used to view the status of the currently existing broker
processes.
-grammar:
+## Syntax：
```sql
SHOW BROKER;
```
-illustrate:
-
-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.
-
-## Example
-
-## Keywords
-
-SHOW, BROKER
-
-## Best Practice
+## 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 |
+
+
+## Access Control Requirements
+The user executing this statement needs to have the `ADMIN/OPERATOR`
permission.
+
+## Examples
+
+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 | |
+
+-------------+------------+------+-------+---------------------+---------------------+--------+
+ ```
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/ADD-BROKER.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/ADD-BROKER.md
index bf2d9211ce5..6b3fcfc66f4 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/ADD-BROKER.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/ADD-BROKER.md
@@ -1,7 +1,7 @@
---
{
- "title": "ADD BROKER",
- "language": "zh-CN"
+ "title": "ADD BROKER",
+ "language": "zh-CN"
}
---
@@ -30,31 +30,42 @@ under the License.
## 描述
-该语句用于添加一个 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> "<host>:<ipc_port>"
[,"<host>:<ipc_port>" [, ...] ];
```
-## 示例
+## 必选参数
+**1. `<broker_name>`**
-1. 增加两个 Broker
+给添加的 `broker` 进程起的名字。同一个集群中的 broker_name 建议保持一致。
- ```sql
- ALTER SYSTEM ADD BROKER "host1:port", "host2:port";
- ```
-2. fe 开启 fqdn([fqdn](../../../admin-manual/cluster-management/fqdn.md)) 时添加一个
Broker
+**2. `<host>`**
- ```sql
- ALTER SYSTEM ADD BROKER "broker_fqdn1:port";
- ```
+需要添加的 `broker` 进程所在节点的 `IP` ，如果启用了 `FQDN`，则使用该节点的 `FQDN`。
+
+**3. `<ipc_port>`**
+需要添加的 `broker` 进程所在节点的 `PORT` ，该端口默认值为 `8000`。
-## 关键词
+## 输出字段
+无
- ALTER, SYSTEM, ADD, FOLLOWER, ALTER SYSTEM
+## 权限控制
+执行该操作的用户需要具备 `NODE_PRIV` 的权限。
-### 最佳实践
+## 示例
+1. 增加两个 Broker
+
+ ```sql
+ ALTER SYSTEM ADD BROKER "host1:port", "host2:port";
+ ```
+2. 增加一个 Broker，使用 FQDN
+
+ ```sql
+ ALTER SYSTEM ADD BROKER "broker_fqdn1:port";
+ ```
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/DROP-BROKER.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/DROP-BROKER.md
index c219c9fb3ea..ef7a6d3edf6 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/DROP-BROKER.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/DROP-BROKER.md
@@ -1,7 +1,7 @@
---
{
- "title": "DROP BROKER",
- "language": "zh-CN"
+ "title": "DROP BROKER",
+ "language": "zh-CN"
}
---
@@ -29,34 +29,48 @@ under the License.
## 描述
-该语句是删除 BROKER 节点，（仅限管理员使用）
+该语句是删除 BROKER 节点。
-语法：
+## 语法
-```sql
-删除所有 Broker
-ALTER SYSTEM DROP ALL BROKER broker_name
-删除某一个 Broker 节点
-ALTER SYSTEM DROP BROKER broker_name "host:port"[,"host:port"...];
-```
+1. 删除所有 Broker
+ ```sql
+ ALTER SYSTEM DROP ALL BROKER <broker_name>;
+ ```
-## 示例
+2. 删除某一个 Broker 节点
+ ```sql
+ ALTER SYSTEM DROP BROKER <broker_name> "<host>:<ipc_port>"[,
"<host>:<ipc_port>" [, ...] ];
+ ```
+## 必选参数
-1. 删除所有 Broker
+**1. `<broker_name>`**
- ```sql
- ALTER SYSTEM DROP ALL BROKER broker_name
- ```
+需要删除的 `broker` 进程的名字。
-2. 删除某一个 Broker 节点
+**2. `<host>`**
+
+需要删除的 `broker` 进程所在节点的 `IP` ，如果启用了 `FQDN`，则使用该节点的 `FQDN`。
- ```sql
- ALTER SYSTEM DROP BROKER broker_name "host:port"[,"host:port"...];
- ```
+**3. `<ipc_port>`**
-## 关键词
+需要删除的 `broker` 进程所在节点的 `PORT` ，该端口默认值为 `8000`。
- ALTER, SYSTEM, DROP, FOLLOWER, ALTER SYSTEM
+## 输出字段
+无
+## 权限控制
+执行该操作的用户需要具备 `NODE_PRIV` 的权限。
-### 最佳实践
+## 示例
+
+1. 删除所有 Broker
+
+ ```sql
+ ALTER SYSTEM DROP ALL BROKER broker_name；
+ ```
+
+2. 删除某一个 Broker 节点
+ ```sql
+ ALTER SYSTEM DROP BROKER broker_name "10.10.10.1:8000";
+ ```
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/SHOW-BROKER.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/SHOW-BROKER.md
index 48cfab8ba50..b3b7dba2eca 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/SHOW-BROKER.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/SHOW-BROKER.md
@@ -1,7 +1,7 @@
---
{
- "title": "SHOW BROKER",
- "language": "zh-CN"
+ "title": "SHOW BROKER",
+ "language": "zh-CN"
}
---
@@ -29,26 +29,39 @@ under the License.
## 描述
-该语句用于查看当前存在的 broker
+该语句用于查看当前存在的 broker 进程状态。
-语法：
+## 语法：
```sql
SHOW BROKER;
```
-说明：
- 1. LastStartTime 表示最近一次 BE 启动时间。
- 2. LastHeartbeat 表示最近一次心跳。
- 3. Alive 表示节点是否存活。
- 4. ErrMsg 用于显示心跳失败时的错误信息。
+## 输出字段
+| 列名 | 类型 | 说明 |
+|----------------|---------|----------------------|
+| Name | varchar | Broker 进程名称 |
+| Host | varchar | Broker 进程所在节点 IP |
+| Port | varchar | Broker 进程所在节点 Port |
+| Alive | varchar | Broker 进程状态 |
+| LastStartTime | varchar | Broker 进程上次启动时间 |
+| LastUpdateTime | varchar | Broker 进程上次更新时间 |
+| ErrMsg | varchar | Broker 进程上次启动失败的错误信息 |
-## 示例
-
-## 关键词
- SHOW, BROKER
-
-### 最佳实践
+## 权限控制
+执行该语句的用户需要具备 `ADMIN/OPERATOR` 的权限
+## 示例
+1. 查看当前存在的 broker 进程状态
+ ```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 | |
+
+-------------+------------+------+-------+---------------------+---------------------+--------+
+ ```
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/ADD-BROKER.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/ADD-BROKER.md
index 022d768a62f..6b3fcfc66f4 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/ADD-BROKER.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/ADD-BROKER.md
@@ -1,7 +1,7 @@
---
{
- "title": "ADD BROKER",
- "language": "zh-CN"
+ "title": "ADD BROKER",
+ "language": "zh-CN"
}
---
@@ -26,34 +26,46 @@ under the License.
-->
+
+
## 描述
-该语句用于添加一个 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> "<host>:<ipc_port>"
[,"<host>:<ipc_port>" [, ...] ];
```
-## 示例
+## 必选参数
+**1. `<broker_name>`**
-1. 增加两个 Broker
+给添加的 `broker` 进程起的名字。同一个集群中的 broker_name 建议保持一致。
- ```sql
- ALTER SYSTEM ADD BROKER "host1:port", "host2:port";
- ```
+**2. `<host>`**
-2. fe 开启 fqdn([fqdn](../../../admin-manual/cluster-management/fqdn.md)) 时添加一个
Broker
+需要添加的 `broker` 进程所在节点的 `IP` ，如果启用了 `FQDN`，则使用该节点的 `FQDN`。
- ```sql
- ALTER SYSTEM ADD BROKER "broker_fqdn1:port";
- ```
+**3. `<ipc_port>`**
+需要添加的 `broker` 进程所在节点的 `PORT` ，该端口默认值为 `8000`。
-## 关键词
+## 输出字段
+无
- ALTER, SYSTEM, ADD, FOLLOWER, ALTER SYSTEM
+## 权限控制
+执行该操作的用户需要具备 `NODE_PRIV` 的权限。
-## 最佳实践
+## 示例
+
+1. 增加两个 Broker
+ ```sql
+ ALTER SYSTEM ADD BROKER "host1:port", "host2:port";
+ ```
+2. 增加一个 Broker，使用 FQDN
+
+ ```sql
+ ALTER SYSTEM ADD BROKER "broker_fqdn1:port";
+ ```
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/DROP-BROKER.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/DROP-BROKER.md
index 7d7067c9b70..eb2e98c8fda 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/DROP-BROKER.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/DROP-BROKER.md
@@ -1,7 +1,7 @@
---
{
- "title": "DROP BROKER",
- "language": "zh-CN"
+ "title": "DROP BROKER",
+ "language": "zh-CN"
}
---
@@ -29,34 +29,48 @@ under the License.
## 描述
-该语句是删除 BROKER 节点，（仅限管理员使用）
+该语句是删除 BROKER 节点。
-语法：
+## 语法
-```sql
-删除所有 Broker
-ALTER SYSTEM DROP ALL BROKER broker_name
-删除某一个 Broker 节点
-ALTER SYSTEM DROP BROKER broker_name "host:port"[,"host:port"...];
-```
+1. 删除所有 Broker
+ ```sql
+ ALTER SYSTEM DROP ALL BROKER <broker_name>;
+ ```
-## 示例
+2. 删除某一个 Broker 节点
+ ```sql
+ ALTER SYSTEM DROP BROKER <broker_name> "<host>:<ipc_port>"[,
"<host>:<ipc_port>" [, ...] ];
+ ```
+## 必选参数
-1. 删除所有 Broker
+**1. `<broker_name>`**
- ```sql
- ALTER SYSTEM DROP ALL BROKER broker_name
- ```
+需要删除的 `broker` 进程的名字。
-2. 删除某一个 Broker 节点
+**2. `<host>`**
+
+需要删除的 `broker` 进程所在节点的 `IP` ，如果启用了 `FQDN`，则使用该节点的 `FQDN`。
- ```sql
- ALTER SYSTEM DROP BROKER broker_name "host:port"[,"host:port"...];
- ```
+**3. `<ipc_port>`**
-## 关键词
+需要删除的 `broker` 进程所在节点的 `PORT` ，该端口默认值为 `8000`。
- ALTER, SYSTEM, DROP, FOLLOWER, ALTER SYSTEM
+## 输出字段
+无
+## 权限控制
+执行该操作的用户需要具备 `NODE_PRIV` 的权限。
-## 最佳实践
+## 示例
+
+1. 删除所有 Broker
+
+ ```sql
+ ALTER SYSTEM DROP ALL BROKER broker_name；
+ ```
+
+2. 删除某一个 Broker 节点
+ ```sql
+ ALTER SYSTEM DROP BROKER broker_name "10.10.10.1:8000";
+ ```
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/SHOW-BROKER.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/SHOW-BROKER.md
index 2145cd3cf1e..b3b7dba2eca 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/SHOW-BROKER.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/SHOW-BROKER.md
@@ -1,7 +1,7 @@
---
{
- "title": "SHOW BROKER",
- "language": "zh-CN"
+ "title": "SHOW BROKER",
+ "language": "zh-CN"
}
---
@@ -29,26 +29,39 @@ under the License.
## 描述
-该语句用于查看当前存在的 broker
+该语句用于查看当前存在的 broker 进程状态。
-语法：
+## 语法：
```sql
SHOW BROKER;
```
-说明：
-1. LastStartTime 表示最近一次 BE 启动时间。
-2. LastHeartbeat 表示最近一次心跳。
-3. Alive 表示节点是否存活。
-4. ErrMsg 用于显示心跳失败时的错误信息。
+## 输出字段
+| 列名 | 类型 | 说明 |
+|----------------|---------|----------------------|
+| Name | varchar | Broker 进程名称 |
+| Host | varchar | Broker 进程所在节点 IP |
+| Port | varchar | Broker 进程所在节点 Port |
+| Alive | varchar | Broker 进程状态 |
+| LastStartTime | varchar | Broker 进程上次启动时间 |
+| LastUpdateTime | varchar | Broker 进程上次更新时间 |
+| ErrMsg | varchar | Broker 进程上次启动失败的错误信息 |
-## 示例
-
-## 关键词
- SHOW, BROKER
-
-## 最佳实践
+## 权限控制
+执行该语句的用户需要具备 `ADMIN/OPERATOR` 的权限
+## 示例
+1. 查看当前存在的 broker 进程状态
+ ```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 | |
+
+-------------+------------+------+-------+---------------------+---------------------+--------+
+ ```
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/ADD-BROKER.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/ADD-BROKER.md
index bf2d9211ce5..0ecb5e9e902 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/ADD-BROKER.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/ADD-BROKER.md
@@ -1,7 +1,7 @@
---
{
- "title": "ADD BROKER",
- "language": "zh-CN"
+ "title": "ADD BROKER",
+ "language": "zh-CN"
}
---
@@ -30,31 +30,42 @@ under the License.
## 描述
-该语句用于添加一个 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> "<host>:<ipc_port>"
[,"<host>:<ipc_port>" [, ...] ];
```
-## 示例
+## 必选参数
+**1. `<broker_name>`**
-1. 增加两个 Broker
+给添加的 `broker` 进程起的名字。同一个集群中的 broker_name 建议保持一致。
- ```sql
- ALTER SYSTEM ADD BROKER "host1:port", "host2:port";
- ```
-2. fe 开启 fqdn([fqdn](../../../admin-manual/cluster-management/fqdn.md)) 时添加一个
Broker
+**2. `<host>`**
- ```sql
- ALTER SYSTEM ADD BROKER "broker_fqdn1:port";
- ```
+需要添加的 `broker` 进程所在节点的 `IP` ，如果启用了 `FQDN`，则使用该节点的 `FQDN`。
+
+**3. `<ipc_port>`**
+需要添加的 `broker` 进程所在节点的 `PORT` ，该端口默认值为 `8000`。
-## 关键词
+## 输出字段
+无
- ALTER, SYSTEM, ADD, FOLLOWER, ALTER SYSTEM
+## 权限控制
+执行该操作的用户需要具备 `NODE_PRIV` 的权限。
-### 最佳实践
+## 示例
+1. 增加两个 Broker
+
+ ```sql
+ ALTER SYSTEM ADD BROKER "host1:port", "host2:port";
+ ```
+2. 增加一个 Broker，使用 FQDN
+
+ ```sql
+ ALTER SYSTEM ADD BROKER "broker_fqdn1:port";
+ ```
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/DROP-BROKER.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/DROP-BROKER.md
index c219c9fb3ea..eb2e98c8fda 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/DROP-BROKER.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/DROP-BROKER.md
@@ -1,7 +1,7 @@
---
{
- "title": "DROP BROKER",
- "language": "zh-CN"
+ "title": "DROP BROKER",
+ "language": "zh-CN"
}
---
@@ -29,34 +29,48 @@ under the License.
## 描述
-该语句是删除 BROKER 节点，（仅限管理员使用）
+该语句是删除 BROKER 节点。
-语法：
+## 语法
-```sql
-删除所有 Broker
-ALTER SYSTEM DROP ALL BROKER broker_name
-删除某一个 Broker 节点
-ALTER SYSTEM DROP BROKER broker_name "host:port"[,"host:port"...];
-```
+1. 删除所有 Broker
+ ```sql
+ ALTER SYSTEM DROP ALL BROKER <broker_name>;
+ ```
-## 示例
+2. 删除某一个 Broker 节点
+ ```sql
+ ALTER SYSTEM DROP BROKER <broker_name> "<host>:<ipc_port>"[,
"<host>:<ipc_port>" [, ...] ];
+ ```
+## 必选参数
-1. 删除所有 Broker
+**1. `<broker_name>`**
- ```sql
- ALTER SYSTEM DROP ALL BROKER broker_name
- ```
+需要删除的 `broker` 进程的名字。
-2. 删除某一个 Broker 节点
+**2. `<host>`**
+
+需要删除的 `broker` 进程所在节点的 `IP` ，如果启用了 `FQDN`，则使用该节点的 `FQDN`。
- ```sql
- ALTER SYSTEM DROP BROKER broker_name "host:port"[,"host:port"...];
- ```
+**3. `<ipc_port>`**
-## 关键词
+需要删除的 `broker` 进程所在节点的 `PORT` ，该端口默认值为 `8000`。
- ALTER, SYSTEM, DROP, FOLLOWER, ALTER SYSTEM
+## 输出字段
+无
+## 权限控制
+执行该操作的用户需要具备 `NODE_PRIV` 的权限。
-### 最佳实践
+## 示例
+
+1. 删除所有 Broker
+
+ ```sql
+ ALTER SYSTEM DROP ALL BROKER broker_name；
+ ```
+
+2. 删除某一个 Broker 节点
+ ```sql
+ ALTER SYSTEM DROP BROKER broker_name "10.10.10.1:8000";
+ ```
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/SHOW-BROKER.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/SHOW-BROKER.md
index 48cfab8ba50..b3b7dba2eca 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/SHOW-BROKER.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/SHOW-BROKER.md
@@ -1,7 +1,7 @@
---
{
- "title": "SHOW BROKER",
- "language": "zh-CN"
+ "title": "SHOW BROKER",
+ "language": "zh-CN"
}
---
@@ -29,26 +29,39 @@ under the License.
## 描述
-该语句用于查看当前存在的 broker
+该语句用于查看当前存在的 broker 进程状态。
-语法：
+## 语法：
```sql
SHOW BROKER;
```
-说明：
- 1. LastStartTime 表示最近一次 BE 启动时间。
- 2. LastHeartbeat 表示最近一次心跳。
- 3. Alive 表示节点是否存活。
- 4. ErrMsg 用于显示心跳失败时的错误信息。
+## 输出字段
+| 列名 | 类型 | 说明 |
+|----------------|---------|----------------------|
+| Name | varchar | Broker 进程名称 |
+| Host | varchar | Broker 进程所在节点 IP |
+| Port | varchar | Broker 进程所在节点 Port |
+| Alive | varchar | Broker 进程状态 |
+| LastStartTime | varchar | Broker 进程上次启动时间 |
+| LastUpdateTime | varchar | Broker 进程上次更新时间 |
+| ErrMsg | varchar | Broker 进程上次启动失败的错误信息 |
-## 示例
-
-## 关键词
- SHOW, BROKER
-
-### 最佳实践
+## 权限控制
+执行该语句的用户需要具备 `ADMIN/OPERATOR` 的权限
+## 示例
+1. 查看当前存在的 broker 进程状态
+ ```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 | |
+
+-------------+------------+------+-------+---------------------+---------------------+--------+
+ ```
\ No newline at end of file
diff --git
a/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/ADD-BROKER.md
b/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/ADD-BROKER.md
index 542b18cd42e..279abb0e63d 100644
---
a/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/ADD-BROKER.md
+++
b/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/ADD-BROKER.md
@@ -1,7 +1,7 @@
---
{
- "title": "ADD BROKER",
- "language": "en"
+ "title": "ADD BROKER",
+ "language": "en"
}
---
@@ -29,30 +29,41 @@ under the License.
## Description
-This statement is used to add a BROKER node. (Administrator only!)
+This statement is used to add one or more BROKER nodes.
-grammar:
+## Syntax
```sql
-ALTER SYSTEM ADD BROKER broker_name
"broker_host1:broker_ipc_port1","broker_host2:broker_ipc_port2",...;
+ALTER SYSTEM ADD BROKER <broker_name> "<host>:<ipc_port>" [,
"host>:<ipc_port>" [, ... ] ];
```
-## Examples
+## Required Parameters
-1. Add two brokers
+**1. `<broker_name>`**
- ```sql
- ALTER SYSTEM ADD BROKER "host1:port", "host2:port";
- ```
-2. When fe enable
fqdn([fqdn](../../../admin-manual/cluster-management/fqdn.md)),add one Broker
+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_fqdn1:port";
- ```
+**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.
+
+**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.
-## Keywords
- ALTER, SYSTEM, ADD, FOLLOWER, ALTER SYSTEM
+## Access Control Requirements
+The user who executes this operation needs to have the NODE_PRIV permission.
-## Best Practice
+## Examples
+
+1. Add two Brokers
+ ```sql
+ ALTER SYSTEM ADD BROKER "host1:port", "host2:port";
+ ```
+2. Add a Broker using FQDN
+
+ ```sql
+ ALTER SYSTEM ADD BROKER "broker_fqdn1:port";
+ ```
\ No newline at end of file
diff --git
a/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/DROP-BROKER.md
b/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/DROP-BROKER.md
index 85b8081e659..ea2b8b6ea5e 100644
---
a/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/DROP-BROKER.md
+++
b/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/DROP-BROKER.md
@@ -1,7 +1,7 @@
---
{
- "title": "DROP BROKER",
- "language": "en"
+ "title": "DROP BROKER",
+ "language": "en"
}
---
@@ -30,34 +30,46 @@ under the License.
## Description
-This statement is to delete the BROKER node, (administrator only)
+This statement is used to delete BROKER nodes.
-grammar:
-
-```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"...];
-```
-
-## Examples
-
-1. Delete all brokers
+## Syntax
+1. Drop all Brokers
```sql
- ALTER SYSTEM DROP ALL BROKER broker_name
+ ALTER SYSTEM DROP ALL BROKER broker_name;
```
-2. Delete a Broker node
-
+2. Drop one or more Broker nodes
```sql
- ALTER SYSTEM DROP BROKER broker_name "host:port"[,"host:port"...];
+ ALTER SYSTEM DROP BROKER <broker_name> "<host>:<ipc_port>"[,
"<host>:<ipc_port>" [, ...] ];
```
+## Required Parameters
+
+**1. `<broker_name>`**
+
+The name of the broker process to be deleted.
+
+**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.
-## Keywords
+**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.
- ALTER, SYSTEM, DROP, FOLLOWER, ALTER SYSTEM
-## Best Practice
+## Access Control Requirements
+The user who executes this operation needs to have the NODE_PRIV permission.
+## Examples
+
+1. Delete all Brokers
+
+ ```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";
+ ```
\ No newline at end of file
diff --git
a/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/SHOW-BROKER.md
b/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/SHOW-BROKER.md
index 53eaa4c9d91..4678c728252 100644
---
a/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/SHOW-BROKER.md
+++
b/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/SHOW-BROKER.md
@@ -1,7 +1,7 @@
---
{
- "title": "SHOW BROKER",
- "language": "en"
+ "title": "SHOW BROKER",
+ "language": "en"
}
---
@@ -26,28 +26,43 @@ under the License.
+
## Description
-This statement is used to view the currently existing broker
+This statement is used to view the status of the currently existing broker
processes.
-grammar:
+## Syntax：
```sql
SHOW BROKER;
```
-illustrate:
-
-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.
-## Examples
+## 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 |
-## Keywords
- SHOW, BROKER
+## Access Control Requirements
+The user executing this statement needs to have the `ADMIN/OPERATOR`
permission.
-## Best Practice
+## Examples
+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 | |
+
+-------------+------------+------+-------+---------------------+---------------------+--------+
+ ```
\ No newline at end of file
diff --git
a/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/ADD-BROKER.md
b/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/ADD-BROKER.md
index 89fb1703e93..46f41bd13e6 100644
---
a/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/ADD-BROKER.md
+++
b/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/ADD-BROKER.md
@@ -1,7 +1,7 @@
---
{
- "title": "ADD BROKER",
- "language": "en"
+ "title": "ADD BROKER",
+ "language": "en"
}
---
@@ -27,34 +27,44 @@ under the License.
-
-
## Description
-This statement is used to add a BROKER node. (Administrator only!)
+This statement is used to add one or more BROKER nodes.
-grammar:
+## Syntax
```sql
-ALTER SYSTEM ADD BROKER broker_name
"broker_host1:broker_ipc_port1","broker_host2:broker_ipc_port2",...;
+ALTER SYSTEM ADD BROKER <broker_name> "<host>:<ipc_port>" [,
"host>:<ipc_port>" [, ... ] ];
```
-## Example
+## Required Parameters
-1. Add two brokers
+**1. `<broker_name>`**
- ```sql
- ALTER SYSTEM ADD BROKER "host1:port", "host2:port";
- ```
-2. When fe enable
fqdn([fqdn](../../../admin-manual/cluster-management/fqdn.md)),add one Broker
+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_fqdn1:port";
- ```
+**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.
+
+**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.
-## Keywords
- ALTER, SYSTEM, ADD, FOLLOWER, ALTER SYSTEM
+## Access Control Requirements
+The user who executes this operation needs to have the NODE_PRIV permission.
-## Best Practice
+## Examples
+1. Add two Brokers
+
+ ```sql
+ ALTER SYSTEM ADD BROKER "host1:port", "host2:port";
+ ```
+
+2. Add a Broker using FQDN
+
+ ```sql
+ ALTER SYSTEM ADD BROKER "broker_fqdn1:port";
+ ```
\ No newline at end of file
diff --git
a/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/DROP-BROKER.md
b/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/DROP-BROKER.md
index a331ac571d7..ea2b8b6ea5e 100644
---
a/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/DROP-BROKER.md
+++
b/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/DROP-BROKER.md
@@ -1,7 +1,7 @@
---
{
- "title": "DROP BROKER",
- "language": "en"
+ "title": "DROP BROKER",
+ "language": "en"
}
---
@@ -30,34 +30,46 @@ under the License.
## Description
-This statement is to delete the BROKER node, (administrator only)
+This statement is used to delete BROKER nodes.
-grammar:
-
-```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"...];
-```
-
-## Example
-
-1. Delete all brokers
+## Syntax
+1. Drop all Brokers
```sql
- ALTER SYSTEM DROP ALL BROKER broker_name
+ ALTER SYSTEM DROP ALL BROKER broker_name;
```
-2. Delete a Broker node
-
+2. Drop one or more Broker nodes
```sql
- ALTER SYSTEM DROP BROKER broker_name "host:port"[,"host:port"...];
+ ALTER SYSTEM DROP BROKER <broker_name> "<host>:<ipc_port>"[,
"<host>:<ipc_port>" [, ...] ];
```
+## Required Parameters
+
+**1. `<broker_name>`**
+
+The name of the broker process to be deleted.
+
+**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.
-## Keywords
+**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.
- ALTER, SYSTEM, DROP, FOLLOWER, ALTER SYSTEM
-## Best Practice
+## Access Control Requirements
+The user who executes this operation needs to have the NODE_PRIV permission.
+## Examples
+
+1. Delete all Brokers
+
+ ```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";
+ ```
\ No newline at end of file
diff --git
a/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/SHOW-BROKER.md
b/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/SHOW-BROKER.md
index 6eb4f432476..4678c728252 100644
---
a/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/SHOW-BROKER.md
+++
b/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/SHOW-BROKER.md
@@ -1,7 +1,7 @@
---
{
- "title": "SHOW BROKER",
- "language": "en"
+ "title": "SHOW BROKER",
+ "language": "en"
}
---
@@ -29,26 +29,40 @@ under the License.
## Description
-This statement is used to view the currently existing broker
+This statement is used to view the status of the currently existing broker
processes.
-grammar:
+## Syntax：
```sql
SHOW BROKER;
```
-illustrate:
-
-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.
-
-## Example
-
-## Keywords
-
-SHOW, BROKER
-
-## Best Practice
+## 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 |
+
+
+## Access Control Requirements
+The user executing this statement needs to have the `ADMIN/OPERATOR`
permission.
+
+## Examples
+
+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 | |
+
+-------------+------------+------+-------+---------------------+---------------------+--------+
+ ```
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
