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 8ce7e648986 [Doc](stmt) Update add follower,add observer, drop
follower and drop … (#2200)
8ce7e648986 is described below
commit 8ce7e64898692bf3766960c6b5f0ad3bf712fb16
Author: xyf <[email protected]>
AuthorDate: Wed Apr 23 19:44:23 2025 +0800
[Doc](stmt) Update add follower,add observer, drop follower and drop …
(#2200)
…observer
## Versions
- [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-FOLLOWER.md | 43 +++++++++++++---------
.../instance-management/ADD-OBSERVER.md | 43 +++++++++++++---------
.../instance-management/DROP-FOLLOWER.md | 41 +++++++++++++--------
.../instance-management/DROP-OBSERVER.md | 41 ++++++++++++---------
.../instance-management/ADD-FOLLOWER.md | 39 +++++++++++++-------
.../instance-management/ADD-OBSERVER.md | 37 ++++++++++++-------
.../instance-management/DROP-FOLLOWER.md | 40 ++++++++++++--------
.../instance-management/DROP-OBSERVER.md | 41 ++++++++++++---------
.../instance-management/ADD-FOLLOWER.md | 40 ++++++++++++--------
.../instance-management/ADD-OBSERVER.md | 36 ++++++++++++------
.../instance-management/DROP-FOLLOWER.md | 40 ++++++++++++--------
.../instance-management/DROP-OBSERVER.md | 40 ++++++++++++--------
.../instance-management/ADD-FOLLOWER.md | 39 +++++++++++++-------
.../instance-management/ADD-OBSERVER.md | 37 ++++++++++++-------
.../instance-management/DROP-FOLLOWER.md | 40 ++++++++++++--------
.../instance-management/DROP-OBSERVER.md | 41 ++++++++++++---------
.../instance-management/ADD-FOLLOWER.md | 43 +++++++++++++---------
.../instance-management/ADD-OBSERVER.md | 41 +++++++++++++--------
.../instance-management/DROP-FOLLOWER.md | 40 +++++++++++++-------
.../instance-management/DROP-OBSERVER.md | 42 ++++++++++++---------
.../instance-management/ADD-FOLLOWER.md | 43 +++++++++++++---------
.../instance-management/ADD-OBSERVER.md | 43 +++++++++++++---------
.../instance-management/DROP-FOLLOWER.md | 41 +++++++++++++--------
.../instance-management/DROP-OBSERVER.md | 41 ++++++++++++---------
24 files changed, 595 insertions(+), 377 deletions(-)
diff --git
a/docs/sql-manual/sql-statements/cluster-management/instance-management/ADD-FOLLOWER.md
b/docs/sql-manual/sql-statements/cluster-management/instance-management/ADD-FOLLOWER.md
index 2a010cdb922..944403616f8 100644
---
a/docs/sql-manual/sql-statements/cluster-management/instance-management/ADD-FOLLOWER.md
+++
b/docs/sql-manual/sql-statements/cluster-management/instance-management/ADD-FOLLOWER.md
@@ -24,36 +24,45 @@ specific language governing permissions and limitations
under the License.
-->
+## Description
+This statement adds a node with the FOLLOWER role to the FRONTEND node (only
used by administrators!)
+## Syntax
+```sql
+ALTER SYSTEM ADD FOLLOWER "<follower_host>:<edit_log_port>"
+```
-## Description
+## Required Parameters
-This statement is to increase the node of the FOLLOWER role of FRONTEND, (only
for administrators!)
+**1. `<follower_host>`**
-grammar:
+> Can be the hostname or IP address of the FE node
-```sql
-ALTER SYSTEM ADD FOLLOWER "follower_host:edit_log_port"
-```
+**2. `<edit_log_port>`**
-illustrate:
+> bdbje communication port of FE node, the default is 9010
-1. host can be a hostname or an ip address
-2. edit_log_port : edit_log_port in its configuration file fe.conf
+## Access Control Requirements
-## Example
+The user executing this SQL command must have at least the following
permissions:
-1. Add a FOLLOWER node
+| Privilege | Object | Notes |
+|-----------|----|-------|
+| NODE_PRIV | | |
- ```sql
- ALTER SYSTEM ADD FOLLOWER "host_ip:9010"
- ```
+## Usage Notes
-## Keywords
+1. Before adding a new FOLLOWER node, make sure the node is properly
configured.
+2. Before adding a FOLLOWER node, ensure that the number of FOLLOWER nodes in
the cluster is an odd number after the addition.
+3. After adding the FOLLOWER node, use[`SHOW
FRONTENDS`](./SHOW-FRONTENDS.md)command to verify that they have been added
successfully and are in a normal state.
- ALTER, SYSTEM, ADD, FOLLOWER, ALTER SYSTEM
+## Examples
-## Best Practice
+1. Add a FOLLOWER node
+ ```sql
+ ALTER SYSTEM ADD FOLLOWER "host_ip:9010"
+ ```
+ This command adds a FOLLOWER node to the cluster (IP host_ip, port 9010)
diff --git
a/docs/sql-manual/sql-statements/cluster-management/instance-management/ADD-OBSERVER.md
b/docs/sql-manual/sql-statements/cluster-management/instance-management/ADD-OBSERVER.md
index dac588cdcc2..18cce583561 100644
---
a/docs/sql-manual/sql-statements/cluster-management/instance-management/ADD-OBSERVER.md
+++
b/docs/sql-manual/sql-statements/cluster-management/instance-management/ADD-OBSERVER.md
@@ -24,36 +24,43 @@ specific language governing permissions and limitations
under the License.
-->
-
-
-
-
## Description
-This statement is to increase the node of the OBSERVER role of FRONTEND, (only
for administrators!)
+This statement adds a node with the OBSERVER role to the FRONTEND node (only
used by administrators!)
-grammar:
+## Syntax
```sql
-ALTER SYSTEM ADD OBSERVER "follower_host:edit_log_port"
+ALTER SYSTEM ADD OBSERVER "<observer_host>:<edit_log_port>"
```
-illustrate:
+## Required Parameters
+
+**1. `<observer_host>`**
+
+> Can be the hostname or IP address of the FE node
+
+**2. `<edit_log_port>`**
-1. host can be a hostname or an ip address
-2. edit_log_port : edit_log_port in its configuration file fe.conf
+> bdbje communication port of FE node, the default is 9010
-## Example
+## Access Control Requirements
-1. Add an OBSERVER node
+The user executing this SQL command must have at least the following
permissions:
- ```sql
- ALTER SYSTEM ADD OBSERVER "host_ip:9010"
- ```
+| Privilege | Object | Notes |
+|-----------|----|-------|
+| NODE_PRIV | | |
-## Keywords
+## Usage Notes
- ALTER, SYSTEM, ADD, OBSERVER, ALTER SYSTEM
+1. Before adding a new OBSERVER node, make sure the node is properly
configured.
+2. After adding the OBSERVER node, use[`SHOW
FRONTENDS`](./SHOW-FRONTENDS.md)command to verify that they have been added
successfully and are in a normal state.
-## Best Practice
+## Examples
+1. Add a OBSERVER node
+ ```sql
+ ALTER SYSTEM ADD OBSERVER "host_ip:9010"
+ ```
+ This command adds a OBSERVER node to the cluster (IP host_ip, port 9010)
diff --git
a/docs/sql-manual/sql-statements/cluster-management/instance-management/DROP-FOLLOWER.md
b/docs/sql-manual/sql-statements/cluster-management/instance-management/DROP-FOLLOWER.md
index 70a3a362cbe..23ecb464bfe 100644
---
a/docs/sql-manual/sql-statements/cluster-management/instance-management/DROP-FOLLOWER.md
+++
b/docs/sql-manual/sql-statements/cluster-management/instance-management/DROP-FOLLOWER.md
@@ -24,34 +24,45 @@ specific language governing permissions and limitations
under the License.
-->
-
-
## Description
-This statement is to delete the node of the FOLLOWER role of FRONTEND, (only
for administrators!)
+This statement deletes the node with the FOLLOWER role of FRONTEND. (For
administrators only!)
-Grammar:
+## Syntax
```sql
-ALTER SYSTEM DROP FOLLOWER "follower_host:edit_log_port"
+ALTER SYSTEM DROP FOLLOWER "<follower_host>:<edit_log_port>"
```
-Illustration:
+## Required Parameters
-1. host can be a hostname or an ip address
+**1. `<follower_host>`**
-2. edit_log_port : edit_log_port in its configuration file fe.conf
+> Can be the hostname or IP address of the FE node
-## Example
+**2. `<edit_log_port>`**
-1. Delete a FOLLOWER node
+> bdbje communication port of FE node, the default is 9010
+
+## Access Control Requirements
- ```sql
- ALTER SYSTEM DROP FOLLOWER "host_ip:9010"
- ```
+The user executing this SQL command must have at least the following
permissions:
-## Keywords
+| Privilege | Object | Notes |
+|-----------|----|-------|
+| NODE_PRIV | | |
-ALTER, SYSTEM, DROP, FOLLOWER, ALTER SYSTEM
+## Usage Notes
+1. Before deleting a FOLLOWER node, make sure that the node that needs to be
taken offline is not a Master node.
+2. Before deleting a FOLLOWER node, ensure that the number of FOLLOWER nodes
in the cluster is an odd number after they go offline.
+3. After deleting the FOLLOWER node[`SHOW
FRONTENDS`](./SHOW-FRONTENDS.md)command to verify that they were successfully
deleted.
+
+## Examples
+
+1. Delete a FOLLOWER node
+ ```sql
+ ALTER SYSTEM DROP FOLLOWER "host_ip:9010"
+ ```
+ This command deletes a FOLLOWER node in the cluster (IP host_ip, port 9010)
diff --git
a/docs/sql-manual/sql-statements/cluster-management/instance-management/DROP-OBSERVER.md
b/docs/sql-manual/sql-statements/cluster-management/instance-management/DROP-OBSERVER.md
index cc6f6c4c218..97bfcf061ef 100644
---
a/docs/sql-manual/sql-statements/cluster-management/instance-management/DROP-OBSERVER.md
+++
b/docs/sql-manual/sql-statements/cluster-management/instance-management/DROP-OBSERVER.md
@@ -24,36 +24,43 @@ specific language governing permissions and limitations
under the License.
-->
+## Description
+This statement deletes the node with the OBSERVER role of FRONTEND (only used
by administrators!)
+## Syntax
+```sql
+ALTER SYSTEM DROP OBSERVER "<observer_host>:<edit_log_port>"
+```
-## Description
+## Required Parameters
-This statement is to delete the node of the OBSERVER role of FRONTEND, (only
for administrators!)
+**1. `<observer_host>`**
-grammar:
+> Can be the hostname or IP address of the FE node
-```sql
-ALTER SYSTEM DROP OBSERVER "follower_host:edit_log_port"
-```
+**2. `<edit_log_port>`**
-illustrate:
+> bdbje communication port of FE node, the default is 9010
-1. host can be a hostname or an ip address
-2. edit_log_port : edit_log_port in its configuration file fe.conf
+## Access Control Requirements
-## Example
+The user executing this SQL command must have at least the following
permissions:
-1. Add a FOLLOWER node
+| Privilege | Object | Notes |
+|-----------|----|-------|
+| NODE_PRIV | | |
- ```sql
- ALTER SYSTEM DROP OBSERVER "host_ip:9010"
- ```
+## Usage Notes
-## Keywords
+1. After deleting the OBSERVER node, use[`SHOW
FRONTENDS`](./SHOW-FRONTENDS.md)command to verify that they were successfully
deleted.
- ALTER, SYSTEM, DROP, OBSERVER, ALTER SYSTEM
+## Examples
-## Best Practice
+1. Deleting an OBSERVER node
+ ```sql
+ ALTER SYSTEM DROP OBSERVER "host_ip:9010"
+ ```
+ This command deletes an OBSERVER node in the cluster (IP host_ip, port 9010)
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/ADD-FOLLOWER.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/ADD-FOLLOWER.md
index 5836ed12fd1..f54747b3915 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/ADD-FOLLOWER.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/ADD-FOLLOWER.md
@@ -24,22 +24,39 @@ specific language governing permissions and limitations
under the License.
-->
-
-
## 描述
该语句是增加 FRONTEND 的 FOLLOWER 角色的节点,(仅管理员使用!)
-语法:
+## 语法:
```sql
-ALTER SYSTEM ADD FOLLOWER "follower_host:edit_log_port"
+ALTER SYSTEM ADD FOLLOWER "<follower_host>:<edit_log_port>"
```
-说明:
+## 必选参数
+
+**1. `<follower_host>`**
+
+> 可以是 FE 节点的主机名或 IP 地址
+
+**2. `<edit_log_port>`**
+
+> FE 节点的 bdbje 通信端口,默认为 9010
+
+## 权限控制
-1. host 可以是主机名或者 ip 地址
-2. edit_log_port : edit_log_port 在其配置文件 fe.conf
+执行此 SQL 命令的用户必须至少具有以下权限:
+
+| 权限 | 对象 | 说明 |
+|-----------|----|----|
+| NODE_PRIV | | |
+
+## 注意事项
+
+1. 在添加新的 FOLLOWER 节点之前,确保节点已正确配置。
+2. 在添加 FOLLOWER 节点之前,确保集群中 FOLLOWER 节点在新增之后数量为奇数个。
+3. 添加 FOLLOWER 节点后,使用[`SHOW
FRONTENDS`](./SHOW-FRONTENDS.md)命令验证它们是否已成功添加并处于正常状态。
## 示例
@@ -48,10 +65,4 @@ ALTER SYSTEM ADD FOLLOWER "follower_host:edit_log_port"
```sql
ALTER SYSTEM ADD FOLLOWER "host_ip:9010"
```
-
-## 关键词
-
- ALTER, SYSTEM, ADD, FOLLOWER, ALTER SYSTEM
-
-### 最佳实践
-
+ 此命令向集群添加一个 FOLLOWER 节点( IP host_ip,端口 9010)
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/ADD-OBSERVER.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/ADD-OBSERVER.md
index 32720212c79..9a556430631 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/ADD-OBSERVER.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/ADD-OBSERVER.md
@@ -24,21 +24,38 @@ specific language governing permissions and limitations
under the License.
-->
-
## 描述
该语句是增加 FRONTEND 的 OBSERVER 角色的节点,(仅管理员使用!)
-语法:
+## 语法
```sql
-ALTER SYSTEM ADD OBSERVER "follower_host:edit_log_port"
+ALTER SYSTEM ADD OBSERVER "<observer_host>:<edit_log_port>"
```
-说明:
+## 必选参数
+
+**1. `<observer_host>`**
+
+> 可以是 FE 节点的主机名或 IP 地址
+
+**2. `<edit_log_port>`**
+
+> FE 节点的 bdbje 通信端口,默认为 9010
+
+## 权限控制
+
+执行此 SQL 命令的用户必须至少具有以下权限:
-1. host 可以是主机名或者 ip 地址
-2. edit_log_port : edit_log_port 在其配置文件 fe.conf
+| 权限 | 对象 | 说明 |
+|-----------|----|----|
+| NODE_PRIV | | |
+
+## 注意事项
+
+1. 在添加新的 OBSERVER 节点之前,确保节点已正确配置。
+2. 添加 OBSERVER 节点后,使用[`SHOW
FRONTENDS`](./SHOW-FRONTENDS.md)命令验证它们是否已成功添加并处于正常状态。
## 示例
@@ -47,10 +64,4 @@ ALTER SYSTEM ADD OBSERVER "follower_host:edit_log_port"
```sql
ALTER SYSTEM ADD OBSERVER "host_ip:9010"
```
-
-## 关键词
-
- ALTER, SYSTEM, ADD, OBSERVER, ALTER SYSTEM
-
-### 最佳实践
-
+ 此命令向集群添加一个 OBSERVER 节点( IP host_ip,端口 9010)
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/DROP-FOLLOWER.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/DROP-FOLLOWER.md
index de9a1ada9f8..31e38de0e75 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/DROP-FOLLOWER.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/DROP-FOLLOWER.md
@@ -24,37 +24,45 @@ specific language governing permissions and limitations
under the License.
-->
-
-
-
-
## 描述
该语句是删除 FRONTEND 的 FOLLOWER 角色的节点,(仅管理员使用!)
-语法:
+## 语法
```sql
-ALTER SYSTEM DROP FOLLOWER "follower_host:edit_log_port"
+ALTER SYSTEM DROP FOLLOWER "<follower_host>:<edit_log_port>"
```
-说明:
+## 必选参数
-1. host 可以是主机名或者 ip 地址
+**1. `<follower_host>`**
-2. edit_log_port : edit_log_port 在其配置文件 fe.conf
+> 可以是 FE 节点的主机名或 IP 地址
-## 示例
+**2. `<edit_log_port>`**
-1. 删除一个 FOLLOWER 节点
+> FE 节点的 bdbje 通信端口,默认为 9010
+
+## 权限控制
- ```sql
- ALTER SYSTEM DROP FOLLOWER "host_ip:9010"
- ```
+执行此 SQL 命令的用户必须至少具有以下权限:
-## 关键词
+| 权限 | 对象 | 说明 |
+|-----------|----|----|
+| NODE_PRIV | | |
-ALTER, SYSTEM, DROP, FOLLOWER, ALTER SYSTEM
+## 注意事项
+1. 在删除 FOLLOWER 节点之前,确保需要下线的节点不是 Master 节点。
+2. 在删除 FOLLOWER 节点之前,确保集群中 FOLLOWER 节点在下线之后数量为奇数个。
+3. 删除 FOLLOWER 节点后,使用[`SHOW FRONTENDS`](./SHOW-FRONTENDS.md)命令验证它们是否已成功删除。
+## 示例
+
+1. 删除一个 FOLLOWER 节点
+ ```sql
+ ALTER SYSTEM DROP FOLLOWER "host_ip:9010"
+ ```
+ 此命令是删除集群中的一个 FOLLOWER 节点( IP host_ip,端口 9010)
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/DROP-OBSERVER.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/DROP-OBSERVER.md
index 53fd878ffca..77b5cc8b242 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/DROP-OBSERVER.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/DROP-OBSERVER.md
@@ -24,36 +24,43 @@ specific language governing permissions and limitations
under the License.
-->
-
-
-
-
## 描述
该语句是删除 FRONTEND 的 OBSERVER 角色的节点,(仅管理员使用!)
-语法:
+## 语法
```sql
-ALTER SYSTEM DROP OBSERVER "follower_host:edit_log_port"
+ALTER SYSTEM DROP OBSERVER "<observer_host>:<edit_log_port>"
```
-说明:
+## 必选参数
-1. host 可以是主机名或者 ip 地址
-2. edit_log_port : edit_log_port 在其配置文件 fe.conf
+**1. `<observer_host>`**
-## 示例
+> 可以是 FE 节点的主机名或 IP 地址
-1. 添加一个 FOLLOWER 节点
+**2. `<edit_log_port>`**
- ```sql
- ALTER SYSTEM DROP OBSERVER "host_ip:9010"
- ```
+> FE 节点的 bdbje 通信端口,默认为 9010
-## 关键词
+## 权限控制
- ALTER, SYSTEM, DROP, OBSERVER, ALTER SYSTEM
+执行此 SQL 命令的用户必须至少具有以下权限:
-### 最佳实践
+| 权限 | 对象 | 说明 |
+|-----------|----|----|
+| NODE_PRIV | | |
+## 注意事项
+
+1. 删除 OBSERVER 节点后,使用[`SHOW FRONTENDS`](./SHOW-FRONTENDS.md)命令验证它们是否已成功删除。
+
+## 示例
+
+1. 删除一个 OBSERVER 节点
+
+ ```sql
+ ALTER SYSTEM DROP OBSERVER "host_ip:9010"
+ ```
+ 此命令是删除集群中的一个 OBSERVER 节点( IP host_ip,端口 9010)
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/ADD-FOLLOWER.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/ADD-FOLLOWER.md
index 519bd3d5f13..f54747b3915 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/ADD-FOLLOWER.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/ADD-FOLLOWER.md
@@ -24,23 +24,39 @@ specific language governing permissions and limitations
under the License.
-->
-
-
## 描述
-
该语句是增加 FRONTEND 的 FOLLOWER 角色的节点,(仅管理员使用!)
-语法:
+## 语法:
```sql
-ALTER SYSTEM ADD FOLLOWER "follower_host:edit_log_port"
+ALTER SYSTEM ADD FOLLOWER "<follower_host>:<edit_log_port>"
```
-说明:
+## 必选参数
+
+**1. `<follower_host>`**
+
+> 可以是 FE 节点的主机名或 IP 地址
+
+**2. `<edit_log_port>`**
+
+> FE 节点的 bdbje 通信端口,默认为 9010
+
+## 权限控制
-1. host 可以是主机名或者 ip 地址
-2. edit_log_port : edit_log_port 在其配置文件 fe.conf
+执行此 SQL 命令的用户必须至少具有以下权限:
+
+| 权限 | 对象 | 说明 |
+|-----------|----|----|
+| NODE_PRIV | | |
+
+## 注意事项
+
+1. 在添加新的 FOLLOWER 节点之前,确保节点已正确配置。
+2. 在添加 FOLLOWER 节点之前,确保集群中 FOLLOWER 节点在新增之后数量为奇数个。
+3. 添加 FOLLOWER 节点后,使用[`SHOW
FRONTENDS`](./SHOW-FRONTENDS.md)命令验证它们是否已成功添加并处于正常状态。
## 示例
@@ -49,10 +65,4 @@ ALTER SYSTEM ADD FOLLOWER "follower_host:edit_log_port"
```sql
ALTER SYSTEM ADD FOLLOWER "host_ip:9010"
```
-
-## 关键词
-
- ALTER, SYSTEM, ADD, FOLLOWER, ALTER SYSTEM
-
-## 最佳实践
-
+ 此命令向集群添加一个 FOLLOWER 节点( IP host_ip,端口 9010)
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/ADD-OBSERVER.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/ADD-OBSERVER.md
index 4710942549e..9a556430631 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/ADD-OBSERVER.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/ADD-OBSERVER.md
@@ -28,16 +28,34 @@ under the License.
该语句是增加 FRONTEND 的 OBSERVER 角色的节点,(仅管理员使用!)
-语法:
+## 语法
```sql
-ALTER SYSTEM ADD OBSERVER "follower_host:edit_log_port"
+ALTER SYSTEM ADD OBSERVER "<observer_host>:<edit_log_port>"
```
-说明:
+## 必选参数
-1. host 可以是主机名或者 ip 地址
-2. edit_log_port : edit_log_port 在其配置文件 fe.conf
+**1. `<observer_host>`**
+
+> 可以是 FE 节点的主机名或 IP 地址
+
+**2. `<edit_log_port>`**
+
+> FE 节点的 bdbje 通信端口,默认为 9010
+
+## 权限控制
+
+执行此 SQL 命令的用户必须至少具有以下权限:
+
+| 权限 | 对象 | 说明 |
+|-----------|----|----|
+| NODE_PRIV | | |
+
+## 注意事项
+
+1. 在添加新的 OBSERVER 节点之前,确保节点已正确配置。
+2. 添加 OBSERVER 节点后,使用[`SHOW
FRONTENDS`](./SHOW-FRONTENDS.md)命令验证它们是否已成功添加并处于正常状态。
## 示例
@@ -46,10 +64,4 @@ ALTER SYSTEM ADD OBSERVER "follower_host:edit_log_port"
```sql
ALTER SYSTEM ADD OBSERVER "host_ip:9010"
```
-
-## 关键词
-
- ALTER, SYSTEM, ADD, OBSERVER, ALTER SYSTEM
-
-## 最佳实践
-
+ 此命令向集群添加一个 OBSERVER 节点( IP host_ip,端口 9010)
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/DROP-FOLLOWER.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/DROP-FOLLOWER.md
index de9a1ada9f8..31e38de0e75 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/DROP-FOLLOWER.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/DROP-FOLLOWER.md
@@ -24,37 +24,45 @@ specific language governing permissions and limitations
under the License.
-->
-
-
-
-
## 描述
该语句是删除 FRONTEND 的 FOLLOWER 角色的节点,(仅管理员使用!)
-语法:
+## 语法
```sql
-ALTER SYSTEM DROP FOLLOWER "follower_host:edit_log_port"
+ALTER SYSTEM DROP FOLLOWER "<follower_host>:<edit_log_port>"
```
-说明:
+## 必选参数
-1. host 可以是主机名或者 ip 地址
+**1. `<follower_host>`**
-2. edit_log_port : edit_log_port 在其配置文件 fe.conf
+> 可以是 FE 节点的主机名或 IP 地址
-## 示例
+**2. `<edit_log_port>`**
-1. 删除一个 FOLLOWER 节点
+> FE 节点的 bdbje 通信端口,默认为 9010
+
+## 权限控制
- ```sql
- ALTER SYSTEM DROP FOLLOWER "host_ip:9010"
- ```
+执行此 SQL 命令的用户必须至少具有以下权限:
-## 关键词
+| 权限 | 对象 | 说明 |
+|-----------|----|----|
+| NODE_PRIV | | |
-ALTER, SYSTEM, DROP, FOLLOWER, ALTER SYSTEM
+## 注意事项
+1. 在删除 FOLLOWER 节点之前,确保需要下线的节点不是 Master 节点。
+2. 在删除 FOLLOWER 节点之前,确保集群中 FOLLOWER 节点在下线之后数量为奇数个。
+3. 删除 FOLLOWER 节点后,使用[`SHOW FRONTENDS`](./SHOW-FRONTENDS.md)命令验证它们是否已成功删除。
+## 示例
+
+1. 删除一个 FOLLOWER 节点
+ ```sql
+ ALTER SYSTEM DROP FOLLOWER "host_ip:9010"
+ ```
+ 此命令是删除集群中的一个 FOLLOWER 节点( IP host_ip,端口 9010)
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/DROP-OBSERVER.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/DROP-OBSERVER.md
index bdb20083794..77b5cc8b242 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/DROP-OBSERVER.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/DROP-OBSERVER.md
@@ -24,35 +24,43 @@ specific language governing permissions and limitations
under the License.
-->
-
-
## 描述
-
该语句是删除 FRONTEND 的 OBSERVER 角色的节点,(仅管理员使用!)
-语法:
+## 语法
```sql
-ALTER SYSTEM DROP OBSERVER "follower_host:edit_log_port"
+ALTER SYSTEM DROP OBSERVER "<observer_host>:<edit_log_port>"
```
-说明:
-1. host 可以是主机名或者 ip 地址
-2. edit_log_port : edit_log_port 在其配置文件 fe.conf
+## 必选参数
-## 示例
+**1. `<observer_host>`**
+> 可以是 FE 节点的主机名或 IP 地址
-1. 添加一个 FOLLOWER 节点
+**2. `<edit_log_port>`**
- ```sql
- ALTER SYSTEM DROP OBSERVER "host_ip:9010"
- ```
+> FE 节点的 bdbje 通信端口,默认为 9010
+
+## 权限控制
-## 关键词
+执行此 SQL 命令的用户必须至少具有以下权限:
- ALTER, SYSTEM, DROP, OBSERVER, ALTER SYSTEM
+| 权限 | 对象 | 说明 |
+|-----------|----|----|
+| NODE_PRIV | | |
-## 最佳实践
+## 注意事项
+1. 删除 OBSERVER 节点后,使用[`SHOW FRONTENDS`](./SHOW-FRONTENDS.md)命令验证它们是否已成功删除。
+
+## 示例
+
+1. 删除一个 OBSERVER 节点
+
+ ```sql
+ ALTER SYSTEM DROP OBSERVER "host_ip:9010"
+ ```
+ 此命令是删除集群中的一个 OBSERVER 节点( IP host_ip,端口 9010)
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/ADD-FOLLOWER.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/ADD-FOLLOWER.md
index 5836ed12fd1..f54747b3915 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/ADD-FOLLOWER.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/ADD-FOLLOWER.md
@@ -24,22 +24,39 @@ specific language governing permissions and limitations
under the License.
-->
-
-
## 描述
该语句是增加 FRONTEND 的 FOLLOWER 角色的节点,(仅管理员使用!)
-语法:
+## 语法:
```sql
-ALTER SYSTEM ADD FOLLOWER "follower_host:edit_log_port"
+ALTER SYSTEM ADD FOLLOWER "<follower_host>:<edit_log_port>"
```
-说明:
+## 必选参数
+
+**1. `<follower_host>`**
+
+> 可以是 FE 节点的主机名或 IP 地址
+
+**2. `<edit_log_port>`**
+
+> FE 节点的 bdbje 通信端口,默认为 9010
+
+## 权限控制
-1. host 可以是主机名或者 ip 地址
-2. edit_log_port : edit_log_port 在其配置文件 fe.conf
+执行此 SQL 命令的用户必须至少具有以下权限:
+
+| 权限 | 对象 | 说明 |
+|-----------|----|----|
+| NODE_PRIV | | |
+
+## 注意事项
+
+1. 在添加新的 FOLLOWER 节点之前,确保节点已正确配置。
+2. 在添加 FOLLOWER 节点之前,确保集群中 FOLLOWER 节点在新增之后数量为奇数个。
+3. 添加 FOLLOWER 节点后,使用[`SHOW
FRONTENDS`](./SHOW-FRONTENDS.md)命令验证它们是否已成功添加并处于正常状态。
## 示例
@@ -48,10 +65,4 @@ ALTER SYSTEM ADD FOLLOWER "follower_host:edit_log_port"
```sql
ALTER SYSTEM ADD FOLLOWER "host_ip:9010"
```
-
-## 关键词
-
- ALTER, SYSTEM, ADD, FOLLOWER, ALTER SYSTEM
-
-### 最佳实践
-
+ 此命令向集群添加一个 FOLLOWER 节点( IP host_ip,端口 9010)
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/ADD-OBSERVER.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/ADD-OBSERVER.md
index 32720212c79..9a556430631 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/ADD-OBSERVER.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/ADD-OBSERVER.md
@@ -24,21 +24,38 @@ specific language governing permissions and limitations
under the License.
-->
-
## 描述
该语句是增加 FRONTEND 的 OBSERVER 角色的节点,(仅管理员使用!)
-语法:
+## 语法
```sql
-ALTER SYSTEM ADD OBSERVER "follower_host:edit_log_port"
+ALTER SYSTEM ADD OBSERVER "<observer_host>:<edit_log_port>"
```
-说明:
+## 必选参数
+
+**1. `<observer_host>`**
+
+> 可以是 FE 节点的主机名或 IP 地址
+
+**2. `<edit_log_port>`**
+
+> FE 节点的 bdbje 通信端口,默认为 9010
+
+## 权限控制
+
+执行此 SQL 命令的用户必须至少具有以下权限:
-1. host 可以是主机名或者 ip 地址
-2. edit_log_port : edit_log_port 在其配置文件 fe.conf
+| 权限 | 对象 | 说明 |
+|-----------|----|----|
+| NODE_PRIV | | |
+
+## 注意事项
+
+1. 在添加新的 OBSERVER 节点之前,确保节点已正确配置。
+2. 添加 OBSERVER 节点后,使用[`SHOW
FRONTENDS`](./SHOW-FRONTENDS.md)命令验证它们是否已成功添加并处于正常状态。
## 示例
@@ -47,10 +64,4 @@ ALTER SYSTEM ADD OBSERVER "follower_host:edit_log_port"
```sql
ALTER SYSTEM ADD OBSERVER "host_ip:9010"
```
-
-## 关键词
-
- ALTER, SYSTEM, ADD, OBSERVER, ALTER SYSTEM
-
-### 最佳实践
-
+ 此命令向集群添加一个 OBSERVER 节点( IP host_ip,端口 9010)
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/DROP-FOLLOWER.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/DROP-FOLLOWER.md
index de9a1ada9f8..31e38de0e75 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/DROP-FOLLOWER.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/DROP-FOLLOWER.md
@@ -24,37 +24,45 @@ specific language governing permissions and limitations
under the License.
-->
-
-
-
-
## 描述
该语句是删除 FRONTEND 的 FOLLOWER 角色的节点,(仅管理员使用!)
-语法:
+## 语法
```sql
-ALTER SYSTEM DROP FOLLOWER "follower_host:edit_log_port"
+ALTER SYSTEM DROP FOLLOWER "<follower_host>:<edit_log_port>"
```
-说明:
+## 必选参数
-1. host 可以是主机名或者 ip 地址
+**1. `<follower_host>`**
-2. edit_log_port : edit_log_port 在其配置文件 fe.conf
+> 可以是 FE 节点的主机名或 IP 地址
-## 示例
+**2. `<edit_log_port>`**
-1. 删除一个 FOLLOWER 节点
+> FE 节点的 bdbje 通信端口,默认为 9010
+
+## 权限控制
- ```sql
- ALTER SYSTEM DROP FOLLOWER "host_ip:9010"
- ```
+执行此 SQL 命令的用户必须至少具有以下权限:
-## 关键词
+| 权限 | 对象 | 说明 |
+|-----------|----|----|
+| NODE_PRIV | | |
-ALTER, SYSTEM, DROP, FOLLOWER, ALTER SYSTEM
+## 注意事项
+1. 在删除 FOLLOWER 节点之前,确保需要下线的节点不是 Master 节点。
+2. 在删除 FOLLOWER 节点之前,确保集群中 FOLLOWER 节点在下线之后数量为奇数个。
+3. 删除 FOLLOWER 节点后,使用[`SHOW FRONTENDS`](./SHOW-FRONTENDS.md)命令验证它们是否已成功删除。
+## 示例
+
+1. 删除一个 FOLLOWER 节点
+ ```sql
+ ALTER SYSTEM DROP FOLLOWER "host_ip:9010"
+ ```
+ 此命令是删除集群中的一个 FOLLOWER 节点( IP host_ip,端口 9010)
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/DROP-OBSERVER.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/DROP-OBSERVER.md
index 53fd878ffca..77b5cc8b242 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/DROP-OBSERVER.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/DROP-OBSERVER.md
@@ -24,36 +24,43 @@ specific language governing permissions and limitations
under the License.
-->
-
-
-
-
## 描述
该语句是删除 FRONTEND 的 OBSERVER 角色的节点,(仅管理员使用!)
-语法:
+## 语法
```sql
-ALTER SYSTEM DROP OBSERVER "follower_host:edit_log_port"
+ALTER SYSTEM DROP OBSERVER "<observer_host>:<edit_log_port>"
```
-说明:
+## 必选参数
-1. host 可以是主机名或者 ip 地址
-2. edit_log_port : edit_log_port 在其配置文件 fe.conf
+**1. `<observer_host>`**
-## 示例
+> 可以是 FE 节点的主机名或 IP 地址
-1. 添加一个 FOLLOWER 节点
+**2. `<edit_log_port>`**
- ```sql
- ALTER SYSTEM DROP OBSERVER "host_ip:9010"
- ```
+> FE 节点的 bdbje 通信端口,默认为 9010
-## 关键词
+## 权限控制
- ALTER, SYSTEM, DROP, OBSERVER, ALTER SYSTEM
+执行此 SQL 命令的用户必须至少具有以下权限:
-### 最佳实践
+| 权限 | 对象 | 说明 |
+|-----------|----|----|
+| NODE_PRIV | | |
+## 注意事项
+
+1. 删除 OBSERVER 节点后,使用[`SHOW FRONTENDS`](./SHOW-FRONTENDS.md)命令验证它们是否已成功删除。
+
+## 示例
+
+1. 删除一个 OBSERVER 节点
+
+ ```sql
+ ALTER SYSTEM DROP OBSERVER "host_ip:9010"
+ ```
+ 此命令是删除集群中的一个 OBSERVER 节点( IP host_ip,端口 9010)
diff --git
a/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/ADD-FOLLOWER.md
b/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/ADD-FOLLOWER.md
index afb1e3cf6be..944403616f8 100644
---
a/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/ADD-FOLLOWER.md
+++
b/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/ADD-FOLLOWER.md
@@ -24,36 +24,45 @@ specific language governing permissions and limitations
under the License.
-->
+## Description
+This statement adds a node with the FOLLOWER role to the FRONTEND node (only
used by administrators!)
+## Syntax
+```sql
+ALTER SYSTEM ADD FOLLOWER "<follower_host>:<edit_log_port>"
+```
-## Description
+## Required Parameters
-This statement is to increase the node of the FOLLOWER role of FRONTEND, (only
for administrators!)
+**1. `<follower_host>`**
-grammar:
+> Can be the hostname or IP address of the FE node
-```sql
-ALTER SYSTEM ADD FOLLOWER "follower_host:edit_log_port"
-```
+**2. `<edit_log_port>`**
-illustrate:
+> bdbje communication port of FE node, the default is 9010
-1. host can be a hostname or an ip address
-2. edit_log_port : edit_log_port in its configuration file fe.conf
+## Access Control Requirements
-## Examples
+The user executing this SQL command must have at least the following
permissions:
-1. Add a FOLLOWER node
+| Privilege | Object | Notes |
+|-----------|----|-------|
+| NODE_PRIV | | |
- ```sql
- ALTER SYSTEM ADD FOLLOWER "host_ip:9010"
- ```
+## Usage Notes
-## Keywords
+1. Before adding a new FOLLOWER node, make sure the node is properly
configured.
+2. Before adding a FOLLOWER node, ensure that the number of FOLLOWER nodes in
the cluster is an odd number after the addition.
+3. After adding the FOLLOWER node, use[`SHOW
FRONTENDS`](./SHOW-FRONTENDS.md)command to verify that they have been added
successfully and are in a normal state.
- ALTER, SYSTEM, ADD, FOLLOWER, ALTER SYSTEM
+## Examples
-## Best Practice
+1. Add a FOLLOWER node
+ ```sql
+ ALTER SYSTEM ADD FOLLOWER "host_ip:9010"
+ ```
+ This command adds a FOLLOWER node to the cluster (IP host_ip, port 9010)
diff --git
a/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/ADD-OBSERVER.md
b/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/ADD-OBSERVER.md
index d94f0d4d553..18cce583561 100644
---
a/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/ADD-OBSERVER.md
+++
b/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/ADD-OBSERVER.md
@@ -24,34 +24,43 @@ specific language governing permissions and limitations
under the License.
-->
-
-
## Description
-This statement is to increase the node of the OBSERVER role of FRONTEND, (only
for administrators!)
+This statement adds a node with the OBSERVER role to the FRONTEND node (only
used by administrators!)
-grammar:
+## Syntax
```sql
-ALTER SYSTEM ADD OBSERVER "follower_host:edit_log_port"
+ALTER SYSTEM ADD OBSERVER "<observer_host>:<edit_log_port>"
```
-illustrate:
+## Required Parameters
-1. host can be a hostname or an ip address
-2. edit_log_port : edit_log_port in its configuration file fe.conf
+**1. `<observer_host>`**
-## Examples
+> Can be the hostname or IP address of the FE node
+
+**2. `<edit_log_port>`**
-1. Add an OBSERVER node
+> bdbje communication port of FE node, the default is 9010
- ```sql
- ALTER SYSTEM ADD OBSERVER "host_ip:9010"
- ```
+## Access Control Requirements
-## Keywords
+The user executing this SQL command must have at least the following
permissions:
- ALTER, SYSTEM, ADD, OBSERVER, ALTER SYSTEM
+| Privilege | Object | Notes |
+|-----------|----|-------|
+| NODE_PRIV | | |
-## Best Practice
+## Usage Notes
+
+1. Before adding a new OBSERVER node, make sure the node is properly
configured.
+2. After adding the OBSERVER node, use[`SHOW
FRONTENDS`](./SHOW-FRONTENDS.md)command to verify that they have been added
successfully and are in a normal state.
+
+## Examples
+1. Add a OBSERVER node
+ ```sql
+ ALTER SYSTEM ADD OBSERVER "host_ip:9010"
+ ```
+ This command adds a OBSERVER node to the cluster (IP host_ip, port 9010)
diff --git
a/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/DROP-FOLLOWER.md
b/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/DROP-FOLLOWER.md
index a187e87f66f..23ecb464bfe 100644
---
a/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/DROP-FOLLOWER.md
+++
b/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/DROP-FOLLOWER.md
@@ -24,33 +24,45 @@ specific language governing permissions and limitations
under the License.
-->
-
## Description
-This statement is to delete the node of the FOLLOWER role of FRONTEND, (only
for administrators!)
+This statement deletes the node with the FOLLOWER role of FRONTEND. (For
administrators only!)
-Grammar:
+## Syntax
```sql
-ALTER SYSTEM DROP FOLLOWER "follower_host:edit_log_port"
+ALTER SYSTEM DROP FOLLOWER "<follower_host>:<edit_log_port>"
```
-Illustration:
+## Required Parameters
-1. host can be a hostname or an ip address
+**1. `<follower_host>`**
-2. edit_log_port : edit_log_port in its configuration file fe.conf
+> Can be the hostname or IP address of the FE node
-## Example
+**2. `<edit_log_port>`**
-1. Delete a FOLLOWER node
+> bdbje communication port of FE node, the default is 9010
+
+## Access Control Requirements
- ```sql
- ALTER SYSTEM DROP FOLLOWER "host_ip:9010"
- ```
+The user executing this SQL command must have at least the following
permissions:
-## Keywords
+| Privilege | Object | Notes |
+|-----------|----|-------|
+| NODE_PRIV | | |
-ALTER, SYSTEM, DROP, FOLLOWER, ALTER SYSTEM
+## Usage Notes
+1. Before deleting a FOLLOWER node, make sure that the node that needs to be
taken offline is not a Master node.
+2. Before deleting a FOLLOWER node, ensure that the number of FOLLOWER nodes
in the cluster is an odd number after they go offline.
+3. After deleting the FOLLOWER node[`SHOW
FRONTENDS`](./SHOW-FRONTENDS.md)command to verify that they were successfully
deleted.
+
+## Examples
+
+1. Delete a FOLLOWER node
+ ```sql
+ ALTER SYSTEM DROP FOLLOWER "host_ip:9010"
+ ```
+ This command deletes a FOLLOWER node in the cluster (IP host_ip, port 9010)
diff --git
a/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/DROP-OBSERVER.md
b/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/DROP-OBSERVER.md
index e2c25b2bc31..97bfcf061ef 100644
---
a/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/DROP-OBSERVER.md
+++
b/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/DROP-OBSERVER.md
@@ -24,35 +24,43 @@ specific language governing permissions and limitations
under the License.
-->
-
-
-
## Description
-This statement is to delete the node of the OBSERVER role of FRONTEND, (only
for administrators!)
+This statement deletes the node with the OBSERVER role of FRONTEND (only used
by administrators!)
-grammar:
+## Syntax
```sql
-ALTER SYSTEM DROP OBSERVER "follower_host:edit_log_port"
+ALTER SYSTEM DROP OBSERVER "<observer_host>:<edit_log_port>"
```
-illustrate:
+## Required Parameters
-1. host can be a hostname or an ip address
-2. edit_log_port : edit_log_port in its configuration file fe.conf
+**1. `<observer_host>`**
-## Examples
+> Can be the hostname or IP address of the FE node
+
+**2. `<edit_log_port>`**
-1. Add a FOLLOWER node
+> bdbje communication port of FE node, the default is 9010
- ```sql
- ALTER SYSTEM DROP OBSERVER "host_ip:9010"
- ```
+## Access Control Requirements
-## Keywords
+The user executing this SQL command must have at least the following
permissions:
- ALTER, SYSTEM, DROP, OBSERVER, ALTER SYSTEM
+| Privilege | Object | Notes |
+|-----------|----|-------|
+| NODE_PRIV | | |
+
+## Usage Notes
+
+1. After deleting the OBSERVER node, use[`SHOW
FRONTENDS`](./SHOW-FRONTENDS.md)command to verify that they were successfully
deleted.
+
+## Examples
-## Best Practice
+1. Deleting an OBSERVER node
+ ```sql
+ ALTER SYSTEM DROP OBSERVER "host_ip:9010"
+ ```
+ This command deletes an OBSERVER node in the cluster (IP host_ip, port 9010)
diff --git
a/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/ADD-FOLLOWER.md
b/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/ADD-FOLLOWER.md
index 2a010cdb922..944403616f8 100644
---
a/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/ADD-FOLLOWER.md
+++
b/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/ADD-FOLLOWER.md
@@ -24,36 +24,45 @@ specific language governing permissions and limitations
under the License.
-->
+## Description
+This statement adds a node with the FOLLOWER role to the FRONTEND node (only
used by administrators!)
+## Syntax
+```sql
+ALTER SYSTEM ADD FOLLOWER "<follower_host>:<edit_log_port>"
+```
-## Description
+## Required Parameters
-This statement is to increase the node of the FOLLOWER role of FRONTEND, (only
for administrators!)
+**1. `<follower_host>`**
-grammar:
+> Can be the hostname or IP address of the FE node
-```sql
-ALTER SYSTEM ADD FOLLOWER "follower_host:edit_log_port"
-```
+**2. `<edit_log_port>`**
-illustrate:
+> bdbje communication port of FE node, the default is 9010
-1. host can be a hostname or an ip address
-2. edit_log_port : edit_log_port in its configuration file fe.conf
+## Access Control Requirements
-## Example
+The user executing this SQL command must have at least the following
permissions:
-1. Add a FOLLOWER node
+| Privilege | Object | Notes |
+|-----------|----|-------|
+| NODE_PRIV | | |
- ```sql
- ALTER SYSTEM ADD FOLLOWER "host_ip:9010"
- ```
+## Usage Notes
-## Keywords
+1. Before adding a new FOLLOWER node, make sure the node is properly
configured.
+2. Before adding a FOLLOWER node, ensure that the number of FOLLOWER nodes in
the cluster is an odd number after the addition.
+3. After adding the FOLLOWER node, use[`SHOW
FRONTENDS`](./SHOW-FRONTENDS.md)command to verify that they have been added
successfully and are in a normal state.
- ALTER, SYSTEM, ADD, FOLLOWER, ALTER SYSTEM
+## Examples
-## Best Practice
+1. Add a FOLLOWER node
+ ```sql
+ ALTER SYSTEM ADD FOLLOWER "host_ip:9010"
+ ```
+ This command adds a FOLLOWER node to the cluster (IP host_ip, port 9010)
diff --git
a/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/ADD-OBSERVER.md
b/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/ADD-OBSERVER.md
index dac588cdcc2..18cce583561 100644
---
a/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/ADD-OBSERVER.md
+++
b/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/ADD-OBSERVER.md
@@ -24,36 +24,43 @@ specific language governing permissions and limitations
under the License.
-->
-
-
-
-
## Description
-This statement is to increase the node of the OBSERVER role of FRONTEND, (only
for administrators!)
+This statement adds a node with the OBSERVER role to the FRONTEND node (only
used by administrators!)
-grammar:
+## Syntax
```sql
-ALTER SYSTEM ADD OBSERVER "follower_host:edit_log_port"
+ALTER SYSTEM ADD OBSERVER "<observer_host>:<edit_log_port>"
```
-illustrate:
+## Required Parameters
+
+**1. `<observer_host>`**
+
+> Can be the hostname or IP address of the FE node
+
+**2. `<edit_log_port>`**
-1. host can be a hostname or an ip address
-2. edit_log_port : edit_log_port in its configuration file fe.conf
+> bdbje communication port of FE node, the default is 9010
-## Example
+## Access Control Requirements
-1. Add an OBSERVER node
+The user executing this SQL command must have at least the following
permissions:
- ```sql
- ALTER SYSTEM ADD OBSERVER "host_ip:9010"
- ```
+| Privilege | Object | Notes |
+|-----------|----|-------|
+| NODE_PRIV | | |
-## Keywords
+## Usage Notes
- ALTER, SYSTEM, ADD, OBSERVER, ALTER SYSTEM
+1. Before adding a new OBSERVER node, make sure the node is properly
configured.
+2. After adding the OBSERVER node, use[`SHOW
FRONTENDS`](./SHOW-FRONTENDS.md)command to verify that they have been added
successfully and are in a normal state.
-## Best Practice
+## Examples
+1. Add a OBSERVER node
+ ```sql
+ ALTER SYSTEM ADD OBSERVER "host_ip:9010"
+ ```
+ This command adds a OBSERVER node to the cluster (IP host_ip, port 9010)
diff --git
a/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/DROP-FOLLOWER.md
b/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/DROP-FOLLOWER.md
index 70a3a362cbe..23ecb464bfe 100644
---
a/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/DROP-FOLLOWER.md
+++
b/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/DROP-FOLLOWER.md
@@ -24,34 +24,45 @@ specific language governing permissions and limitations
under the License.
-->
-
-
## Description
-This statement is to delete the node of the FOLLOWER role of FRONTEND, (only
for administrators!)
+This statement deletes the node with the FOLLOWER role of FRONTEND. (For
administrators only!)
-Grammar:
+## Syntax
```sql
-ALTER SYSTEM DROP FOLLOWER "follower_host:edit_log_port"
+ALTER SYSTEM DROP FOLLOWER "<follower_host>:<edit_log_port>"
```
-Illustration:
+## Required Parameters
-1. host can be a hostname or an ip address
+**1. `<follower_host>`**
-2. edit_log_port : edit_log_port in its configuration file fe.conf
+> Can be the hostname or IP address of the FE node
-## Example
+**2. `<edit_log_port>`**
-1. Delete a FOLLOWER node
+> bdbje communication port of FE node, the default is 9010
+
+## Access Control Requirements
- ```sql
- ALTER SYSTEM DROP FOLLOWER "host_ip:9010"
- ```
+The user executing this SQL command must have at least the following
permissions:
-## Keywords
+| Privilege | Object | Notes |
+|-----------|----|-------|
+| NODE_PRIV | | |
-ALTER, SYSTEM, DROP, FOLLOWER, ALTER SYSTEM
+## Usage Notes
+1. Before deleting a FOLLOWER node, make sure that the node that needs to be
taken offline is not a Master node.
+2. Before deleting a FOLLOWER node, ensure that the number of FOLLOWER nodes
in the cluster is an odd number after they go offline.
+3. After deleting the FOLLOWER node[`SHOW
FRONTENDS`](./SHOW-FRONTENDS.md)command to verify that they were successfully
deleted.
+
+## Examples
+
+1. Delete a FOLLOWER node
+ ```sql
+ ALTER SYSTEM DROP FOLLOWER "host_ip:9010"
+ ```
+ This command deletes a FOLLOWER node in the cluster (IP host_ip, port 9010)
diff --git
a/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/DROP-OBSERVER.md
b/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/DROP-OBSERVER.md
index cc6f6c4c218..97bfcf061ef 100644
---
a/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/DROP-OBSERVER.md
+++
b/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/DROP-OBSERVER.md
@@ -24,36 +24,43 @@ specific language governing permissions and limitations
under the License.
-->
+## Description
+This statement deletes the node with the OBSERVER role of FRONTEND (only used
by administrators!)
+## Syntax
+```sql
+ALTER SYSTEM DROP OBSERVER "<observer_host>:<edit_log_port>"
+```
-## Description
+## Required Parameters
-This statement is to delete the node of the OBSERVER role of FRONTEND, (only
for administrators!)
+**1. `<observer_host>`**
-grammar:
+> Can be the hostname or IP address of the FE node
-```sql
-ALTER SYSTEM DROP OBSERVER "follower_host:edit_log_port"
-```
+**2. `<edit_log_port>`**
-illustrate:
+> bdbje communication port of FE node, the default is 9010
-1. host can be a hostname or an ip address
-2. edit_log_port : edit_log_port in its configuration file fe.conf
+## Access Control Requirements
-## Example
+The user executing this SQL command must have at least the following
permissions:
-1. Add a FOLLOWER node
+| Privilege | Object | Notes |
+|-----------|----|-------|
+| NODE_PRIV | | |
- ```sql
- ALTER SYSTEM DROP OBSERVER "host_ip:9010"
- ```
+## Usage Notes
-## Keywords
+1. After deleting the OBSERVER node, use[`SHOW
FRONTENDS`](./SHOW-FRONTENDS.md)command to verify that they were successfully
deleted.
- ALTER, SYSTEM, DROP, OBSERVER, ALTER SYSTEM
+## Examples
-## Best Practice
+1. Deleting an OBSERVER node
+ ```sql
+ ALTER SYSTEM DROP OBSERVER "host_ip:9010"
+ ```
+ This command deletes an OBSERVER node in the cluster (IP host_ip, port 9010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]