Skip to content

Commit

Permalink
[Doc] Add meaning of 0 for variables (backport #53714) (#53931)
Browse files Browse the repository at this point in the history 
Co-authored-by: 絵空事スピリット <[email protected]>
  • Loading branch information
@mergify @EsoragotoSpirit
mergify[bot] and EsoragotoSpirit authored Dec 13, 2024
1 parent 5fb66c5 commit e3d7ad1
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 18 deletions.
6 changes: 3 additions & 3 deletions docs/en/administration/management/resource_management/query_queues.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ You can set the thresholds that trigger query queues via the following global se

| **Variable** | **Default** | **Description** |
| ----------------------------------- | ----------- | ------------------------------------------------------------ |
| query_queue_concurrency_limit | 0 | The upper limit of concurrent queries on a BE. It takes effect only after being set greater than `0`. |
| query_queue_mem_used_pct_limit | 0 | The upper limit of memory usage percentage on a BE. It takes effect only after being set greater than `0`. Range: [0, 1] |
| query_queue_cpu_used_permille_limit | 0 | The upper limit of CPU usage permille (CPU usage * 1000) on a BE. It takes effect only after being set greater than `0`. Range: [0, 1000] |
| query_queue_concurrency_limit | 0 | The upper limit of concurrent queries on a BE. It takes effect only after being set greater than `0`. Setting it to `0` indicates no limit is imposed. |
| query_queue_mem_used_pct_limit | 0 | The upper limit of memory usage percentage on a BE. It takes effect only after being set greater than `0`. Range: [0, 1]. Setting it to `0` indicates no limit is imposed. |
| query_queue_cpu_used_permille_limit | 0 | The upper limit of CPU usage permille (CPU usage * 1000) on a BE. It takes effect only after being set greater than `0`. Range: [0, 1000]. Setting it to `0` indicates no limit is imposed. |

> **NOTE**
>
Expand Down
12 changes: 6 additions & 6 deletions docs/en/sql-reference/System_variable.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -859,30 +859,30 @@ Used for compatibility with JDBC connection pool C3P0. No practical use.

### query_mem_limit

* **Description**: Used to set the memory limit of a query on each BE node. The default value is 0, which means no limit for it. This item takes effect only after Pipeline Engine is enabled. When the `Memory Exceed Limit` error happens, you could try to increase this variable.
* **Default**: 0, which means no limit.
* **Description**: Used to set the memory limit of a query on each BE node. The default value is 0, which means no limit for it. This item takes effect only after Pipeline Engine is enabled. When the `Memory Exceed Limit` error happens, you could try to increase this variable. Setting it to `0` indicates no limit is imposed.
* **Default**: 0
* **Unit**: Byte

### query_queue_concurrency_limit (global)

* **Description**: The upper limit of concurrent queries on a BE. It takes effect only after being set greater than `0`.
* **Description**: The upper limit of concurrent queries on a BE. It takes effect only after being set greater than `0`. Setting it to `0` indicates no limit is imposed.
* **Default**: 0
* **Data type**: Int

### query_queue_cpu_used_permille_limit (global)

* **Description**: The upper limit of CPU usage permille (CPU usage * 1000) on a BE. It takes effect only after being set greater than `0`.
* **Description**: The upper limit of CPU usage permille (CPU usage * 1000) on a BE. It takes effect only after being set greater than `0`. Setting it to `0` indicates no limit is imposed.
* **Value range**: [0, 1000]
* **Default**: `0`

### query_queue_max_queued_queries (global)

* **Description**: The upper limit of queries in a queue. When this threshold is reached, incoming queries are rejected. It takes effect only after being set greater than `0`.
* **Description**: The upper limit of queries in a queue. When this threshold is reached, incoming queries are rejected. It takes effect only after being set greater than `0`. Setting it to `0` indicates no limit is imposed.
* **Default**: `1024`.

### query_queue_mem_used_pct_limit (global)

* **Description**: The upper limit of memory usage percentage on a BE. It takes effect only after being set greater than `0`.
* **Description**: The upper limit of memory usage percentage on a BE. It takes effect only after being set greater than `0`. Setting it to `0` indicates no limit is imposed.
* **Value range**: [0, 1]
* **Default**: 0

Expand Down
6 changes: 3 additions & 3 deletions docs/zh/administration/management/resource_management/query_queues.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,9 @@ SET GLOBAL enable_group_level_query_queue = true;

| **变量** | **默认值** | **描述** |
| ----------------------------------- | ---------- | ------------------------------------------------------------ |
| query_queue_concurrency_limit | 0 | 单个 BE 节点中并发查询上限。仅在设置为大于 `0` 后生效。 |
| query_queue_mem_used_pct_limit | 0 | 单个 BE 节点中内存使用百分比上限。仅在设置为大于 `0` 后生效。取值范围：[0, 1] |
| query_queue_cpu_used_permille_limit | 0 | 单个 BE 节点中 CPU 使用千分比上限（即 CPU 使用率 * 1000）。仅在设置为大于 `0` 后生效。取值范围：[0, 1000] |
| query_queue_concurrency_limit | 0 | 单个 BE 节点中并发查询上限。仅在设置为大于 `0` 后生效。设置为 `0` 表示没有限制。 |
| query_queue_mem_used_pct_limit | 0 | 单个 BE 节点中内存使用百分比上限。仅在设置为大于 `0` 后生效。设置为 `0` 表示没有限制。取值范围：[0, 1] |
| query_queue_cpu_used_permille_limit | 0 | 单个 BE 节点中 CPU 使用千分比上限（即 CPU 使用率 * 1000）。仅在设置为大于 `0` 后生效。设置为 `0` 表示没有限制。取值范围：[0, 1000] |

> **说明**
>
Expand Down
12 changes: 6 additions & 6 deletions docs/zh/sql-reference/System_variable.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -869,31 +869,31 @@ ALTER USER 'jack' SET PROPERTIES ('session.query_timeout' = '600');

### query_mem_limit

* 描述：用于设置每个 BE 节点上单个查询的内存限制。该项仅在启用 Pipeline Engine 后生效。
* 描述：用于设置每个 BE 节点上单个查询的内存限制。该项仅在启用 Pipeline Engine 后生效。设置为 `0` 表示没有限制。
* 单位：字节
* 默认值：`0`，表示没有限制。
* 默认值：`0`

### query_queue_concurrency_limit (global)

* 描述：单个 BE 节点中并发查询上限。仅在设置为大于 `0` 后生效。
* 描述：单个 BE 节点中并发查询上限。仅在设置为大于 `0` 后生效。设置为 `0` 表示没有限制。
* 默认值：`0`
* 单位：-
* 类型：Int

### query_queue_cpu_used_permille_limit (global)

* 描述：单个 BE 节点中内存使用千分比上限（即 CPU 使用率）。仅在设置为大于 `0` 后生效。
* 描述：单个 BE 节点中内存使用千分比上限（即 CPU 使用率）。仅在设置为大于 `0` 后生效。设置为 `0` 表示没有限制。
* 默认值：0。
* 取值范围：[0, 1000]

### query_queue_max_queued_queries (global)

* 描述：队列中查询数量的上限。当达到此阈值时，新增查询将被拒绝执行。仅在设置为大于 `0` 后生效。
* 描述：队列中查询数量的上限。当达到此阈值时，新增查询将被拒绝执行。仅在设置为大于 `0` 后生效。设置为 `0` 表示没有限制。
* 默认值：1024。

### query_queue_mem_used_pct_limit (global)

* 描述：单个 BE 节点中内存使用百分比上限。仅在设置为大于 `0` 后生效。
* 描述：单个 BE 节点中内存使用百分比上限。仅在设置为大于 `0` 后生效。设置为 `0` 表示没有限制。
* 默认值：`0`
* 取值范围：[0, 1]

Expand Down

0 comments on commit e3d7ad1

Please sign in to comment.