This is an automated email from the ASF dual-hosted git repository.
morningman 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 6284103e14 [admin-set-config] modify admin-set-config doc (#805)
6284103e14 is described below
commit 6284103e14d5b366d22106644ff490dfc1f50ca1
Author: Mingyu Chen <morning...@163.com>
AuthorDate: Sat Jun 29 14:49:55 2024 +0800
[admin-set-config] modify admin-set-config doc (#805)
Co-authored-by: Luzhijing <82810928+luzhij...@users.noreply.github.com>
---
.../ADMIN-SET-CONFIG.md | 26 +++++++++++++---------
.../ADMIN-SET-CONFIG.md | 23 +++++++++++--------
.../ADMIN-SET-CONFIG.md | 22 ++++++++++--------
.../ADMIN-SET-CONFIG.md | 26 +++++++++++++---------
4 files changed, 57 insertions(+), 40 deletions(-)
diff --git
a/docs/sql-manual/sql-statements/Database-Administration-Statements/ADMIN-SET-CONFIG.md
b/docs/sql-manual/sql-statements/Database-Administration-Statements/ADMIN-SET-CONFIG.md
index f59828f40d..1683a87a11 100644
---
a/docs/sql-manual/sql-statements/Database-Administration-Statements/ADMIN-SET-CONFIG.md
+++
b/docs/sql-manual/sql-statements/Database-Administration-Statements/ADMIN-SET-CONFIG.md
@@ -32,29 +32,33 @@ ADMIN SET CONFIG
### Description
-This statement is used to set the configuration items of the cluster
(currently only the configuration items of FE are supported).
-The settable configuration items can be viewed through the SHOW FRONTEND
CONFIG; command.
+This statement is used to set the configuration items of the cluster
(currently only supports setting FE configuration items).
-grammar:
+The configurable items can be viewed using the `SHOW FRONTEND CONFIG;` command.
+
+Syntax:
```sql
- ADMIN SET FRONTEND CONFIG ("key" = "value") [ALL];
- ADMIN SET ALL FRONTENDS CONFIG ("key" = "value");
-````
+ADMIN SET FRONTEND CONFIG ("key" = "value") [ALL];
+-- or
+ADMIN SET ALL FRONTENDS CONFIG ("key" = "value");
+```
-illustrate:
+:::tip Explanation
-1. If `ALL` keyword is used, this config will be applied to all FE(except
master_only configuration)
+- Starting from versions 2.0.11 and 2.1.5, the `ALL` keyword is supported.
When using the `ALL` keyword, the configuration parameters will be applied to
all FEs (except for the `master_only` parameter).
+- This syntax does not persistently modify the configuration. After an FE
restarts, the modified configuration becomes invalid. To persist the changes,
the configuration items need to be synchronously added in fe.conf.
+:::
### Example
-1. Set 'disable_balance' to true
+1. Set `disable_balance` to true
- ADMIN SET FRONTEND CONFIG ("disable_balance" = "true");
+ `ADMIN SET FRONTEND CONFIG ("disable_balance" = "true");`
### Keywords
- ADMIN, SET, CONFIG
+ADMIN, SET, CONFIG
### Best Practice
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/Database-Administration-Statements/ADMIN-SET-CONFIG.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/Database-Administration-Statements/ADMIN-SET-CONFIG.md
index 0663934e77..29946e64de 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/Database-Administration-Statements/ADMIN-SET-CONFIG.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/Database-Administration-Statements/ADMIN-SET-CONFIG.md
@@ -32,28 +32,33 @@ ADMIN SET CONFIG
### Description
-该语句用于设置集群的配置项（当前仅支持设置FE的配置项）。
+该语句用于设置集群的配置项（当前仅支持设置 FE 的配置项）。
+
可设置的配置项，可以通过 `SHOW FRONTEND CONFIG;` 命令查看。
语法：
```sql
- ADMIN SET FRONTEND CONFIG ("key" = "value") [ALL];
- ADMIN SET ALL FRONTENDS CONFIG ("key" = "value");```
+ADMIN SET FRONTEND CONFIG ("key" = "value") [ALL];
+-- or
+ADMIN SET ALL FRONTENDS CONFIG ("key" = "value");
+```
-说明：
+:::tip 提示
- 1. 使用ALL关键字后配置参数将应用于所有FE(除 master_only 参数外)
-
+- 2.0.11 和 2.1.5 版本开始支持 `ALL` 关键词。使用 `ALL` 关键字后配置参数将应用于所有 FE(除 `master_only`
参数外)。
+- 该语法不会持久化修改的配置，FE 重启后，修改的配置失效。如需持久化，需要在 fe.conf 中同步添加配置项。
+-
+:::
+
### Example
-1. 设置 'disable_balance' 为 true
+1. 设置 `disable_balance` 为 true
- ADMIN SET FRONTEND CONFIG ("disable_balance" = "true");
+ `ADMIN SET FRONTEND CONFIG ("disable_balance" = "true");`
### Keywords
ADMIN, SET, CONFIG
### Best Practice
-
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/Database-Administration-Statements/ADMIN-SET-CONFIG.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/Database-Administration-Statements/ADMIN-SET-CONFIG.md
index 1b4feac596..6f849f70dd 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/Database-Administration-Statements/ADMIN-SET-CONFIG.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/Database-Administration-Statements/ADMIN-SET-CONFIG.md
@@ -32,29 +32,33 @@ ADMIN SET CONFIG
### Description
-该语句用于设置集群的配置项（当前仅支持设置FE的配置项）。
+该语句用于设置集群的配置项（当前仅支持设置 FE 的配置项）。
+
可设置的配置项，可以通过 `SHOW FRONTEND CONFIG;` 命令查看。
语法：
```sql
- ADMIN SET FRONTEND CONFIG ("key" = "value") [ALL];
- ADMIN SET ALL FRONTENDS CONFIG ("key" = "value");
+ADMIN SET FRONTEND CONFIG ("key" = "value") [ALL];
+-- or
+ADMIN SET ALL FRONTENDS CONFIG ("key" = "value");
```
-说明：
+:::tip 提示
- 1. 使用ALL关键字后配置参数将应用于所有FE(除 master_only 参数外)
-
+- 2.0.11 和 2.1.5 版本开始支持 `ALL` 关键词。使用 `ALL` 关键字后配置参数将应用于所有 FE(除 `master_only`
参数外)。
+- 该语法不会持久化修改的配置，FE 重启后，修改的配置失效。如需持久化，需要在 fe.conf 中同步添加配置项。
+
+:::
+
### Example
-1. 设置 'disable_balance' 为 true
+1. 设置 `disable_balance` 为 true
- ADMIN SET FRONTEND CONFIG ("disable_balance" = "true");
+ `ADMIN SET FRONTEND CONFIG ("disable_balance" = "true");`
### Keywords
ADMIN, SET, CONFIG
### Best Practice
-
diff --git
a/versioned_docs/version-2.1/sql-manual/sql-statements/Database-Administration-Statements/ADMIN-SET-CONFIG.md
b/versioned_docs/version-2.1/sql-manual/sql-statements/Database-Administration-Statements/ADMIN-SET-CONFIG.md
index f59828f40d..1683a87a11 100644
---
a/versioned_docs/version-2.1/sql-manual/sql-statements/Database-Administration-Statements/ADMIN-SET-CONFIG.md
+++
b/versioned_docs/version-2.1/sql-manual/sql-statements/Database-Administration-Statements/ADMIN-SET-CONFIG.md
@@ -32,29 +32,33 @@ ADMIN SET CONFIG
### Description
-This statement is used to set the configuration items of the cluster
(currently only the configuration items of FE are supported).
-The settable configuration items can be viewed through the SHOW FRONTEND
CONFIG; command.
+This statement is used to set the configuration items of the cluster
(currently only supports setting FE configuration items).
-grammar:
+The configurable items can be viewed using the `SHOW FRONTEND CONFIG;` command.
+
+Syntax:
```sql
- ADMIN SET FRONTEND CONFIG ("key" = "value") [ALL];
- ADMIN SET ALL FRONTENDS CONFIG ("key" = "value");
-````
+ADMIN SET FRONTEND CONFIG ("key" = "value") [ALL];
+-- or
+ADMIN SET ALL FRONTENDS CONFIG ("key" = "value");
+```
-illustrate:
+:::tip Explanation
-1. If `ALL` keyword is used, this config will be applied to all FE(except
master_only configuration)
+- Starting from versions 2.0.11 and 2.1.5, the `ALL` keyword is supported.
When using the `ALL` keyword, the configuration parameters will be applied to
all FEs (except for the `master_only` parameter).
+- This syntax does not persistently modify the configuration. After an FE
restarts, the modified configuration becomes invalid. To persist the changes,
the configuration items need to be synchronously added in fe.conf.
+:::
### Example
-1. Set 'disable_balance' to true
+1. Set `disable_balance` to true
- ADMIN SET FRONTEND CONFIG ("disable_balance" = "true");
+ `ADMIN SET FRONTEND CONFIG ("disable_balance" = "true");`
### Keywords
- ADMIN, SET, CONFIG
+ADMIN, SET, CONFIG
### Best Practice
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org
For additional commands, e-mail: commits-h...@doris.apache.org
