morrySnow commented on code in PR #1896:
URL: https://github.com/apache/doris-website/pull/1896#discussion_r1924796266
##########
docs/sql-manual/sql-statements/cluster-management/instance-management/ADD-BACKEND.md:
##########
@@ -26,47 +26,68 @@ under the License.
## Description
-The ADD BACKEND command is used to add one or more backend nodes to a Doris
OLAP database cluster. This command allows administrators to specify the host
and port of the new backend nodes, along with optional properties that
configure their behavior.
+The ADD BACKEND is used to add one or more BE nodes to the Doris cluster. This
command allows administrators to specify the host and port of the new BE nodes,
as well as optional properties to configure their behavior.
-grammar:
+## Syntax
```sql
--- Add nodes (add this method if you do not use the multi-tenancy function)
- ALTER SYSTEM ADD BACKEND "host:heartbeat_port"[,"host:heartbeat_port"...]
[PROPERTIES ("key"="value", ...)];
+ALTER SYSTEM ADD BACKEND
"<host>:<heartbeat_port>"[,"<host>:<heartbeat_port>"...] [PROPERTIES
("<key>"="<value>", ...)]
```
-### Parameters
+## Required Parameters
-* `host` can be a hostname or an ip address of the backend node while
`heartbeat_port` is the heartbeat port of the node
-* `PROPERTIES ("key"="value", ...)`: (Optional) A set of key-value pairs that
define additional properties for the backend nodes. These properties can be
used to customize the configuration of the backends being added. Available
properties include:
+**<host>**
- * tag.location: Specifies the resource group where the backend node belongs.
For example, PROPERTIES ("tag.location" = "groupb").
+> It can be the hostname or IP address of the BE node.
-## Example
+**<heartbeat_port>**
Review Comment:
1. 需要需要
2. 需要反引号包裹，防止尖括号被转义
```suggestion
**2. `<heartbeat_port>`**
```
##########
docs/sql-manual/sql-statements/cluster-management/instance-management/ADD-BACKEND.md:
##########
@@ -26,47 +26,68 @@ under the License.
## Description
-The ADD BACKEND command is used to add one or more backend nodes to a Doris
OLAP database cluster. This command allows administrators to specify the host
and port of the new backend nodes, along with optional properties that
configure their behavior.
+The ADD BACKEND is used to add one or more BE nodes to the Doris cluster. This
command allows administrators to specify the host and port of the new BE nodes,
as well as optional properties to configure their behavior.
-grammar:
+## Syntax
```sql
--- Add nodes (add this method if you do not use the multi-tenancy function)
- ALTER SYSTEM ADD BACKEND "host:heartbeat_port"[,"host:heartbeat_port"...]
[PROPERTIES ("key"="value", ...)];
+ALTER SYSTEM ADD BACKEND
"<host>:<heartbeat_port>"[,"<host>:<heartbeat_port>"...] [PROPERTIES
("<key>"="<value>", ...)]
Review Comment:
```suggestion
ALTER SYSTEM ADD BACKEND
"<host>:<heartbeat_port>"[,"<host>:<heartbeat_port>"...] [PROPERTIES
("<key>"="<value>" [ , ... ])]
```
##########
docs/sql-manual/sql-statements/cluster-management/instance-management/ADD-BACKEND.md:
##########
@@ -26,47 +26,68 @@ under the License.
## Description
-The ADD BACKEND command is used to add one or more backend nodes to a Doris
OLAP database cluster. This command allows administrators to specify the host
and port of the new backend nodes, along with optional properties that
configure their behavior.
+The ADD BACKEND is used to add one or more BE nodes to the Doris cluster. This
command allows administrators to specify the host and port of the new BE nodes,
as well as optional properties to configure their behavior.
-grammar:
+## Syntax
```sql
--- Add nodes (add this method if you do not use the multi-tenancy function)
- ALTER SYSTEM ADD BACKEND "host:heartbeat_port"[,"host:heartbeat_port"...]
[PROPERTIES ("key"="value", ...)];
+ALTER SYSTEM ADD BACKEND
"<host>:<heartbeat_port>"[,"<host>:<heartbeat_port>"...] [PROPERTIES
("<key>"="<value>", ...)]
```
-### Parameters
+## Required Parameters
-* `host` can be a hostname or an ip address of the backend node while
`heartbeat_port` is the heartbeat port of the node
-* `PROPERTIES ("key"="value", ...)`: (Optional) A set of key-value pairs that
define additional properties for the backend nodes. These properties can be
used to customize the configuration of the backends being added. Available
properties include:
+**<host>**
Review Comment:
```suggestion
**<host>**
```
```suggestion
**1. `<host>`**
```
##########
docs/sql-manual/sql-statements/cluster-management/instance-management/ADD-BACKEND.md:
##########
@@ -26,47 +26,68 @@ under the License.
## Description
-The ADD BACKEND command is used to add one or more backend nodes to a Doris
OLAP database cluster. This command allows administrators to specify the host
and port of the new backend nodes, along with optional properties that
configure their behavior.
+The ADD BACKEND is used to add one or more BE nodes to the Doris cluster. This
command allows administrators to specify the host and port of the new BE nodes,
as well as optional properties to configure their behavior.
-grammar:
+## Syntax
```sql
--- Add nodes (add this method if you do not use the multi-tenancy function)
- ALTER SYSTEM ADD BACKEND "host:heartbeat_port"[,"host:heartbeat_port"...]
[PROPERTIES ("key"="value", ...)];
+ALTER SYSTEM ADD BACKEND
"<host>:<heartbeat_port>"[,"<host>:<heartbeat_port>"...] [PROPERTIES
("<key>"="<value>", ...)]
```
-### Parameters
+## Required Parameters
-* `host` can be a hostname or an ip address of the backend node while
`heartbeat_port` is the heartbeat port of the node
-* `PROPERTIES ("key"="value", ...)`: (Optional) A set of key-value pairs that
define additional properties for the backend nodes. These properties can be
used to customize the configuration of the backends being added. Available
properties include:
+**<host>**
- * tag.location: Specifies the resource group where the backend node belongs.
For example, PROPERTIES ("tag.location" = "groupb").
+> It can be the hostname or IP address of the BE node.
-## Example
+**<heartbeat_port>**
- 1. Adding Backends Without Additional Properties
+> The heartbeat port of the BE node, the default is 9050.
- ```sql
- ALTER SYSTEM ADD BACKEND "host1:9020,host2:9020";
- ````
+## Optional Parameters
- This command adds two backend nodes to the cluster:
+**PROPERTIES ("key"="value", ...)**
Review Comment:
```suggestion
**1. `PROPERTIES ("<key>"="<value>" [, ... ] )`**
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org
For additional commands, e-mail: commits-h...@doris.apache.org
