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 583f6902ff1 [Docs] Remove obsolete Workload Policy session-variable
references (#4067)
583f6902ff1 is described below
commit 583f6902ff18d44daeba9de5eaa6895f19dc9712
Author: feiniaofeiafei <[email protected]>
AuthorDate: Mon Aug 17 12:18:02 2026 +0800
[Docs] Remove obsolete Workload Policy session-variable references (#4067)
## Summary
- Remove the obsolete `username` condition and `set_session_variable`
action from the Workload Policy documentation.
- Remove the related session-variable example and FE/BE isolation note.
- Synchronize the changes across dev, 4.x, 3.x, and 2.1 documentation in
English, Chinese, and Japanese.
- Correct the current and 4.x Japanese `CREATE WORKLOAD POLICY` pages,
which incorrectly contained `CREATE WORKLOAD GROUP` content.
## Motivation
The existing documentation described Workload Policy behavior that is no
longer supported, which could mislead users. This PR aligns the
documentation with the currently supported `cancel_query` action and
keeps all maintained versions and languages consistent.
## Versions
- [x] dev
- [x] 4.x
- [x] 3.x
- [x] 2.1 or older (not covered by version/language sync gate)
## Languages
- [x] Chinese
- [x] English
- [x] Japanese candidate translation needed
## Docs Checklist
- [x] Checked by AI
- [ ] Test Cases Built — N/A, documentation-only changes
- [x] Updated required version and language counterparts, or explained
why not
- [x] If only one language changed, confirmed whether source/translation
counterparts need sync — N/A, all counterparts were updated
## Validation
- `git diff --check HEAD~2..HEAD`
- Website build was not run; changes are documentation-only.
---
.../workload-management/sql-blocking.md | 39 +----------
.../compute-management/CREATE-WORKLOAD-POLICY.md | 1 -
.../workload-management/sql-blocking.md | 39 +----------
.../compute-management/CREATE-WORKLOAD-POLICY.md | 3 +-
.../workload-management/sql-blocking.md | 34 +--------
.../compute-management/CREATE-WORKLOAD-POLICY.md | 3 +-
.../workload-management/sql-blocking.md | 39 +----------
.../compute-management/CREATE-WORKLOAD-POLICY.md | 3 +-
.../workload-management/sql-blocking.md | 34 +--------
.../compute-management/CREATE-WORKLOAD-POLICY.md | 79 +++++++++++++--------
.../workload-management/sql-blocking.md | 34 +--------
.../compute-management/CREATE-WORKLOAD-POLICY.md | 70 +++++++++++--------
.../workload-management/sql-blocking.md | 34 +--------
.../compute-management/CREATE-WORKLOAD-POLICY.md | 81 ++++++++++++++--------
.../workload-management/sql-blocking.md | 34 +--------
.../compute-management/CREATE-WORKLOAD-POLICY.md | 68 ++++++++++--------
.../workload-management/sql-blocking.md | 39 +----------
.../compute-management/CREATE-WORKLOAD-POLICY.md | 1 -
18 files changed, 209 insertions(+), 426 deletions(-)
diff --git a/docs/admin-manual/workload-management/sql-blocking.md
b/docs/admin-manual/workload-management/sql-blocking.md
index 95cc74a9630..47ebb41c0c2 100644
--- a/docs/admin-manual/workload-management/sql-blocking.md
+++ b/docs/admin-manual/workload-management/sql-blocking.md
@@ -221,7 +221,7 @@ Conditions specify when the policy is triggered. Multiple
conditions are separat
| Condition | Description |
|-----------|------|
-| `username` | The username carried by the query. It can trigger the FE-side
`set_session_variable` Action. Starting from Doris 4.1.3, it can also be
combined with BE-side runtime metrics such as `query_time`, `be_scan_rows`,
`be_scan_bytes`, and `query_be_memory_bytes` to trigger `cancel_query`. This
condition only supports the equality operator (`=`), and the username cannot be
empty |
+| `username` | The username carried by the query. Starting from Doris 4.1.3,
it can be combined with BE-side runtime metrics such as `query_time`,
`be_scan_rows`, `be_scan_bytes`, and `query_be_memory_bytes` to trigger
`cancel_query`. This condition only supports the equality operator (`=`), and
the username cannot be empty |
| `be_scan_rows` | The number of rows scanned by a SQL within a single BE
process. Cumulative value under concurrent execution |
| `be_scan_bytes` | The number of bytes scanned by a SQL within a single BE
process. Cumulative value under concurrent execution (unit: bytes) |
| `query_time` | The execution time of a SQL on a single BE process (unit:
milliseconds) |
@@ -229,12 +229,11 @@ Conditions specify when the policy is triggered. Multiple
conditions are separat
#### Actions
-Actions specify what to do when the conditions are triggered. Currently, a
Policy can define only one Action (except for `set_session_variable`).
+Actions specify what to do when the conditions are triggered. Currently, a
Policy can define only one Action.
| Action | Description |
|--------|------|
| `cancel_query` | Cancel the query |
-| `set_session_variable` | Execute a set session variable statement. The same
Policy can include multiple of these options. Currently, this is only triggered
on the FE by the `username` Condition |
#### Policy Properties
@@ -302,36 +301,7 @@ MySQL [hits]> SELECT REGEXP_REPLACE(Referer,
'^https?://(?:www\\.)?([^/]+)/.*$',
ERROR 1105 (HY000): errCode = 2, detailMessage = (127.0.0.1)[CANCELLED]query
cancelled by workload policy,id:12345
```
-#### Example 2: Automatically Adjust User Session Variables
-
-Workload Policy can automatically modify session variables for a specific
user, for example, lowering concurrency to reduce resource consumption:
-
-```sql
--- Check the current concurrency parameter for the admin user
-MySQL [(none)]> show variables like '%parallel_fragment_exec_instance_num%';
-+-------------------------------------+-------+---------------+---------+
-| Variable_name | Value | Default_Value | Changed |
-+-------------------------------------+-------+---------------+---------+
-| parallel_fragment_exec_instance_num | 8 | 8 | 0 |
-+-------------------------------------+-------+---------------+---------+
-1 row in set (0.00 sec)
-
--- Create a policy: set the concurrency parameter for the admin user to 1
-CREATE WORKLOAD POLICY test_set_var_policy
-CONDITIONS(username='admin')
-ACTIONS(set_session_variable 'parallel_fragment_exec_instance_num=1');
-
--- Check again later, the parameter has taken effect
-MySQL [(none)]> show variables like '%parallel_fragment_exec_instance_num%';
-+-------------------------------------+-------+---------------+---------+
-| Variable_name | Value | Default_Value | Changed |
-+-------------------------------------+-------+---------------+---------+
-| parallel_fragment_exec_instance_num | 1 | 8 | 1 |
-+-------------------------------------+-------+---------------+---------+
-1 row in set (0.01 sec)
-```
-
-#### Example 3: Break Runtime Large Queries for a Specific User
+#### Example 2: Break Runtime Large Queries for a Specific User
Starting from Doris 4.1.3, you can combine `username` with BE-side runtime
metrics to cancel only the queries of a specific user. The following policy
cancels queries submitted by `test_user` when their running time on a single BE
exceeds 3000 ms:
@@ -344,9 +314,6 @@ ACTIONS(cancel_query);
Similarly, `username` can be combined with `be_scan_rows`, `be_scan_bytes`, or
`query_be_memory_bytes` to limit the scan volume or BE memory usage of a
specific user.
### Notes
-
-- **FE/BE side isolation**: The Condition and Action of the same Policy must
belong to the same side (FE or BE). `set_session_variable` is an FE-side Action
and cannot be combined with BE-side metrics such as `query_time` or
`be_scan_rows`. `cancel_query` is a BE-side Action and can be combined with
BE-side runtime metrics.
-- **`username` condition limit**: `username` is a shared condition. It can be
used with FE-side `set_session_variable`; starting from Doris 4.1.3, it can
also be used with BE-side runtime metrics to trigger `cancel_query`. The
`username` condition only supports equality (`=`); comparison operators such as
`>`, `>=`, `<`, and `<=` are not supported. If the BE cannot obtain explicit
user information for a query, the `username` condition does not match.
- **Asynchronous execution latency**: Policies are checked by an asynchronous
thread every 500 ms, so policy enforcement has some lag. Queries that run for a
very short time may complete before the check is triggered and bypass the
policy.
- **Priority mechanism**: A query may match multiple Policies, but only the
one with the highest priority (largest `priority` value) takes effect.
- **Modification limit**: Currently, directly modifying the Action and
Condition of an existing Policy is not supported. Delete the Policy and
recreate it.
diff --git
a/docs/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
b/docs/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
index d32978c4d14..13434b21efc 100644
---
a/docs/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
+++
b/docs/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
@@ -29,7 +29,6 @@ CONDITIONS(<conditions>) ACTIONS(<actions>)
- query_be_memory_bytes: Supported since version 2.1.5. The memory usage
of a SQL within a single BE process. If the SQL is executed with multiple
concurrencies on the BE, this is the cumulative value of the concurrent
executions, in bytes.
3. `<actions>`
- - set_session_variable: This action executes a `set_session_variable`
statement. A single Policy may contain multiple `set_session_variable` actions,
allowing one Policy to execute multiple session-variable updates.
- cancel_query: Cancel the query.
## Optional Parameters
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/workload-management/sql-blocking.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/workload-management/sql-blocking.md
index 0587b236b15..87c53ba2d69 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/workload-management/sql-blocking.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/workload-management/sql-blocking.md
@@ -221,7 +221,7 @@ Conditions 表示策略的触发条件，多个条件之间以逗号 `,` 分隔
| Condition | 说明 |
|-----------|------|
-| `username` | 查询携带的用户名。可用于 FE 侧触发 `set_session_variable` Action；自 Doris 4.1.3
版本起，也可与 `query_time`、`be_scan_rows`、`be_scan_bytes`、`query_be_memory_bytes` 等
BE 侧运行时指标组合，用于触发 `cancel_query`。该条件仅支持等值比较（`=`），用户名不能为空 |
+| `username` | 查询携带的用户名，自 Doris 4.1.3 版本起，可与
`query_time`、`be_scan_rows`、`be_scan_bytes`、`query_be_memory_bytes` 等 BE
侧运行时指标组合，用于触发 `cancel_query`。该条件仅支持等值比较（`=`），用户名不能为空 |
| `be_scan_rows` | 一个 SQL 在单个 BE 进程内扫描的行数，多并发执行时为累加值 |
| `be_scan_bytes` | 一个 SQL 在单个 BE 进程内扫描的字节数，多并发执行时为累加值（单位：字节） |
| `query_time` | 一个 SQL 在单个 BE 进程上的运行时间（单位：毫秒） |
@@ -229,12 +229,11 @@ Conditions 表示策略的触发条件，多个条件之间以逗号 `,` 分隔
#### 执行动作（Actions）
-Actions 表示条件触发时采取的动作。目前一个 Policy 只能定义一个 Action（`set_session_variable` 除外）。
+Actions 表示条件触发时采取的动作。目前一个 Policy 只能定义一个 Action。
| Action | 说明 |
|--------|------|
| `cancel_query` | 取消查询 |
-| `set_session_variable` | 执行 set session variable 语句；同一个 Policy
可包含多个该选项，目前只会在 FE 由 `username` Condition 触发 |
#### 策略属性（Properties）
@@ -302,36 +301,7 @@ MySQL [hits]> SELECT REGEXP_REPLACE(Referer,
'^https?://(?:www\\.)?([^/]+)/.*$',
ERROR 1105 (HY000): errCode = 2, detailMessage = (127.0.0.1)[CANCELLED]query
cancelled by workload policy,id:12345
```
-#### 示例二：自动调整用户 Session 变量
-
-通过 Workload Policy 可自动修改特定用户的 session 变量，例如降低其并发度以减少资源占用：
-
-```sql
--- 查看 admin 用户当前并发参数
-MySQL [(none)]> show variables like '%parallel_fragment_exec_instance_num%';
-+-------------------------------------+-------+---------------+---------+
-| Variable_name | Value | Default_Value | Changed |
-+-------------------------------------+-------+---------------+---------+
-| parallel_fragment_exec_instance_num | 8 | 8 | 0 |
-+-------------------------------------+-------+---------------+---------+
-1 row in set (0.00 sec)
-
--- 创建策略：将 admin 用户的并发参数调整为 1
-CREATE WORKLOAD POLICY test_set_var_policy
-CONDITIONS(username='admin')
-ACTIONS(set_session_variable 'parallel_fragment_exec_instance_num=1');
-
--- 稍后再次查看，参数已生效
-MySQL [(none)]> show variables like '%parallel_fragment_exec_instance_num%';
-+-------------------------------------+-------+---------------+---------+
-| Variable_name | Value | Default_Value | Changed |
-+-------------------------------------+-------+---------------+---------+
-| parallel_fragment_exec_instance_num | 1 | 8 | 1 |
-+-------------------------------------+-------+---------------+---------+
-1 row in set (0.01 sec)
-```
-
-#### 示例三：按用户熔断运行时大查询
+#### 示例二：按用户熔断运行时大查询
自 Doris 4.1.3 版本起，可以将 `username` 与 BE 侧运行时指标组合，仅取消特定用户的查询。以下策略会在 `test_user`
提交的查询在单个 BE 上运行超过 3000 ms 时取消该查询：
@@ -344,9 +314,6 @@ ACTIONS(cancel_query);
同理，也可以将 `username` 与 `be_scan_rows`、`be_scan_bytes` 或 `query_be_memory_bytes`
组合，用于限制特定用户的扫描量或 BE 内存使用量。
### 注意事项
-
-- **FE/BE 侧隔离**：同一个 Policy 的 Condition 和 Action 必须属于同一侧（FE 或
BE）。`set_session_variable` 是 FE 侧 Action，不能与 `query_time`、`be_scan_rows` 等 BE
侧指标组合；`cancel_query` 是 BE 侧 Action，可与 BE 侧运行时指标组合。
-- **`username` 条件限制**：`username` 是共享条件，可用于 FE 侧 `set_session_variable`；自 Doris
4.1.3 版本起，也可与 BE 侧运行时指标组合触发 `cancel_query`。`username` 条件仅支持等值比较（`=`），不支持
`>`、`>=`、`<`、`<=` 等比较操作符。如果 BE 无法获取查询明确携带的用户信息，则 `username` 条件不会匹配。
- **异步执行延迟**：Policy 由异步线程每 500 ms
执行一次检查，策略生效存在一定滞后。运行时间极短的查询可能会在检查触发前已完成，从而绕过策略。
- **优先级机制**：一个查询可能匹配多个 Policy，但只有优先级最高（`priority` 值最大）的 Policy 会生效。
- **修改限制**：目前不支持直接修改已有 Policy 的 Action 和 Condition，需删除后重新创建。
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
index 71647b128f0..2ff6f955da2 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
@@ -29,7 +29,6 @@ CONDITIONS(<conditions>) ACTIONS(<actions>)
- query_be_memory_bytes，从 2.1.5 版本开始支持。一个 SQL 在单个 BE 进程内使用的内存用量，如果这个 SQL 在
BE 上是多并发执行，那么就是多个并发的累加值，单位是字节。
3. `<actions>`
- - set_session_variable，这个 Action 可以执行一条 `set_session_variable` 的语句。同一个
Policy 可以有多个 `set_session_variable`，也就是说一个 Policy 可以执行多个修改 session 变量的语句。
- cancel_query，取消查询。
## 可选参数
@@ -70,4 +69,4 @@ CONDITIONS(<conditions>) ACTIONS(<actions>)
```Java
create workload policy kill_big_query conditions(query_time > 3000)
actions(cancel_query) properties('workload_group'='compute_group_a.wg1')
- ```
\ No newline at end of file
+ ```
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.x/admin-manual/workload-management/sql-blocking.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.x/admin-manual/workload-management/sql-blocking.md
index 129ed29488a..413587104f1 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.x/admin-manual/workload-management/sql-blocking.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.x/admin-manual/workload-management/sql-blocking.md
@@ -189,7 +189,6 @@ Conditions 表示策略的触发条件，多个 Condition 之间以逗号 `,`
| Condition | 说明
|
|-----------------------|-----------------------------------------------------------------------------------------------|
-| username | 查询携带的用户名，只会在 FE 触发 set_session_variable Action
|
| be_scan_rows | 一个 SQL 在单个 BE 进程内 scan 的行数，多并发执行时为累加值
|
| be_scan_bytes | 一个 SQL 在单个 BE 进程内 scan 的字节数，多并发执行时为累加值，单位是字节
|
| query_time | 一个 SQL 在单个 BE 进程上的运行时间，单位是毫秒
|
@@ -197,12 +196,11 @@ Conditions 表示策略的触发条件，多个 Condition 之间以逗号 `,`
#### 执行动作（Actions）
-Actions 表示条件触发时采取的动作，目前一个 Policy 只能定义一个 Action（set_session_variable 除外）。
+Actions 表示条件触发时采取的动作，目前一个 Policy 只能定义一个 Action。
| Action | 说明
|
|----------------------|------------------------------------------------------------------------------------------------------------|
| cancel_query | 取消查询
|
-| set_session_variable | 触发 set session variable 语句。同一个 Policy 可以有多个
set_session_variable 选项，目前只会在 FE 由 username Condition 触发 |
#### 策略属性（Properties）
@@ -264,38 +262,8 @@ MySQL [hits]> SELECT REGEXP_REPLACE(Referer,
'^https?://(?:www\\.)?([^/]+)/.*$',
ERROR 1105 (HY000): errCode = 2, detailMessage = (127.0.0.1)[CANCELLED]query
cancelled by workload policy,id:12345
```
-#### 示例二：修改用户 session 变量
-
-通过 Workload Policy 可以自动修改特定用户的 session 变量，例如调整并发参数：
-
-```sql
--- 登录 admin 账户查看并发参数
-MySQL [(none)]> show variables like '%parallel_fragment_exec_instance_num%';
-+-------------------------------------+-------+---------------+---------+
-| Variable_name | Value | Default_Value | Changed |
-+-------------------------------------+-------+---------------+---------+
-| parallel_fragment_exec_instance_num | 8 | 8 | 0 |
-+-------------------------------------+-------+---------------+---------+
-1 row in set (0.00 sec)
-
--- 创建修改 admin 账户并发参数的 Policy
-CREATE WORKLOAD POLICY test_set_var_policy
-CONDITIONS(username='admin')
-ACTIONS(set_session_variable 'parallel_fragment_exec_instance_num=1')
-
--- 过段时间后再次查看 admin 账户的参数
-MySQL [(none)]> show variables like '%parallel_fragment_exec_instance_num%';
-+-------------------------------------+-------+---------------+---------+
-| Variable_name | Value | Default_Value | Changed |
-+-------------------------------------+-------+---------------+---------+
-| parallel_fragment_exec_instance_num | 1 | 8 | 1 |
-+-------------------------------------+-------+---------------+---------+
-1 row in set (0.01 sec)
-```
-
### 注意事项
-- 同一个 Policy 的 Condition 和 Action 必须属于同一侧（FE 或 BE）。例如，set_session_variable 和
cancel_query 无法配置到同一个 Policy 中；Condition be_scan_rows 和 Condition username
也无法配置到同一个 Policy 中。
- Policy 由异步线程以固定时间间隔（当前为 500 ms）执行，因此策略生效存在一定滞后性。运行时间过短的查询可能会绕过策略检查。
- 一个查询可能匹配到多个 Policy，但只有优先级最高的 Policy 会生效。
- 目前不支持直接修改 Action 和 Condition，只能通过删除后重新创建的方式修改。
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.x/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.x/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
index c6cef5e5e81..de197a06762 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.x/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.x/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
@@ -29,7 +29,6 @@ CONDITIONS(<conditions>) ACTIONS(<actions>)
- query_be_memory_bytes，从 2.1.5 版本开始支持。一个 SQL 在单个 BE 进程内使用的内存用量，如果这个 SQL 在
BE 上是多并发执行，那么就是多个并发的累加值，单位是字节。
3. `<actions>`
- - set_session_variable，这个 Action 可以执行一条 `set_session_variable` 的语句。同一个
Policy 可以有多个 `set_session_variable`，也就是说一个 Policy 可以执行多个修改 session 变量的语句。
- cancel_query，取消查询。
## 可选参数
@@ -55,4 +54,4 @@ CONDITIONS(<conditions>) ACTIONS(<actions>)
```Java
create workload policy kill_big_query conditions(query_time > 3000)
actions(cancel_query) properties('enabled'='false')
- ```
\ No newline at end of file
+ ```
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/admin-manual/workload-management/sql-blocking.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/admin-manual/workload-management/sql-blocking.md
index 9f64d42f702..15ee9f3b23f 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/admin-manual/workload-management/sql-blocking.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/admin-manual/workload-management/sql-blocking.md
@@ -238,7 +238,7 @@ Conditions 表示策略的触发条件，多个条件之间以逗号 `,` 分隔
| Condition | 说明 |
|-----------|------|
-| `username` | 查询携带的用户名。可用于 FE 侧触发 `set_session_variable` Action；自 Doris 4.1.3
版本起，也可与 `query_time`、`be_scan_rows`、`be_scan_bytes`、`query_be_memory_bytes` 等
BE 侧运行时指标组合，用于触发 `cancel_query`。该条件仅支持等值比较（`=`），用户名不能为空 |
+| `username` | 查询携带的用户名，自 Doris 4.1.3 版本起，可与
`query_time`、`be_scan_rows`、`be_scan_bytes`、`query_be_memory_bytes` 等 BE
侧运行时指标组合，用于触发 `cancel_query`。该条件仅支持等值比较（`=`），用户名不能为空 |
| `be_scan_rows` | 一个 SQL 在单个 BE 进程内扫描的行数，多并发执行时为累加值 |
| `be_scan_bytes` | 一个 SQL 在单个 BE 进程内扫描的字节数，多并发执行时为累加值（单位：字节） |
| `query_time` | 一个 SQL 在单个 BE 进程上的运行时间（单位：毫秒） |
@@ -246,12 +246,11 @@ Conditions 表示策略的触发条件，多个条件之间以逗号 `,` 分隔
#### 执行动作（Actions）
-Actions 表示条件触发时采取的动作。目前一个 Policy 只能定义一个 Action（`set_session_variable` 除外）。
+Actions 表示条件触发时采取的动作。目前一个 Policy 只能定义一个 Action。
| Action | 说明 |
|--------|------|
| `cancel_query` | 取消查询 |
-| `set_session_variable` | 执行 set session variable 语句；同一个 Policy
可包含多个该选项，目前只会在 FE 由 `username` Condition 触发 |
#### 策略属性（Properties）
@@ -319,36 +318,7 @@ MySQL [hits]> SELECT REGEXP_REPLACE(Referer,
'^https?://(?:www\\.)?([^/]+)/.*$',
ERROR 1105 (HY000): errCode = 2, detailMessage = (127.0.0.1)[CANCELLED]query
cancelled by workload policy,id:12345
```
-#### 示例二：自动调整用户 Session 变量
-
-通过 Workload Policy 可自动修改特定用户的 session 变量，例如降低其并发度以减少资源占用：
-
-```sql
--- 查看 admin 用户当前并发参数
-MySQL [(none)]> show variables like '%parallel_fragment_exec_instance_num%';
-+-------------------------------------+-------+---------------+---------+
-| Variable_name | Value | Default_Value | Changed |
-+-------------------------------------+-------+---------------+---------+
-| parallel_fragment_exec_instance_num | 8 | 8 | 0 |
-+-------------------------------------+-------+---------------+---------+
-1 row in set (0.00 sec)
-
--- 创建策略：将 admin 用户的并发参数调整为 1
-CREATE WORKLOAD POLICY test_set_var_policy
-CONDITIONS(username='admin')
-ACTIONS(set_session_variable 'parallel_fragment_exec_instance_num=1');
-
--- 稍后再次查看，参数已生效
-MySQL [(none)]> show variables like '%parallel_fragment_exec_instance_num%';
-+-------------------------------------+-------+---------------+---------+
-| Variable_name | Value | Default_Value | Changed |
-+-------------------------------------+-------+---------------+---------+
-| parallel_fragment_exec_instance_num | 1 | 8 | 1 |
-+-------------------------------------+-------+---------------+---------+
-1 row in set (0.01 sec)
-```
-
-#### 示例三：按用户熔断运行时大查询
+#### 示例二：按用户熔断运行时大查询
自 Doris 4.1.3 版本起，可以将 `username` 与 BE 侧运行时指标组合，仅取消特定用户的查询。以下策略会在 `test_user`
提交的查询在单个 BE 上运行超过 3000 ms 时取消该查询：
@@ -361,9 +331,6 @@ ACTIONS(cancel_query);
同理，也可以将 `username` 与 `be_scan_rows`、`be_scan_bytes` 或 `query_be_memory_bytes`
组合，用于限制特定用户的扫描量或 BE 内存使用量。
### 注意事项
-
-- **FE/BE 侧隔离**：同一个 Policy 的 Condition 和 Action 必须属于同一侧（FE 或
BE）。`set_session_variable` 是 FE 侧 Action，不能与 `query_time`、`be_scan_rows` 等 BE
侧指标组合；`cancel_query` 是 BE 侧 Action，可与 BE 侧运行时指标组合。
-- **`username` 条件限制**：`username` 是共享条件，可用于 FE 侧 `set_session_variable`；自 Doris
4.1.3 版本起，也可与 BE 侧运行时指标组合触发 `cancel_query`。`username` 条件仅支持等值比较（`=`），不支持
`>`、`>=`、`<`、`<=` 等比较操作符。如果 BE 无法获取查询明确携带的用户信息，则 `username` 条件不会匹配。
- **异步执行延迟**：Policy 由异步线程每 500 ms
执行一次检查，策略生效存在一定滞后。运行时间极短的查询可能会在检查触发前已完成，从而绕过策略。
- **优先级机制**：一个查询可能匹配多个 Policy，但只有优先级最高（`priority` 值最大）的 Policy 会生效。
- **修改限制**：目前不支持直接修改已有 Policy 的 Action 和 Condition，需删除后重新创建。
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
index 71647b128f0..2ff6f955da2 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-4.x/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
@@ -29,7 +29,6 @@ CONDITIONS(<conditions>) ACTIONS(<actions>)
- query_be_memory_bytes，从 2.1.5 版本开始支持。一个 SQL 在单个 BE 进程内使用的内存用量，如果这个 SQL 在
BE 上是多并发执行，那么就是多个并发的累加值，单位是字节。
3. `<actions>`
- - set_session_variable，这个 Action 可以执行一条 `set_session_variable` 的语句。同一个
Policy 可以有多个 `set_session_variable`，也就是说一个 Policy 可以执行多个修改 session 变量的语句。
- cancel_query，取消查询。
## 可选参数
@@ -70,4 +69,4 @@ CONDITIONS(<conditions>) ACTIONS(<actions>)
```Java
create workload policy kill_big_query conditions(query_time > 3000)
actions(cancel_query) properties('workload_group'='compute_group_a.wg1')
- ```
\ No newline at end of file
+ ```
diff --git
a/ja-source/docusaurus-plugin-content-docs/current/admin-manual/workload-management/sql-blocking.md
b/ja-source/docusaurus-plugin-content-docs/current/admin-manual/workload-management/sql-blocking.md
index e2257f385a9..434f3774d4c 100644
---
a/ja-source/docusaurus-plugin-content-docs/current/admin-manual/workload-management/sql-blocking.md
+++
b/ja-source/docusaurus-plugin-content-docs/current/admin-manual/workload-management/sql-blocking.md
@@ -225,18 +225,16 @@ Workload Policyを作成する際は、以下を指定する必要がありま
| Conditions | 説明
|
|-----------------------|-------------------------------------------------------------------------------------------------------------|
-| username | クエリによって運ばれるユーザー名。FEでの`set_session_variable`
Actionのみをトリガーします。 |
| be_scan_rows |
単一のBEプロセスでSQLがスキャンした行数。SQLがBE上で並行実行される場合、複数の並行実行の累積値です。 |
| be_scan_bytes |
単一のBEプロセスでSQLがスキャンしたバイト数。SQLがBE上で並行実行される場合、複数の並行実行の累積値で、バイト単位です。 |
| query_time | 単一のBEプロセスでのSQLの実行時間。ミリ秒単位です。
|
| query_be_memory_bytes |
単一のBEプロセスでのSQLのメモリ使用量。SQLがBE上で並行実行される場合、複数の並行実行の累積値で、バイト単位です。 |
--
**Action**は条件がトリガーされたときに実行されるアクションを表します。現在、Policyは1つのActionのみを定義できます（`set_session_variable`を除く）。上記の例では、`cancel_query`はクエリをキャンセルすることを示します。現在サポートされているActionは以下の通りです：
+-
**Action**は条件がトリガーされたときに実行されるアクションを表します。現在、Policyは1つのActionのみを定義できます。上記の例では、`cancel_query`はクエリをキャンセルすることを示します。現在サポートされているActionは以下の通りです：
| Actions | 説明
|
|------------------------|------------------------------------------------------------------------------------------------------------------|
| cancel_query | クエリをキャンセルします。
|
-| set_session_variable | `set session
variable`ステートメントをトリガーします。単一のポリシーは複数の`set_session_variable`オプションを持つことができ、現在は`username`
ConditionによってFEでのみトリガーされます。 |
- **Properties**は現在のPolicyの属性を定義し、有効かどうかとその優先度を含みます。
@@ -257,7 +255,6 @@ Actions(cancel_query)
properties('workload_group'='normal')
```
### 重要な注意事項
--
同一のPolicyのConditionsとActionsは、両方ともFEまたは両方ともBEのいずれかである必要があります。例えば、`set_session_variable`と`cancel_query`は同一のPolicy内で設定することはできません。Conditions
`be_scan_rows`と`username`は同一のPolicy内で設定することはできません。
-
現在、Policyは固定時間間隔で非同期スレッドによって実行されるため、ポリシー実行に一定の遅延が生じます。例えば、ユーザーがスキャンされた行数が1,000,000を超えた時にクエリをキャンセルするポリシーを設定し、その時点でクラスターリソースが比較的アイドル状態の場合、キャンセルポリシーが有効になる前にクエリが完了する可能性があります。現在の間隔は500msであり、この間隔より短い実行時間のクエリはポリシーチェックをバイパスする可能性があります。
- 現在サポートされているロードタイプには、select/insert、select/stream load、broker load、およびroutine
loadが含まれます。
- 単一のクエリは複数のPolicyにマッチする可能性がありますが、最も高い優先度を持つPolicyのみが有効になります。
@@ -265,34 +262,7 @@ properties('workload_group'='normal')
### Workload Policy デモンストレーション
-#### 1. セッション変数変更テスト
-Adminアカウントのセッション変数で同時実行関連パラメータの変更を試行します。
-
-```sql
--- log on admin to check variables
-show variables like '%parallel_fragment_exec_instance_num%';
-+-------------------------------------+-------+---------------+---------+
-| Variable_name | Value | Default_Value | Changed |
-+-------------------------------------+-------+---------------+---------+
-| parallel_fragment_exec_instance_num | 8 | 8 | 0 |
-+-------------------------------------+-------+---------------+---------+
-1 row in set (0.00 sec)
-
--- Create a Policy to modify the concurrency parameters of the admin account.
-create workload Policy test_set_var_Policy
-Conditions(username='admin')
-Actions(set_session_variable 'parallel_fragment_exec_instance_num=1')
-
--- After some time, check the admin account's parameters again.
-show variables like '%parallel_fragment_exec_instance_num%';
-+-------------------------------------+-------+---------------+---------+
-| Variable_name | Value | Default_Value | Changed |
-+-------------------------------------+-------+---------------+---------+
-| parallel_fragment_exec_instance_num | 1 | 8 | 1 |
-+-------------------------------------+-------+---------------+---------+
-1 row in set (0.01 sec)
-```
-#### 2. Big Query Circuit Breaker Test
+#### Big Query Circuit Breaker Test
3秒を超えて実行されるクエリをサーキットブレークするテスト。以下は、ckbenchのq29の正常実行の監査ログで、このSQLが完了するまでに4.5秒かかったことを示している。
```sql
diff --git
a/ja-source/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
b/ja-source/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
index 856c71ecedd..1debeda897f 100644
---
a/ja-source/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
+++
b/ja-source/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
@@ -1,47 +1,72 @@
---
{
- "title": "CREATE WORKLOAD GROUP | コンピュート管理",
- "language": "ja",
- "description": "この文は workload group を作成するために使用されます。Workload group により、単一の be
上で cpu リソースと memory リソースの分離が可能になります。",
- "sidebar_label": "CREATE WORKLOAD GROUP"
+ "title": "CREATE WORKLOAD POLICY",
+ "language": "ja",
+ "description": "Workload
Policyを作成します。クエリが特定の条件を満たした場合に、対応するアクションを実行するために使用します。"
}
---
-# CREATE WORKLOAD GROUP
## 説明
-このステートメントはworkload groupを作成するために使用されます。Workload
groupは単一のbe上でcpuリソースとメモリリソースの分離を可能にします。
+Workload Policyを作成します。クエリが特定の条件を満たした場合に、対応するアクションを実行するために使用します。
-文法:
+## 構文
```sql
-CREATE WORKLOAD GROUP [IF NOT EXISTS] "rg_name"
-PROPERTIES (
- property_list
-);
+CREATE WORKLOAD POLICY [ IF NOT EXISTS ] <workload_policy_name>
+CONDITIONS(<conditions>) ACTIONS(<actions>)
+[ PROPERTIES (<properties>) ]
```
-説明:
-property_listでサポートされるプロパティ:
+## 必須パラメータ
-* cpu_share:
必須、ワークロードグループが取得できるcpu時間の量を設定するために使用され、cpuリソースのソフト分離を実現できます。cpu_shareは、実行中のワークロードグループが利用可能なcpuリソースの重みを示す相対値です。例えば、ユーザーがcpu_shareをそれぞれ10、30、40に設定したワークロードグループrg-a、rg-b、rg-cの3つを作成し、ある瞬間にrg-aとrg-bがタスクを実行していてrg-cにはタスクがない場合、rg-aは
(10 / (10 + 30)) =
25%のcpuリソースを取得でき、ワークロードグループrg-bは75%のcpuリソースを取得できます。システムで実行中のワークロードグループが1つだけの場合、そのcpu_shareの値に関係なく、すべてのcpuリソースを取得します。
+1. `<workload_policy_name>`：Workload Policyの名前です。
-* memory_limit: 必須、ワークロードグループが使用できるbeメモリの割合を設定します。ワークロードグループのメモリ制限の絶対値は:
`physical_memory * mem_limit *
memory_limit`で、mem_limitはbe設定項目です。システム内のすべてのワークロードグループのmemory_limitの合計は100%を超えてはいけません。ワークロードグループは、ほとんどの場合、グループ内のタスクに対してmemory_limitの使用が保証されます。ワークロードグループのメモリ使用量がこの制限を超えた場合、excess
memoryを解放するために、グループ内でメモリ使用量がより大きいタスクがキャンセルされる可能性があります。enable_memory_overcommitを参照してください。
+2. `<conditions>`
+ -
be_scan_rows：1つのBEプロセス内でSQLがスキャンした行数です。SQLがBE上で複数の並行処理によって実行される場合は、各並行処理の累積値です。
+ -
be_scan_bytes：1つのBEプロセス内でSQLがスキャンしたバイト数です。SQLがBE上で複数の並行処理によって実行される場合は、各並行処理の累積値です。単位はバイトです。
+ - query_time：単一のBEプロセス上でのSQLの実行時間です。単位はミリ秒です。
+ -
query_be_memory_bytes：バージョン2.1.5以降でサポートされています。1つのBEプロセス内でSQLが使用するメモリ量です。SQLがBE上で複数の並行処理によって実行される場合は、各並行処理の累積値です。単位はバイトです。
-* enable_memory_overcommit:
オプション、ワークロードグループのソフトメモリ分離を有効にします。デフォルトはfalseです。falseに設定されている場合、ワークロードグループはハードメモリ分離され、ワークロードグループのメモリ使用量が制限を超えた直後に、メモリ使用量が最大のタスクが直ちにキャンセルされ、excess
memoryが解放されます。trueに設定されている場合、ワークロードグループはハードメモリ分離され、ワークロードグループのメモリ使用量が制限を超えた直後に、メモリ使用量が最大のタスクが直ちにキャンセルされ、excess
memoryが解放されます。trueに設定されている場合、ワークロードグループはソフト分離され、システムに空きメモリリソースがある場合、ワークロードグループはmemory_limit制限を超えた後もシステムメ�
��を継続して使用でき、システムの総メモリが不足している場合は、メモリ占有量が最大のグループ内の複数のタスクをキャンセルし、システムメモリ圧迫を緩和するためにexcess
memoryの一部を解放します。ワー [...]
+3. `<actions>`
+ - cancel_query：クエリをキャンセルします。
+
+## オプションパラメータ
+
+1. `<properties>`
+ -
enabled：trueまたはfalseを指定できます。デフォルトはtrueです。trueの場合はポリシーが有効になり、falseの場合は無効になります。
+ -
priority：0から100までの整数を指定できます。デフォルトは0です。値が大きいほど優先度が高くなります。複数のポリシーがクエリに一致した場合は、優先度が最も高いポリシーが選択されます。
+ - workload_group：ポリシーを1つのWorkload
Groupにバインドできます。バインドした場合、そのポリシーは該当するWorkload
Groupに対してのみ有効になります。デフォルトは空で、すべてのクエリに適用されます。
+
+ Workload Group自体がCompute Groupに属するため、このプロパティの値は次の規則に従う必要があります。
+
+ - **クラウド（ストレージ・コンピュート分離）モード**：完全修飾形式
`<compute_group>.<workload_group>`
が必要です。例：`'workload_group'='compute_group_a.wg1'`。`<workload_group>` 単独の形式、`.`
が2つ以上含まれる形式、または空のセグメント（`.wg1` や `wg1.`
など）を含む形式は使用できず、次のエラーが返されます：`workload_group must be
'<compute_group>.<workload_group>' in cloud mode`。
+ - **非クラウド（ストレージ・コンピュート統合）モード**：次の2つの形式を使用できます。
+ - `<workload_group>`：デフォルトのリソースグループ（`default`）配下にある同名のWorkload
Groupにバインドされます。
+ -
`<resource_group>.<workload_group>`：リソースグループを明示的に指定します。ここでのプレフィックスは実際にはリソースグループ（Tag）を指します。構文は、一貫性を保つためにクラウドモードと共通化されています。
+
+ `.` が2つ以上含まれる形式、または空のセグメントを含む形式も使用できず、次のエラーが返されます：`workload_group
must be '<workload_group>' or '<resource_group>.<workload_group>' in non-cloud
mode`。
+
+## アクセス制御要件
+
+少なくともADMIN_PRIV権限が必要です。
## 例
-1. g1という名前のワークロードグループを作成する:
+1. 実行時間が3秒を超えたクエリをキャンセルするWorkload Policyを作成します。
+
+ ```sql
+ create workload policy kill_big_query conditions(query_time > 3000)
actions(cancel_query)
+ ```
+
+2. デフォルトで無効になっているWorkload Policyを作成します。
+
+ ```sql
+ create workload policy kill_big_query conditions(query_time > 3000)
actions(cancel_query) properties('enabled'='false')
+ ```
- ```sql
- create workload group if not exists g1
- properties (
- "cpu_share"="10",
- "memory_limit"="30%",
- "enable_memory_overcommit"="true"
- );
- ```
-## キーワード
+3. クラウドモードで、Compute Group `compute_group_a` 配下のWorkload Group `wg1`
に対してのみ有効になるポリシーを作成します（完全修飾形式を使用します）。
-CREATE、WORKLOAD、GROUP
+ ```sql
+ create workload policy kill_big_query conditions(query_time > 3000)
actions(cancel_query) properties('workload_group'='compute_group_a.wg1')
+ ```
diff --git
a/ja-source/docusaurus-plugin-content-docs/version-3.x/admin-manual/workload-management/sql-blocking.md
b/ja-source/docusaurus-plugin-content-docs/version-3.x/admin-manual/workload-management/sql-blocking.md
index 6171b7c8f8a..8eeeed092d5 100644
---
a/ja-source/docusaurus-plugin-content-docs/version-3.x/admin-manual/workload-management/sql-blocking.md
+++
b/ja-source/docusaurus-plugin-content-docs/version-3.x/admin-manual/workload-management/sql-blocking.md
@@ -225,18 +225,16 @@ Workload Policyを作成する際は、以下を指定する必要がありま
| Conditions | Description
|
|-----------------------|-------------------------------------------------------------------------------------------------------------|
-| username | クエリによって伝達されるユーザー名。FEにおいて`set_session_variable`
Actionのみをトリガーします。 |
| be_scan_rows |
単一のBEプロセスでSQLによってスキャンされた行数。SQLがBE上で並行実行される場合、複数の並行実行の累積値になります。 |
| be_scan_bytes |
単一のBEプロセスでSQLによってスキャンされたバイト数。SQLがBE上で並行実行される場合、複数の並行実行の累積値になります（単位：バイト）。 |
| query_time | 単一のBEプロセスにおけるSQLの実行時間（単位：ミリ秒）。
|
| query_be_memory_bytes |
単一のBEプロセスにおけるSQLのメモリ使用量。SQLがBE上で並行実行される場合、複数の並行実行の累積値になります（単位：バイト）。 |
--
**Action**は条件がトリガーされた際に実行されるアクションを表します。現在、Policyは1つのActionのみ定義できます（`set_session_variable`を除く）。上記の例では、`cancel_query`はクエリのキャンセルを示しています。現在サポートされているActionは以下の通りです：
+-
**Action**は条件がトリガーされた際に実行されるアクションを表します。現在、Policyは1つのActionのみ定義できます。上記の例では、`cancel_query`はクエリのキャンセルを示しています。現在サポートされているActionは以下の通りです：
| Actions | Description
|
|------------------------|------------------------------------------------------------------------------------------------------------------|
| cancel_query | クエリをキャンセルします。
|
-| set_session_variable | `set session
variable`文をトリガーします。単一のpolicyは複数の`set_session_variable`オプションを持つことができ、現在は`username`
ConditionによってFEでのみトリガーされます。 |
- **Properties**は現在のPolicyの属性を定義し、有効かどうかとその優先度が含まれます。
@@ -257,7 +255,6 @@ Actions(cancel_query)
properties('workload_group'='normal')
```
### 重要な注意事項
--
同じPolicyのConditionsとActionsは、両方ともFEであるか両方ともBEである必要があります。例えば、`set_session_variable`と`cancel_query`は同じPolicy内で設定することはできません。Conditions
`be_scan_rows`と`username`は同じPolicy内で設定することはできません。
-
現在、Policyは固定時間間隔で非同期スレッドによって実行されるため、ポリシー実行に一定の遅延が生じます。例えば、ユーザーがスキャン行数が1,000,000を超えた場合にクエリをキャンセルするポリシーを設定し、その時点でクラスターリソースが比較的アイドル状態の場合、キャンセルポリシーが有効になる前にクエリが完了する可能性があります。現在の間隔は500msであり、この間隔より短い実行時間のクエリはポリシーチェックを回避する可能性があります。
- 現在サポートされているロードタイプには、select/insert、select/stream load、broker load、routine
loadが含まれます。
- 単一のクエリは複数のPolicyにマッチする可能性がありますが、最も高い優先度を持つPolicyのみが有効になります。
@@ -265,34 +262,7 @@ properties('workload_group'='normal')
### Workload Policyデモンストレーション
-#### 1. Session Variable修正テスト
-Adminアカウントのセッション変数で並行処理関連のパラメータの修正を試行します。
-
-```sql
--- log on admin to check variables
-show variables like '%parallel_fragment_exec_instance_num%';
-+-------------------------------------+-------+---------------+---------+
-| Variable_name | Value | Default_Value | Changed |
-+-------------------------------------+-------+---------------+---------+
-| parallel_fragment_exec_instance_num | 8 | 8 | 0 |
-+-------------------------------------+-------+---------------+---------+
-1 row in set (0.00 sec)
-
--- Create a Policy to modify the concurrency parameters of the admin account.
-create workload Policy test_set_var_Policy
-Conditions(username='admin')
-Actions(set_session_variable 'parallel_fragment_exec_instance_num=1')
-
--- After some time, check the admin account's parameters again.
-show variables like '%parallel_fragment_exec_instance_num%';
-+-------------------------------------+-------+---------------+---------+
-| Variable_name | Value | Default_Value | Changed |
-+-------------------------------------+-------+---------------+---------+
-| parallel_fragment_exec_instance_num | 1 | 8 | 1 |
-+-------------------------------------+-------+---------------+---------+
-1 row in set (0.01 sec)
-```
-#### 2. Big Query Circuit Breaker Test
+#### Big Query Circuit Breaker Test
3秒を超えて実行されるクエリをサーキットブレイクするテスト。以下は、ckbenchのq29の成功実行の監査ログで、このSQLの完了に4.5秒かかったことを示しています。
```sql
diff --git
a/ja-source/docusaurus-plugin-content-docs/version-3.x/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
b/ja-source/docusaurus-plugin-content-docs/version-3.x/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
index c64bbd102de..65bc99ff3c0 100644
---
a/ja-source/docusaurus-plugin-content-docs/version-3.x/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
+++
b/ja-source/docusaurus-plugin-content-docs/version-3.x/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
@@ -1,47 +1,61 @@
---
{
- "title": "CREATE WORKLOAD GROUP | コンピュート管理",
- "sidebar_label": "CREATE WORKLOAD GROUP",
- "description":
"このステートメントはワークロードグループを作成するために使用されます。ワークロードグループは、単一のbe上でcpuリソースとメモリリソースの分離を可能にします。",
- "language": "ja"
+ "title": "CREATE WORKLOAD POLICY を作成",
+ "language": "ja",
+ "description": "特定の条件を満たすクエリに対して対応するアクションを実行するためのWorkload Policyを作成します。"
}
---
-# CREATE WORKLOAD GROUP
+## 説明
-## デスクリプション
+特定の条件を満たすクエリに対して対応するアクションを実行するWorkload Policyを作成します。
-このステートメントはワークロードグループを作成するために使用されます。ワークロードグループは、単一のbe上でcpuリソースとmemoryリソースの分離を可能にします。
-grammar:
+## 構文
```sql
-CREATE WORKLOAD GROUP [IF NOT EXISTS] "rg_name"
-PROPERTIES (
- property_list
-);
+CREATE WORKLOAD POLICY [ IF NOT EXISTS ] <workload_policy_name>
+CONDITIONS(<conditions>) ACTIONS(<actions>)
+[ PROPERTIES (<properties>) ]
```
-図解:
+### 必須パラメータ
-property_listでサポートされるプロパティ:
+`<workload_policy_name>`
-* cpu_share:
必須、ワークロードグループが取得できるCPU時間の設定に使用され、CPUリソースのソフト分離を実現できます。cpu_shareは実行中のワークロードグループで利用可能なCPUリソースの重みを示す相対値です。例えば、ユーザーがcpu_shareをそれぞれ10、30、40に設定した3つのワークロードグループrg-a、rg-b、rg-cを作成し、ある時点でrg-aとrg-bがタスクを実行している一方、rg-cにタスクがない場合、rg-aは(10
/ (10 + 30)) =
25%のCPUリソースを取得でき、ワークロードグループrg-bは75%のCPUリソースを取得できます。システムで実行されているワークロードグループが1つだけの場合、そのcpu_shareの値に関係なく、すべてのCPUリソースを取得します。
+Workload Policyの名前。
-* memory_limit: 必須、ワークロードグループが使用できるbeメモリの割合を設定します。ワークロードグループのメモリ制限の絶対値は:
`physical_memory * mem_limit *
memory_limit`です。ここでmem_limitはbeの設定項目です。システム内のすべてのワークロードグループのmemory_limitの合計は100%を超えてはいけません。ワークロードグループは、ほとんどの場合、グループ内のタスクに対してmemory_limitの使用が保証されます。ワークロードグループのメモリ使用量がこの制限を超えた場合、グループ内でより多くのメモリを使用しているタスクがキャンセルされ、超過分のメモリが解放される場合があります。enable_memory_overcommitを参照してください。
-* enable_memory_overcommit:
オプション、ワークロードグループのソフトメモリ分離を有効にします。デフォルトはfalseです。falseに設定した場合、ワークロードグループはハードメモリ分離され、ワークロードグループのメモリ使用量が制限を超えた直後に最大のメモリ使用量を持つタスクが即座にキャンセルされ、超過分のメモリが解放されます。trueに設定した場合、ワークロードグループはハードメモリ分離され、ワークロードグループのメモリ使用量が制限を超えた直後に最大のメモリ使用量を持つタスクが即座にキャンセルされ、超過分のメモリが解放されます。trueに設定した場合、ワークロードグループはソフト分離され、システムに空きメモリリソースがある場合、ワークロードグループはmemory_limit制限を超えてシステムメモリを継
続して使用でき、システム全体のメモリが逼迫した時に、グループ内で最大のメモリ使用量を持ついくつかのタスクをキャンセルし、超過分のメモリの一部を解放してシステムメモリ圧迫を緩和します。ワークロードグループでこの設定を有効にする場合、すべてのワー
[...]
+
+1. **be_scan_rows**:
単一のBEプロセス内でSQLクエリによってスキャンされた行数。SQLクエリが複数のBE上で並行して実行される場合、これらの並行実行の累積値となります。
+2. **be_scan_bytes**:
単一のBEプロセス内でSQLクエリによってスキャンされたバイト数。SQLクエリが複数のBE上で並行して実行される場合、これらの並行実行の累積値となります（バイト単位）。
+3. **query_time**: 単一のBEプロセス上でのSQLクエリの実行時間（ミリ秒単位）。
+4. **query_be_memory_bytes**（バージョン2.1.5からサポート）:
単一のBEプロセス内でSQLクエリによって使用されるメモリ量。SQLクエリが複数のBE上で並行して実行される場合、これらの並行実行の累積値となります（バイト単位）。
+
+
+`<actions>`
+
+1. **cancel_query**: クエリをキャンセルします。
+
+### オプションパラメータ
+
+
+
+1. **enabled**:
trueまたはfalseの値を取り、デフォルト値はtrueです。trueに設定するとポリシーが有効になり、falseに設定するとポリシーが無効になります。
+2. **priority**:
0から100の範囲の整数値で、デフォルト値は0です。これはポリシーの優先度を表します。値が高いほど優先度が高くなります。複数のポリシーがマッチした場合、最も優先度の高いポリシーが選択されます。
+3. **workload_group**: 現在、ポリシーは1つのworkload groupにバインドでき、このポリシーが特定のworkload
groupにのみ適用されることを示します。デフォルトは空で、すべてのクエリに適用されることを意味します。
+
+### アクセス制御要件
+
+最低でも`ADMIN_PRIV`権限が必要です。
## 例
-1. g1という名前のワークロードグループを作成:
+1. クエリ時間が3秒を超えるすべてのクエリをkillする新しいWorkload Policyを作成します。
- ```sql
- create workload group if not exists g1
- properties (
- "cpu_share"="10",
- "memory_limit"="30%",
- "enable_memory_overcommit"="true"
- );
- ```
-## Keywords
+ ```Java
+ create workload policy kill_big_query conditions(query_time > 3000)
actions(cancel_query)
+ ```
+1. デフォルトで有効にならない新しいWorkload Policyを作成します。
-CREATE、WORKLOAD、GROUP
+ ```Java
+ create workload policy kill_big_query conditions(query_time > 3000)
actions(cancel_query) properties('enabled'='false')
+ ```
diff --git
a/ja-source/docusaurus-plugin-content-docs/version-4.x/admin-manual/workload-management/sql-blocking.md
b/ja-source/docusaurus-plugin-content-docs/version-4.x/admin-manual/workload-management/sql-blocking.md
index cfe74535eed..5e9068c569d 100644
---
a/ja-source/docusaurus-plugin-content-docs/version-4.x/admin-manual/workload-management/sql-blocking.md
+++
b/ja-source/docusaurus-plugin-content-docs/version-4.x/admin-manual/workload-management/sql-blocking.md
@@ -225,18 +225,16 @@ Workload Policyを作成する際は、以下を指定する必要がありま
| Conditions | Description
|
|-----------------------|-------------------------------------------------------------------------------------------------------------|
-| username | クエリが持つユーザー名。FEでの`set_session_variable`
Actionのみをトリガーします。 |
| be_scan_rows |
単一のBEプロセスでSQLによってスキャンされた行数。SQLがBE上で並行実行される場合は、複数の並行実行の累積値です。 |
| be_scan_bytes |
単一のBEプロセスでSQLによってスキャンされたバイト数。SQLがBE上で並行実行される場合は、複数の並行実行の累積値で、単位はバイトです。 |
| query_time | 単一のBEプロセスでのSQLの実行時間、単位はミリ秒です。
|
| query_be_memory_bytes |
単一のBEプロセスでのSQLのメモリ使用量。SQLがBE上で並行実行される場合は、複数の並行実行の累積値で、単位はバイトです。 |
--
**Action**は条件がトリガーされた際に実行されるアクションを表します。現在、Policyは1つのActionのみを定義できます（`set_session_variable`を除く）。上記の例では、`cancel_query`はクエリをキャンセルすることを示しています。現在サポートされているActionは以下の通りです：
+-
**Action**は条件がトリガーされた際に実行されるアクションを表します。現在、Policyは1つのActionのみを定義できます。上記の例では、`cancel_query`はクエリをキャンセルすることを示しています。現在サポートされているActionは以下の通りです：
| Actions | Description
|
|------------------------|------------------------------------------------------------------------------------------------------------------|
| cancel_query | クエリをキャンセルします。
|
-| set_session_variable | `set session
variable`文をトリガーします。単一のポリシーは複数の`set_session_variable`オプションを持つことができ、現在は`username`
ConditionによってFEでのみトリガーされます。 |
- **Properties**は現在のPolicyの属性を定義し、有効かどうかと優先度を含みます。
@@ -257,7 +255,6 @@ Actions(cancel_query)
properties('workload_group'='normal')
```
### 重要な注意事項
--
同一のPolicyのConditionsとActionsは、両方ともFEまたは両方ともBEのいずれかである必要があります。例えば、`set_session_variable`と`cancel_query`を同一のPolicy内で設定することはできません。Conditions
`be_scan_rows`と`username`を同一のPolicy内で設定することはできません。
-
現在、Policyは固定時間間隔で非同期スレッドによって実行されるため、ポリシー実行に一定の遅延が生じます。例えば、ユーザーがスキャンされた行数が1,000,000を超えた際にクエリをキャンセルするポリシーを設定し、その時点でクラスタリソースが比較的アイドル状態である場合、キャンセルポリシーが有効になる前にクエリが完了する可能性があります。現在の間隔は500msであり、この間隔より短い実行時間のクエリはポリシーチェックを回避する可能性があります。
- 現在サポートされているロードタイプには、select/insert、select/stream load、broker load、routine
loadが含まれます。
- 単一のクエリは複数のPolicyにマッチする可能性がありますが、最も優先度の高いPolicyのみが有効になります。
@@ -265,34 +262,7 @@ properties('workload_group'='normal')
### Workload Policyデモンストレーション
-#### 1. Session Variable変更テスト
-AdminアカウントのセッションVariable内の並行性関連パラメータの変更を試行します。
-
-```sql
--- log on admin to check variables
-show variables like '%parallel_fragment_exec_instance_num%';
-+-------------------------------------+-------+---------------+---------+
-| Variable_name | Value | Default_Value | Changed |
-+-------------------------------------+-------+---------------+---------+
-| parallel_fragment_exec_instance_num | 8 | 8 | 0 |
-+-------------------------------------+-------+---------------+---------+
-1 row in set (0.00 sec)
-
--- Create a Policy to modify the concurrency parameters of the admin account.
-create workload Policy test_set_var_Policy
-Conditions(username='admin')
-Actions(set_session_variable 'parallel_fragment_exec_instance_num=1')
-
--- After some time, check the admin account's parameters again.
-show variables like '%parallel_fragment_exec_instance_num%';
-+-------------------------------------+-------+---------------+---------+
-| Variable_name | Value | Default_Value | Changed |
-+-------------------------------------+-------+---------------+---------+
-| parallel_fragment_exec_instance_num | 1 | 8 | 1 |
-+-------------------------------------+-------+---------------+---------+
-1 row in set (0.01 sec)
-```
-#### 2. Big Query Circuit Breaker Test
+#### Big Query Circuit Breaker Test
3秒以上実行されるクエリを回路遮断するテスト。以下は、ckbenchのq29の正常実行の監査ログで、このSQLの完了に4.5秒かかったことを示している。
```sql
diff --git
a/ja-source/docusaurus-plugin-content-docs/version-4.x/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
b/ja-source/docusaurus-plugin-content-docs/version-4.x/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
index 8aaffbac707..1debeda897f 100644
---
a/ja-source/docusaurus-plugin-content-docs/version-4.x/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
+++
b/ja-source/docusaurus-plugin-content-docs/version-4.x/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
@@ -1,47 +1,72 @@
---
{
- "title": "CREATE WORKLOAD GROUP | コンピュート管理",
- "sidebar_label": "CREATE WORKLOAD GROUP",
- "description":
"このステートメントはワークロードグループを作成するために使用されます。ワークロードグループは、単一のbe上でcpuリソースとメモリリソースの分離を可能にします。",
- "language": "ja"
+ "title": "CREATE WORKLOAD POLICY",
+ "language": "ja",
+ "description": "Workload
Policyを作成します。クエリが特定の条件を満たした場合に、対応するアクションを実行するために使用します。"
}
---
-# CREATE WORKLOAD GROUP
## 説明
-このステートメントはworkload groupを作成するために使用されます。Workload
groupは単一のbe上でcpuリソースとmemoryリソースの分離を可能にします。
+Workload Policyを作成します。クエリが特定の条件を満たした場合に、対応するアクションを実行するために使用します。
-文法:
+## 構文
```sql
-CREATE WORKLOAD GROUP [IF NOT EXISTS] "rg_name"
-PROPERTIES (
- property_list
-);
+CREATE WORKLOAD POLICY [ IF NOT EXISTS ] <workload_policy_name>
+CONDITIONS(<conditions>) ACTIONS(<actions>)
+[ PROPERTIES (<properties>) ]
```
-illustrate:
-property_listでサポートされているプロパティ：
+## 必須パラメータ
-* cpu_share:
必須。ワークロードグループが取得できるcpu時間を設定するために使用され、cpuリソースのソフト分離を実現できます。cpu_shareは実行中のワークロードグループが利用可能なcpuリソースの重みを示す相対値です。例えば、ユーザーがcpu_shareをそれぞれ10、30、40に設定した3つのワークロードグループrg-a、rg-b、rg-cを作成し、ある時点でrg-aとrg-bがタスクを実行しているがrg-cにはタスクがない場合、rg-aは(10
/ (10 + 30)) =
25%のcpuリソースを取得でき、ワークロードグループrg-bは75%のcpuリソースを取得できます。システムで実行されているワークロードグループが1つだけの場合、そのcpu_shareの値に関係なく、すべてのcpuリソースを取得します。
+1. `<workload_policy_name>`：Workload Policyの名前です。
-* memory_limit:
必須。ワークロードグループが使用できるbeメモリの割合を設定します。ワークロードグループメモリ制限の絶対値は：`physical_memory *
mem_limit *
memory_limit`で、mem_limitはbe設定項目です。システム内のすべてのワークロードグループの合計memory_limitは100%を超えてはいけません。ワークロードグループは、ほとんどの場合、グループ内のタスクに対してmemory_limitの使用が保証されています。ワークロードグループのメモリ使用量がこの制限を超えた場合、メモリ使用量の多いグループ内のタスクがキャンセルされ、超過メモリが解放される可能性があります。enable_memory_overcommitを参照してください。
+2. `<conditions>`
+ -
be_scan_rows：1つのBEプロセス内でSQLがスキャンした行数です。SQLがBE上で複数の並行処理によって実行される場合は、各並行処理の累積値です。
+ -
be_scan_bytes：1つのBEプロセス内でSQLがスキャンしたバイト数です。SQLがBE上で複数の並行処理によって実行される場合は、各並行処理の累積値です。単位はバイトです。
+ - query_time：単一のBEプロセス上でのSQLの実行時間です。単位はミリ秒です。
+ -
query_be_memory_bytes：バージョン2.1.5以降でサポートされています。1つのBEプロセス内でSQLが使用するメモリ量です。SQLがBE上で複数の並行処理によって実行される場合は、各並行処理の累積値です。単位はバイトです。
-* enable_memory_overcommit:
オプション。ワークロードグループのソフトメモリ分離を有効にします。デフォルトはfalseです。falseに設定された場合、ワークロードグループはハードメモリ分離され、ワークロードグループのメモリ使用量が制限を超えた直後に、メモリ使用量が最も大きいタスクが即座にキャンセルされ、超過メモリが解放されます。trueに設定された場合、ワークロードグループはハードメモリ分離され、ワークロードグループのメモリ使用量が制限を超えた直後に、メモリ使用量が最も大きいタスクが即座にキャンセルされ、超過メモリが解放されます。trueに設定された場合、ワークロードグループはソフト分離され、システムに空きメモリリソースがある場合、ワークロードグループはmemory_limit制限を超えてもシステムメモリ
を継続して使用でき、システム全体のメモリが逼迫した場合、グループ内でメモリ占有量が最も大きい複数のタスクをキャンセルし、超過メモリの一部を解放してシステムメモリ圧迫を緩和します。この設定をワークロードグループで有効にする場合、すべてのワークロ
[...]
+3. `<actions>`
+ - cancel_query：クエリをキャンセルします。
-## Example
+## オプションパラメータ
-1. g1という名前のワークロードグループを作成する：
+1. `<properties>`
+ -
enabled：trueまたはfalseを指定できます。デフォルトはtrueです。trueの場合はポリシーが有効になり、falseの場合は無効になります。
+ -
priority：0から100までの整数を指定できます。デフォルトは0です。値が大きいほど優先度が高くなります。複数のポリシーがクエリに一致した場合は、優先度が最も高いポリシーが選択されます。
+ - workload_group：ポリシーを1つのWorkload
Groupにバインドできます。バインドした場合、そのポリシーは該当するWorkload
Groupに対してのみ有効になります。デフォルトは空で、すべてのクエリに適用されます。
- ```sql
- create workload group if not exists g1
- properties (
- "cpu_share"="10",
- "memory_limit"="30%",
- "enable_memory_overcommit"="true"
- );
- ```
-## Keywords
+ Workload Group自体がCompute Groupに属するため、このプロパティの値は次の規則に従う必要があります。
-CREATE、WORKLOAD、GROUP
+ - **クラウド（ストレージ・コンピュート分離）モード**：完全修飾形式
`<compute_group>.<workload_group>`
が必要です。例：`'workload_group'='compute_group_a.wg1'`。`<workload_group>` 単独の形式、`.`
が2つ以上含まれる形式、または空のセグメント（`.wg1` や `wg1.`
など）を含む形式は使用できず、次のエラーが返されます：`workload_group must be
'<compute_group>.<workload_group>' in cloud mode`。
+ - **非クラウド（ストレージ・コンピュート統合）モード**：次の2つの形式を使用できます。
+ - `<workload_group>`：デフォルトのリソースグループ（`default`）配下にある同名のWorkload
Groupにバインドされます。
+ -
`<resource_group>.<workload_group>`：リソースグループを明示的に指定します。ここでのプレフィックスは実際にはリソースグループ（Tag）を指します。構文は、一貫性を保つためにクラウドモードと共通化されています。
+
+ `.` が2つ以上含まれる形式、または空のセグメントを含む形式も使用できず、次のエラーが返されます：`workload_group
must be '<workload_group>' or '<resource_group>.<workload_group>' in non-cloud
mode`。
+
+## アクセス制御要件
+
+少なくともADMIN_PRIV権限が必要です。
+
+## 例
+
+1. 実行時間が3秒を超えたクエリをキャンセルするWorkload Policyを作成します。
+
+ ```sql
+ create workload policy kill_big_query conditions(query_time > 3000)
actions(cancel_query)
+ ```
+
+2. デフォルトで無効になっているWorkload Policyを作成します。
+
+ ```sql
+ create workload policy kill_big_query conditions(query_time > 3000)
actions(cancel_query) properties('enabled'='false')
+ ```
+
+3. クラウドモードで、Compute Group `compute_group_a` 配下のWorkload Group `wg1`
に対してのみ有効になるポリシーを作成します（完全修飾形式を使用します）。
+
+ ```sql
+ create workload policy kill_big_query conditions(query_time > 3000)
actions(cancel_query) properties('workload_group'='compute_group_a.wg1')
+ ```
diff --git
a/versioned_docs/version-3.x/admin-manual/workload-management/sql-blocking.md
b/versioned_docs/version-3.x/admin-manual/workload-management/sql-blocking.md
index bb42e1c8a98..dbf42ae0e90 100644
---
a/versioned_docs/version-3.x/admin-manual/workload-management/sql-blocking.md
+++
b/versioned_docs/version-3.x/admin-manual/workload-management/sql-blocking.md
@@ -189,7 +189,6 @@ Conditions represent the policy trigger conditions.
Multiple Conditions are sepa
| Condition | Description
|
|-----------------------|------------------------------------------------------------------------------------------------------|
-| username | The username carried by the query; only triggers the
set_session_variable Action in FE |
| be_scan_rows | Number of rows scanned by a SQL in a single BE
process; cumulative value when executed concurrently |
| be_scan_bytes | Number of bytes scanned by a SQL in a single BE
process; cumulative value when executed concurrently, in bytes |
| query_time | Runtime of a SQL in a single BE process, in
milliseconds |
@@ -197,12 +196,11 @@ Conditions represent the policy trigger conditions.
Multiple Conditions are sepa
#### Actions
-Actions represent the action taken when the condition is triggered. Currently,
a Policy can only define one Action (except for set_session_variable).
+Actions represent the action taken when the condition is triggered. Currently,
a Policy can only define one Action.
| Action | Description
|
|----------------------|-----------------------------------------------------------------------------------------------------------------|
| cancel_query | Cancel the query
|
-| set_session_variable | Triggers a set session variable statement. A single
Policy can have multiple set_session_variable options; currently only triggered
in FE by the username Condition |
#### Properties
@@ -264,38 +262,8 @@ MySQL [hits]> SELECT REGEXP_REPLACE(Referer,
'^https?://(?:www\\.)?([^/]+)/.*$',
ERROR 1105 (HY000): errCode = 2, detailMessage = (127.0.0.1)[CANCELLED]query
cancelled by workload policy,id:12345
```
-#### Example 2: Modifying User Session Variables
-
-Workload Policy can automatically modify session variables for specific users,
for example, adjusting concurrency parameters:
-
-```sql
--- Log in to admin account and check concurrency parameters
-MySQL [(none)]> show variables like '%parallel_fragment_exec_instance_num%';
-+-------------------------------------+-------+---------------+---------+
-| Variable_name | Value | Default_Value | Changed |
-+-------------------------------------+-------+---------------+---------+
-| parallel_fragment_exec_instance_num | 8 | 8 | 0 |
-+-------------------------------------+-------+---------------+---------+
-1 row in set (0.00 sec)
-
--- Create a Policy to modify the concurrency parameters of the admin account
-CREATE WORKLOAD POLICY test_set_var_policy
-CONDITIONS(username='admin')
-ACTIONS(set_session_variable 'parallel_fragment_exec_instance_num=1')
-
--- After some time, check the admin account's parameters again
-MySQL [(none)]> show variables like '%parallel_fragment_exec_instance_num%';
-+-------------------------------------+-------+---------------+---------+
-| Variable_name | Value | Default_Value | Changed |
-+-------------------------------------+-------+---------------+---------+
-| parallel_fragment_exec_instance_num | 1 | 8 | 1 |
-+-------------------------------------+-------+---------------+---------+
-1 row in set (0.01 sec)
-```
-
### Important Notes
-- The Conditions and Actions of the same Policy must belong to the same side
(FE or BE). For example, set_session_variable and cancel_query cannot be
configured within the same Policy; Condition be_scan_rows and Condition
username also cannot be configured within the same Policy.
- Policies are executed by asynchronous threads at fixed time intervals
(currently 500 ms), so there is a certain latency in policy enforcement.
Queries with very short run times may bypass the policy check.
- A single query may match multiple Policies, but only the Policy with the
highest priority will take effect.
- Modifications to Actions and Conditions are currently not supported; they
can only be modified by deleting and recreating them.
diff --git
a/versioned_docs/version-3.x/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
b/versioned_docs/version-3.x/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
index 72674d56f15..f99d71c9074 100644
---
a/versioned_docs/version-3.x/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
+++
b/versioned_docs/version-3.x/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
@@ -1,54 +1,64 @@
---
{
- "title": "CREATE WORKLOAD GROUP | Compute Management",
- "language": "en",
- "description": "This statement is used to create a workload group.
Workload groups enable the isolation of cpu resources and memory resources on a
single be.",
- "sidebar_label": "CREATE WORKLOAD GROUP"
+ "title": "CREATE WORKLOAD POLICY",
+ "language": "en",
+ "description": "Create a Workload Policy to execute corresponding actions
on a query when it meets certain conditions."
}
---
-# CREATE WORKLOAD GROUP
-
## Description
-This statement is used to create a workload group. Workload groups enable the
isolation of cpu resources and memory resources on a single be.
+Create a Workload Policy to execute corresponding actions on a query when it
meets certain conditions.
+
+
+## Syntax
-grammar:
```sql
-CREATE WORKLOAD GROUP [IF NOT EXISTS] "rg_name"
-PROPERTIES (
- property_list
-);
+CREATE WORKLOAD POLICY [ IF NOT EXISTS ] <workload_policy_name>
+CONDITIONS(<conditions>) ACTIONS(<actions>)
+[ PROPERTIES (<properties>) ]
```
+### Required Parameters
+
+`<workload_policy_name>`
+
+The name of the Workload Policy.
+
+
+
+1. **be_scan_rows**: The number of rows scanned by an SQL query within a
single BE process. If the SQL query is executed concurrently on multiple BEs,
it is the cumulative value of these concurrent executions.
+2. **be_scan_bytes**: The number of bytes scanned by an SQL query within a
single BE process. If the SQL query is executed concurrently on multiple BEs,
it is the cumulative value of these concurrent executions (in bytes).
+3. **query_time**: The execution time of an SQL query on a single BE process,
in milliseconds.
+4. **query_be_memory_bytes** (supported from version 2.1.5): The amount of
memory used by an SQL query within a single BE process. If the SQL query is
executed concurrently on multiple BEs, it is the cumulative value of these
concurrent executions (in bytes).
-illustrate:
-Properties supported by property_list:
+`<actions>`
-* cpu_share: Required, used to set how much cpu time the workload group can
acquire, which can achieve soft isolation of cpu resources. cpu_share is a
relative value indicating the weight of cpu resources available to the running
workload group. For example, if a user creates 3 workload groups rg-a, rg-b and
rg-c with cpu_share of 10, 30 and 40 respectively, and at a certain moment rg-a
and rg-b are running tasks while rg-c has no tasks, then rg-a can get (10 / (10
+ 30)) = 25% of the cp [...]
+1. **cancel_query**: Cancels the query.
-* memory_limit: Required, set the percentage of be memory that can be used by
the workload group. The absolute value of the workload group memory limit is:
`physical_memory * mem_limit * memory_limit`, where mem_limit is a be
configuration item. The total memory_limit of all workload groups in the system
must not exceed 100%. Workload groups are guaranteed to use the memory_limit
for the tasks in the group in most cases. When the workload group memory usage
exceeds this limit, tasks in t [...]
+### Optional Parameters
-* enable_memory_overcommit: Optional, enable soft memory isolation for the
workload group, default is false. if set to false, the workload group is hard
memory isolated and the tasks with the largest memory usage will be canceled
immediately after the workload group memory usage exceeds the limit to release
the excess memory. if set to true, the workload group is hard memory isolated
and the tasks with the largest memory usage will be canceled immediately after
the workload group memory [...]
-## Example
-1. Create a workload group named g1:
+1. **enabled**: Takes a value of true or false, with a default value of true.
When set to true, the policy is enabled; when set to false, the policy is
disabled.
+2. **priority**: An integer value ranging from 0 to 100, with a default value
of 0. This represents the priority of the policy. The higher the value, the
higher the priority. When multiple policies match, the policy with the highest
priority is selected.
+3. **workload_group**: Currently, a policy can be bound to one workload group,
indicating that this policy only applies to a specific workload group. The
default is empty, meaning it applies to all queries.
- ```sql
- create workload group if not exists g1
- properties (
- "cpu_share"="10",
- "memory_limit"="30%",
- "enable_memory_overcommit"="true"
- );
- ```
+### Access Control Requirements
-## Keywords
+Requires at least `ADMIN_PRIV` permissions.
-CREATE, WORKLOAD, GROUP
+## Examples
+1. Create a new Workload Policy to kill all queries that exceed 3 seconds in
query time.
+ ```Java
+ create workload policy kill_big_query conditions(query_time > 3000)
actions(cancel_query)
+ ```
+1. Create a new Workload Policy that is not enabled by default.
+ ```Java
+ create workload policy kill_big_query conditions(query_time > 3000)
actions(cancel_query) properties('enabled'='false')
+ ```
diff --git
a/versioned_docs/version-4.x/admin-manual/workload-management/sql-blocking.md
b/versioned_docs/version-4.x/admin-manual/workload-management/sql-blocking.md
index f7813a2fe12..f9da06fc06d 100644
---
a/versioned_docs/version-4.x/admin-manual/workload-management/sql-blocking.md
+++
b/versioned_docs/version-4.x/admin-manual/workload-management/sql-blocking.md
@@ -238,7 +238,7 @@ Conditions specify when the policy is triggered. Multiple
conditions are separat
| Condition | Description |
|-----------|------|
-| `username` | The username carried by the query. It can trigger the FE-side
`set_session_variable` Action. Starting from Doris 4.1.3, it can also be
combined with BE-side runtime metrics such as `query_time`, `be_scan_rows`,
`be_scan_bytes`, and `query_be_memory_bytes` to trigger `cancel_query`. This
condition only supports the equality operator (`=`), and the username cannot be
empty |
+| `username` | The username carried by the query. Starting from Doris 4.1.3,
it can be combined with BE-side runtime metrics such as `query_time`,
`be_scan_rows`, `be_scan_bytes`, and `query_be_memory_bytes` to trigger
`cancel_query`. This condition only supports the equality operator (`=`), and
the username cannot be empty |
| `be_scan_rows` | The number of rows scanned by a SQL within a single BE
process. Cumulative value under concurrent execution |
| `be_scan_bytes` | The number of bytes scanned by a SQL within a single BE
process. Cumulative value under concurrent execution (unit: bytes) |
| `query_time` | The execution time of a SQL on a single BE process (unit:
milliseconds) |
@@ -246,12 +246,11 @@ Conditions specify when the policy is triggered. Multiple
conditions are separat
#### Actions
-Actions specify what to do when the conditions are triggered. Currently, a
Policy can define only one Action (except for `set_session_variable`).
+Actions specify what to do when the conditions are triggered. Currently, a
Policy can define only one Action.
| Action | Description |
|--------|------|
| `cancel_query` | Cancel the query |
-| `set_session_variable` | Execute a set session variable statement. The same
Policy can include multiple of these options. Currently, this is only triggered
on the FE by the `username` Condition |
#### Policy Properties
@@ -319,36 +318,7 @@ MySQL [hits]> SELECT REGEXP_REPLACE(Referer,
'^https?://(?:www\\.)?([^/]+)/.*$',
ERROR 1105 (HY000): errCode = 2, detailMessage = (127.0.0.1)[CANCELLED]query
cancelled by workload policy,id:12345
```
-#### Example 2: Automatically Adjust User Session Variables
-
-Workload Policy can automatically modify session variables for a specific
user, for example, lowering concurrency to reduce resource consumption:
-
-```sql
--- Check the current concurrency parameter for the admin user
-MySQL [(none)]> show variables like '%parallel_fragment_exec_instance_num%';
-+-------------------------------------+-------+---------------+---------+
-| Variable_name | Value | Default_Value | Changed |
-+-------------------------------------+-------+---------------+---------+
-| parallel_fragment_exec_instance_num | 8 | 8 | 0 |
-+-------------------------------------+-------+---------------+---------+
-1 row in set (0.00 sec)
-
--- Create a policy: set the concurrency parameter for the admin user to 1
-CREATE WORKLOAD POLICY test_set_var_policy
-CONDITIONS(username='admin')
-ACTIONS(set_session_variable 'parallel_fragment_exec_instance_num=1');
-
--- Check again later, the parameter has taken effect
-MySQL [(none)]> show variables like '%parallel_fragment_exec_instance_num%';
-+-------------------------------------+-------+---------------+---------+
-| Variable_name | Value | Default_Value | Changed |
-+-------------------------------------+-------+---------------+---------+
-| parallel_fragment_exec_instance_num | 1 | 8 | 1 |
-+-------------------------------------+-------+---------------+---------+
-1 row in set (0.01 sec)
-```
-
-#### Example 3: Break Runtime Large Queries for a Specific User
+#### Example 2: Break Runtime Large Queries for a Specific User
Starting from Doris 4.1.3, you can combine `username` with BE-side runtime
metrics to cancel only the queries of a specific user. The following policy
cancels queries submitted by `test_user` when their running time on a single BE
exceeds 3000 ms:
@@ -361,9 +331,6 @@ ACTIONS(cancel_query);
Similarly, `username` can be combined with `be_scan_rows`, `be_scan_bytes`, or
`query_be_memory_bytes` to limit the scan volume or BE memory usage of a
specific user.
### Notes
-
-- **FE/BE side isolation**: The Condition and Action of the same Policy must
belong to the same side (FE or BE). `set_session_variable` is an FE-side Action
and cannot be combined with BE-side metrics such as `query_time` or
`be_scan_rows`. `cancel_query` is a BE-side Action and can be combined with
BE-side runtime metrics.
-- **`username` condition limit**: `username` is a shared condition. It can be
used with FE-side `set_session_variable`; starting from Doris 4.1.3, it can
also be used with BE-side runtime metrics to trigger `cancel_query`. The
`username` condition only supports equality (`=`); comparison operators such as
`>`, `>=`, `<`, and `<=` are not supported. If the BE cannot obtain explicit
user information for a query, the `username` condition does not match.
- **Asynchronous execution latency**: Policies are checked by an asynchronous
thread every 500 ms, so policy enforcement has some lag. Queries that run for a
very short time may complete before the check is triggered and bypass the
policy.
- **Priority mechanism**: A query may match multiple Policies, but only the
one with the highest priority (largest `priority` value) takes effect.
- **Modification limit**: Currently, directly modifying the Action and
Condition of an existing Policy is not supported. Delete the Policy and
recreate it.
diff --git
a/versioned_docs/version-4.x/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
b/versioned_docs/version-4.x/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
index d32978c4d14..13434b21efc 100644
---
a/versioned_docs/version-4.x/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
+++
b/versioned_docs/version-4.x/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-POLICY.md
@@ -29,7 +29,6 @@ CONDITIONS(<conditions>) ACTIONS(<actions>)
- query_be_memory_bytes: Supported since version 2.1.5. The memory usage
of a SQL within a single BE process. If the SQL is executed with multiple
concurrencies on the BE, this is the cumulative value of the concurrent
executions, in bytes.
3. `<actions>`
- - set_session_variable: This action executes a `set_session_variable`
statement. A single Policy may contain multiple `set_session_variable` actions,
allowing one Policy to execute multiple session-variable updates.
- cancel_query: Cancel the query.
## Optional Parameters
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
