This is an automated email from the ASF dual-hosted git repository.
laiyingchun pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-pegasus-website.git
The following commit(s) were added to refs/heads/master by this push:
new c1d55ffc Update table-envs docs (#84)
c1d55ffc is described below
commit c1d55ffced21d2ecdb5a63f951b27d403e94904e
Author: Yingchun Lai <[email protected]>
AuthorDate: Mon Apr 22 14:36:47 2024 +0800
Update table-envs docs (#84)
---
_docs/en/administration/table-env.md | 204 ++++++++++++++++++++++++-
_docs/en/tools/shell.md | 50 +++++--
_docs/zh/administration/table-env.md | 281 ++++++++++++++++++++++-------------
_docs/zh/tools/shell.md | 50 +++++--
4 files changed, 465 insertions(+), 120 deletions(-)
diff --git a/_docs/en/administration/table-env.md
b/_docs/en/administration/table-env.md
index cca5d1bd..bbbcd5a5 100644
--- a/_docs/en/administration/table-env.md
+++ b/_docs/en/administration/table-env.md
@@ -2,4 +2,206 @@
permalink: administration/table-env
---
-TRANSLATING
+# Introduction
+
+In order to control some of the behaviors of the table, Pegasus provides the
table environment variables, also known as `app envs`.
+
+The table environment variables are stored in the metadata of the table in the
form of a map (in the Thrift structure `app_info`) and persisted to the Apache
Zookeeper.
+
+View the table information through the shell tool's [`ls`
command](/docs/tools/shell/#ls), and the last column `envs_count` indicates the
number of environment variables of the table. For example:
+```
+>>> ls
+[general_info]
+app_id status app_name app_type partition_count replica_count
is_stateful create_time drop_time drop_expire envs_count
+2 AVAILABLE temp pegasus 8 3 true
2024-04-15_06:58:38 - - 1
+```
+
+If you want to view specific table environment variables, you need to use the
[get_app_envs](#get_app_envs) command.
+
+Table environment variables have the following characteristics:
+* Persist the metadata of the table onto Apache Zookeeper.
+* It can be dynamically modified through the command line, and once the
modification is successful, it will be immediately updated to Zookeeper.
+* Synchronize the variables though the periodic synchronization message
`config_sync` between the Meta Server and the Replica Server to take effect on
each Replica Server.
+> Due to periodic synchronization, the updated environment variables may not
take immediate effect on the Replica Server, but rather have a delay. This
delay time depends on the value of the configuration 'config_sync_interval_ms',
which defaults to 30 seconds.
+* The key of environmental variables is usually separated by `.` for easy
classification.
+
+The functions currently supported through table environment variables include:
+* [Manual-Compact](manual-compact)
+* [Usage-Scenario](usage-scenario)
+
+# Control commands
+
+Pegasus provides [Shell commands](/docs/tools/shell/) for manipulating table
environment variables.
+> Before executing these commands, `use <table_name>` needs to be executed to
select the table that needs to be operated on.
+
+## get_app_envs
+
+Refer to: [`get_app_envs` command](/docs/tools/shell/#get_app_envs)
+
+## set_app_envs
+
+Refer to: [`set_app_envs` command](/docs/tools/shell/#set_app_envs)
+
+## del_app_envs
+
+Refer to: [`del_app_envs` command](/docs/tools/shell/#del_app_envs)
+
+## clear_app_envs
+
+Refer to: [`clear_app_envs` command](/docs/tools/shell/#clear_app_envs)
+
+# Supported environment variables
+
+Starting from Pegasus 2.6, all supported table environment variables can be
obtained through Meta Server [HTTP API](/api/http) `/envs/list`.
+For example:
+
+```
+$ curl 127.0.0.1:34601/envs/list
+{
+ "business.info": {
+ "limitation": "",
+ "sample": "",
+ "type": "string"
+ },
+ "default_ttl": {
+ "limitation": ">= 0",
+ "sample": "86400",
+ "type": "unsigned int32"
+ },
+ "manual_compact.disabled": {
+ "limitation": "true | false",
+ "sample": "true",
+ "type": "bool"
+ },
+ "manual_compact.max_concurrent_running_count": {
+ "limitation": ">= 0",
+ "sample": "8",
+ "type": "unsigned int32"
+ },
+ "manual_compact.once.bottommost_level_compaction": {
+ "limitation": "force | skip",
+ "sample": "skip",
+ "type": "string"
+ },
+ "manual_compact.once.target_level": {
+ "limitation": "-1 or >= 1",
+ "sample": "6",
+ "type": "unsigned int64"
+ },
+ "manual_compact.once.trigger_time": {
+ "limitation": "> 0, timestamp (in seconds) to trigger the once manual
compaction",
+ "sample": "1700000000",
+ "type": "unsigned int64"
+ },
+ "manual_compact.periodic.bottommost_level_compaction": {
+ "limitation": "force | skip",
+ "sample": "skip",
+ "type": "string"
+ },
+ "manual_compact.periodic.target_level": {
+ "limitation": "-1 or >= 1",
+ "sample": "6",
+ "type": "unsigned int64"
+ },
+ "manual_compact.periodic.trigger_time": {
+ "limitation": "",
+ "sample": "",
+ "type": "string"
+ },
+ "replica.backup_request_throttling": {
+ "limitation": "<size[K|M]>*<delay|reject>*<milliseconds>",
+ "sample": "10000*delay*100,20000*reject*100",
+ "type": "string"
+ },
+ "replica.deny_client_request": {
+ "limitation": "timeout*all | timeout*write | timeout*read | reconfig*all |
reconfig*write | reconfig*read",
+ "sample": "timeout*all",
+ "type": "string"
+ },
+ "replica.read_throttling": {
+ "limitation": "<size[K|M]>*<delay|reject>*<milliseconds>",
+ "sample": "10000*delay*100,20000*reject*100",
+ "type": "string"
+ },
+ "replica.read_throttling_by_size": {
+ "limitation": "",
+ "sample": "20000*delay*100,20000*reject*100",
+ "type": "string"
+ },
+ "replica.rocksdb_block_cache_enabled": {
+ "limitation": "true | false",
+ "sample": "true",
+ "type": "bool"
+ },
+ "replica.rocksdb_iteration_threshold_time_ms": {
+ "limitation": ">= 0",
+ "sample": "1000",
+ "type": "unsigned int64"
+ },
+ "replica.slow_query_threshold": {
+ "limitation": ">= 20",
+ "sample": "1000",
+ "type": "unsigned int64"
+ },
+ "replica.split.validate_partition_hash": {
+ "limitation": "true | false",
+ "sample": "true",
+ "type": "bool"
+ },
+ "replica.write_throttling": {
+ "limitation": "<size[K|M]>*<delay|reject>*<milliseconds>",
+ "sample": "10000*delay*100,20000*reject*100",
+ "type": "string"
+ },
+ "replica.write_throttling_by_size": {
+ "limitation": "<size[K|M]>*<delay|reject>*<milliseconds>",
+ "sample": "10000*delay*100,20000*reject*100",
+ "type": "string"
+ },
+ "replica_access_controller.allowed_users": {
+ "limitation": "",
+ "sample": "",
+ "type": "string"
+ },
+ "replica_access_controller.ranger_policies": {
+ "limitation": "",
+ "sample": "",
+ "type": "string"
+ },
+ "rocksdb.allow_ingest_behind": {
+ "limitation": "true | false",
+ "sample": "true",
+ "type": "bool"
+ },
+ "rocksdb.checkpoint.reserve_min_count": {
+ "limitation": "> 0",
+ "sample": "2",
+ "type": "unsigned int32"
+ },
+ "rocksdb.checkpoint.reserve_time_seconds": {
+ "limitation": ">= 0",
+ "sample": "3600",
+ "type": "unsigned int32"
+ },
+ "rocksdb.num_levels": {
+ "limitation": "In range [1, 10]",
+ "sample": "6",
+ "type": "unsigned int64"
+ },
+ "rocksdb.usage_scenario": {
+ "limitation": "bulk_load | normal | prefer_write",
+ "sample": "normal",
+ "type": "string"
+ },
+ "rocksdb.write_buffer_size": {
+ "limitation": "In range [16777216, 536870912]",
+ "sample": "16777216",
+ "type": "unsigned int64"
+ },
+ "user_specified_compaction": {
+ "limitation": "",
+ "sample": "",
+ "type": "string"
+ }
+}
+```
\ No newline at end of file
diff --git a/_docs/en/tools/shell.md b/_docs/en/tools/shell.md
index c94e7b42..33e26ce7 100644
--- a/_docs/en/tools/shell.md
+++ b/_docs/en/tools/shell.md
@@ -520,10 +520,10 @@ Examples:
| create | Create a table, with the option to add `-p` and `-r` to
specify the number of partitions and replicas, respectively. The number of
partitions must be a power of two. If `-r` is not specified, the default number
of replicas is set to 3 (recommended value).
|
| drop | Delete a table, refer to [use drop commands to delete a
table](/administration/table-soft-delete#drop_commands).
|
| recall | Restore a previously deleted table, refer to [use recall
commands to recovery table](/administration/table-soft-delete#recall_commands).
|
-| get_app_envs | Retrieve the environmental variables of a table, refer
to [Table environment#get_app_envs](/administration/table-env#get_app_envs).
|
-| set_app_envs | Set the environmental variables for a table, refer to
[Table environment#set_app_envs](/administration/table-env#set_app_envs).
|
-| del_app_envs | Delete the environmental variables of a table, refer to
[Table environment#del_app_envs](/administration/table-env#del_app_envs).
|
-| clear_app_envs | Clean up the environmental variables of a table, refer
to [Table
environment#clear_app_envs](/administration/table-env#clear_app_envs).
|
+| get_app_envs | Retrieve the environmental variables of a table.
|
+| set_app_envs | Set the environmental variables for a table.
|
+| del_app_envs | Delete the environmental variables of a table.
|
+| clear_app_envs | Clean up the environmental variables of a table.
|
| add_dup | Add a cluster with duplication, refer to
[duplication](/administration/duplication).
|
| query_dup | Query the clusters for cross-data center synchronization
of a table, refer to [duplication](/administration/duplication).
|
| remove_dup | Remove a cluster with duplication, refer to
[duplication](/administration/duplication).
|
@@ -700,13 +700,16 @@ USAGE: get_app_envs
Explanation:
-- This command outputs the current environmental variables of the table.
Please use `use [app_name]` to select a specific table before executing this
command. For reference, see
[get_app_envs](/administration/table-env#get_app_envs).
+- This command outputs the current environmental variables of the table.
Please use `use [app_name]` to select a specific table before executing this
command.
Examples:
```
>>> use temp
+OK
>>> get_app_envs
+[app_envs]
+rocksdb.usage_scenario : normal
```
### set_app_envs
@@ -721,13 +724,15 @@ USAGE: set_app_envs <key> <value> [key
value...]
Explanation:
-- This command will set the current environmental variables of the table.
Please use `use [app_name]` to select a specific table before executing this
command. For reference, see
[get_app_envs](/administration/table-env#get_app_envs).
+- This command will set the current environmental variables of the table.
Please use `use [app_name]` to select a specific table before executing this
command.
Examples:
```
>>> use temp
+OK
>>> set_app_envs rocksdb.usage_scenario bulk_load
+set app envs succeed
```
### del_app_envs
@@ -742,13 +747,21 @@ USAGE: del_app_envs <key> [key...]
Explanation:
-- This command delete the environmental variables of the current table. Please
use `use [app_name]` to select a specific table before executing this command.
For reference, see [get_app_envs](/administration/table-env#get_app_envs).
+- This command deletes the environmental variables of the current table.
Please use `use [app_name]` to select a specific table before executing this
command.
Examples:
```
>>> use temp
+OK
+>>> set_app_envs rocksdb.usage_scenario bulk_load
+set app envs succeed
>>> del_app_envs rocksdb.usage_scenario
+del app envs succeed
+=============================
+deleted keys:
+ rocksdb.usage_scenario
+=============================
```
### clear_app_envs
@@ -763,7 +776,7 @@ USAGE: clear_app_envs [-a|--all] [-p|--prefix str]
Explanation:
-- This command eradicates the present table's environmental variables. Prior
to employment, please ensure to employ `use [app_name]` to designate a specific
table, as referenced in
[clear_app_envs](/administration/table-env#clear_app_envs).
+- This command eradicates the present table's environmental variables. Prior
to employment, please ensure to employ `use [app_name]` to designate a specific
table.
- The `-a` option: When specified, it results in the purging of all
environmental variables.
- The `-p` option: When specified, it allows for the elimination of
environmental variables with a specific prefix string.
@@ -771,7 +784,26 @@ Examples:
```
>>> use temp
->>> clear_app_envs -p rocksdb
+OK
+>>> set_app_envs manual_compact.once.trigger_time 1713700000
+set app envs succeed
+>>> set_app_envs manual_compact.once.target_level -1
+set app envs succeed
+>>> set_app_envs manual_compact.once.bottommost_level_compaction force
+set app envs succeed
+>>> set_app_envs rocksdb.usage_scenario bulk_load
+set app envs succeed
+>>> clear_app_envs -p manual_compact
+clear app envs succeed
+=============================
+deleted keys:
+ manual_compact.once.bottommost_level_compaction
+ manual_compact.once.target_level
+ manual_compact.once.trigger_time
+=============================
+>>> get_app_envs
+[app_envs]
+rocksdb.usage_scenario : bulk_load
```
### add_dup
diff --git a/_docs/zh/administration/table-env.md
b/_docs/zh/administration/table-env.md
index e632cc09..6c99412b 100644
--- a/_docs/zh/administration/table-env.md
+++ b/_docs/zh/administration/table-env.md
@@ -2,126 +2,205 @@
permalink: administration/table-env
---
-# 功能目标
+# 介绍
-为了对Table的一些行为进行控制，Pegasus提供了Table环境变量，又称之为`app envs`。
+为了对 table 的一些行为进行控制，Pegasus 提供了 table 环境变量，又称之为 `app envs`。
-Table环境变量以kv-map的形式存储在Table的元数据`app_info`中，并持久化到Zookeeper上。通过shell的`ls`命令查看表信息，最后一列`envs_count`记录Table环境变量的kv对个数：
+Table 环境变量以 map 的形式存储在该表的元数据中（Thrift 结构 `app_info` 中），并持久化到 Apache Zookeeper 上。
+
+通过 shell 工具的 [`ls` 命令](/docs/tools/shell/#ls) 查看表信息，最后一列 `envs_count`
指明了该表的环境变量个数。例如：
```
>>> ls
-app_id status app_name app_type
partition_count replica_count is_stateful drop_expire_time
envs_count
-1 AVAILABLE temp pegasus 8
3 true - 1
+[general_info]
+app_id status app_name app_type partition_count replica_count
is_stateful create_time drop_time drop_expire envs_count
+2 AVAILABLE temp pegasus 8 3 true
2024-04-15_06:58:38 - - 1
```
-如果要查看具体的Table环境变量，则需要使用[get_app_envs](#get_app_envs)命令。
+如果要查看具体的 table 环境变量，则需要使用 [get_app_envs](#get_app_envs) 命令。
+
+Table 环境变量具有如下特性：
+* 作为 table 的元数据持久化到 Apache Zookeeper 上。
+* 可以通过命令行动态修改，修改成功后会立即更新到 Apache Zookeeper 上。
+* 通过 Meta Server 和 Replica Server 的周期性同步消息 `config_sync` 同步给各个 Replica Server
生效。
+> 由于是周期性同步，所以环境变量更新后可能不会在 Replica Server 上立即生效，而是有一个延迟。这个延迟时间依赖于配置
`config_sync_interval_ms` 的值，默认是 30 秒。
+* 环境变量的 key 通常使用 `.` 分隔，方便分类。
-Table环境变量具有如下特性：
-* 作为Table的元数据持久化到Zookeeper上。
-* 可以通过命令动态修改，修改成功后会立即更新到Zookeeper上。
-* 通过meta server和replica
server的定期同步消息`config_sync`同步给各个replica生效。由于是定期同步，所以环境变量更新后不会立即生效，而是有一个同步过程，这个过程的时间依赖于配置文件`config_sync_interval_ms`的值，默认是30秒。
-* 环境变量的key通过都是采用`.`分隔的字段的形式，方便组织。
+目前通过 table 环境变量支持的功能如：
+* [Manual-Compact 功能](manual-compact)
+* [Usage-Scenario 功能](usage-scenario)
-目前通过Table环境变量支持的功能包括：
-* [Manual-Compact功能](manual-compact)
-* [Usage-Scenario功能](usage-scenario)
+# 控制命令
-# 操作命令
-Pegasus的[Shell工具](/overview/shell#set_app_envs)中提供了操作Table环境变量的命令。这些命令执行前都需要先执行`use
xxx`选择表。
+Pegasus 的 [Shell 工具](/docs/tools/shell/) 中提供了操作 table 环境变量的命令。这些命令执行前都需要先执行
`use <table_name>` 选择需要操作的表。
## get_app_envs
-获取环境变量列表，用法：`get_app_envs`
-示例：
-```
->>> use temp
-OK
->>> get_app_envs
-get app envs succeed, count = 1
-=================================
-rocksdb.usage_scenario = normal
-=================================
-```
+参考：[`get_app_envs` 命令](/docs/tools/shell/#get_app_envs)
+
## set_app_envs
-设置环境变量，用法：`set_app_envs <key> <value> [key value...]`
-示例：
-```
->>> use temp
-OK
->>> set_app_envs rocksdb.usage_scenario bulk_load
-set app envs succeed
->>> get_app_envs
-get app envs succeed, count = 1
-=================================
-rocksdb.usage_scenario = bulk_load
-=================================
-```
+参考：[`set_app_envs` 命令](/docs/tools/shell/#set_app_envs)
## del_app_envs
-删除环境变量，用法：`del_app_envs <key> [key...]`
-示例：
-```
->>> use temp
-OK
->>> del_app_envs rocksdb.usage_scenario
-del app envs succeed
-=============================
-deleted keys:
- rocksdb.usage_scenario
-=============================
->>> get_app_envs
-get app envs succeed, count = 0
-```
+参考：[`del_app_envs` 命令](/docs/tools/shell/#del_app_envs)
## clear_app_envs
-清理环境变量，或者叫批量删除环境变量，用法：`clear_app_envs <-a|--all> <-p|--prefix str>`
-两种方式：
-* 全部清理：使用`-a`选项。
-* 通过前缀清理：使用`-p`选项指定前缀，匹配时会先自动在前缀后面加上`.`，然后按照字符串前缀匹配。
+参考：[`clear_app_envs` 命令](/docs/tools/shell/#clear_app_envs)
-譬如：
-```
->>> use temp
-OK
->>> set_app_envs k.x v1 k.y v2
-set app envs succeed
->>> get_app_envs
-get app envs succeed, count = 2
-=================================
-k.x = v1
-k.y = v2
-=================================
->>> clear_app_envs -p k
-clear app envs succeed
-=============================
-deleted keys:
- k.x
- k.y
-=============================
->>> get_app_envs
-get app envs succeed, count = 0
-```
+# 支持的环境变量
+
+从 Pegasus 2.6 开始，可通过 Meta Server 的 [HTTP 接口](/api/http) `/envs/list` 获取所有支持的
table 环境变量。
+例如：
-# 支持列表
-
-key名称 | value类型 | value约束 | value示例 | 功能说明 | 支持版本
--- | -- | -- | -- | -- | --
-rocksdb.usage_scenario | string | normal \| prefer_write \| bulk_load |
bulk_load | [Usage-Scenario](usage-scenario) | 1.8.1
-replica.deny_client_write | bool | true \| false | true | 拒绝写请求 | 1.11.2
-replica.write_throttling | string | 特定格式 | 1000\*delay\*100 |
[流量控制#表级流控](throttling#表级流控) | 1.11.2
-replica.write_throttling_by_size | string | 特定格式 | 1000\*delay\*100 |
[流量控制#表级流控](throttling#表级流控) | 1.12.0
-default_ttl | int | >=0 | 86400 | [表级TTL](/api/ttl#表级TTL) | 1.11.2
-manual_compact.disabled | bool | true \| false | true |
[Manual-Compact](manual-compact) | 1.9.0
-manual_compact.max_concurrent_running_count | int | >=0 | 10 |
[Manual-Compact](manual-compact) | 1.11.3
-manual_compact.once.trigger_time | int | Unix Timestamp in Seconds |
1547091115 | [Manual-Compact](manual-compact) | 1.8.1
-manual_compact.once.target_level | int | -1 \| >=1 | 2 |
[Manual-Compact](manual-compact) | 1.8.1
-manual_compact.once.bottommost_level_compaction | string | force \| skip |
force | [Manual-Compact](manual-compact) | 1.8.1
-manual_compact.periodic.trigger_time | string | 特定格式 | 3:00,5:00 |
[Manual-Compact](manual-compact) | 1.8.1
-manual_compact.periodic.target_level | int | -1 \| >=1 | 2 |
[Manual-Compact](manual-compact) | 1.8.1
-manual_compact.periodic.bottommost_level_compaction | string | force \| skip |
force | [Manual-Compact](manual-compact) | 1.8.1
-rocksdb.checkpoint.reserve_min_count | int | >=1 | 2 |
[Rocksdb-Checkpoint管理](resource-management#rocksdb-checkpoint管理) | 1.11.3
-rocksdb.checkpoint.reserve_time_seconds | int | >=0 | 600 |
[Rocksdb-Checkpoint管理](resource-management#rocksdb-checkpoint管理) | 1.11.3
-business.info | string | 特定格式(使用utf-8编码) |
depart=云平台部-存储平台,user=qinzuoyan&wutao1 | 记录表的业务归属信息，可用于生成账单 | -
-replica.slow_query_threshold | int | >=20 | 30 | 慢查询阈值 | 1.12.0
+```
+$ curl 127.0.0.1:34601/envs/list
+{
+ "business.info": {
+ "limitation": "",
+ "sample": "",
+ "type": "string"
+ },
+ "default_ttl": {
+ "limitation": ">= 0",
+ "sample": "86400",
+ "type": "unsigned int32"
+ },
+ "manual_compact.disabled": {
+ "limitation": "true | false",
+ "sample": "true",
+ "type": "bool"
+ },
+ "manual_compact.max_concurrent_running_count": {
+ "limitation": ">= 0",
+ "sample": "8",
+ "type": "unsigned int32"
+ },
+ "manual_compact.once.bottommost_level_compaction": {
+ "limitation": "force | skip",
+ "sample": "skip",
+ "type": "string"
+ },
+ "manual_compact.once.target_level": {
+ "limitation": "-1 or >= 1",
+ "sample": "6",
+ "type": "unsigned int64"
+ },
+ "manual_compact.once.trigger_time": {
+ "limitation": "> 0, timestamp (in seconds) to trigger the once manual
compaction",
+ "sample": "1700000000",
+ "type": "unsigned int64"
+ },
+ "manual_compact.periodic.bottommost_level_compaction": {
+ "limitation": "force | skip",
+ "sample": "skip",
+ "type": "string"
+ },
+ "manual_compact.periodic.target_level": {
+ "limitation": "-1 or >= 1",
+ "sample": "6",
+ "type": "unsigned int64"
+ },
+ "manual_compact.periodic.trigger_time": {
+ "limitation": "",
+ "sample": "",
+ "type": "string"
+ },
+ "replica.backup_request_throttling": {
+ "limitation": "<size[K|M]>*<delay|reject>*<milliseconds>",
+ "sample": "10000*delay*100,20000*reject*100",
+ "type": "string"
+ },
+ "replica.deny_client_request": {
+ "limitation": "timeout*all | timeout*write | timeout*read | reconfig*all |
reconfig*write | reconfig*read",
+ "sample": "timeout*all",
+ "type": "string"
+ },
+ "replica.read_throttling": {
+ "limitation": "<size[K|M]>*<delay|reject>*<milliseconds>",
+ "sample": "10000*delay*100,20000*reject*100",
+ "type": "string"
+ },
+ "replica.read_throttling_by_size": {
+ "limitation": "",
+ "sample": "20000*delay*100,20000*reject*100",
+ "type": "string"
+ },
+ "replica.rocksdb_block_cache_enabled": {
+ "limitation": "true | false",
+ "sample": "true",
+ "type": "bool"
+ },
+ "replica.rocksdb_iteration_threshold_time_ms": {
+ "limitation": ">= 0",
+ "sample": "1000",
+ "type": "unsigned int64"
+ },
+ "replica.slow_query_threshold": {
+ "limitation": ">= 20",
+ "sample": "1000",
+ "type": "unsigned int64"
+ },
+ "replica.split.validate_partition_hash": {
+ "limitation": "true | false",
+ "sample": "true",
+ "type": "bool"
+ },
+ "replica.write_throttling": {
+ "limitation": "<size[K|M]>*<delay|reject>*<milliseconds>",
+ "sample": "10000*delay*100,20000*reject*100",
+ "type": "string"
+ },
+ "replica.write_throttling_by_size": {
+ "limitation": "<size[K|M]>*<delay|reject>*<milliseconds>",
+ "sample": "10000*delay*100,20000*reject*100",
+ "type": "string"
+ },
+ "replica_access_controller.allowed_users": {
+ "limitation": "",
+ "sample": "",
+ "type": "string"
+ },
+ "replica_access_controller.ranger_policies": {
+ "limitation": "",
+ "sample": "",
+ "type": "string"
+ },
+ "rocksdb.allow_ingest_behind": {
+ "limitation": "true | false",
+ "sample": "true",
+ "type": "bool"
+ },
+ "rocksdb.checkpoint.reserve_min_count": {
+ "limitation": "> 0",
+ "sample": "2",
+ "type": "unsigned int32"
+ },
+ "rocksdb.checkpoint.reserve_time_seconds": {
+ "limitation": ">= 0",
+ "sample": "3600",
+ "type": "unsigned int32"
+ },
+ "rocksdb.num_levels": {
+ "limitation": "In range [1, 10]",
+ "sample": "6",
+ "type": "unsigned int64"
+ },
+ "rocksdb.usage_scenario": {
+ "limitation": "bulk_load | normal | prefer_write",
+ "sample": "normal",
+ "type": "string"
+ },
+ "rocksdb.write_buffer_size": {
+ "limitation": "In range [16777216, 536870912]",
+ "sample": "16777216",
+ "type": "unsigned int64"
+ },
+ "user_specified_compaction": {
+ "limitation": "",
+ "sample": "",
+ "type": "string"
+ }
+}
+```
\ No newline at end of file
diff --git a/_docs/zh/tools/shell.md b/_docs/zh/tools/shell.md
index dfea2ed6..891635e4 100755
--- a/_docs/zh/tools/shell.md
+++ b/_docs/zh/tools/shell.md
@@ -505,10 +505,10 @@ USAGE:disk_capacity [-n|--node
replica_server(ip:port)][-o|--out file
| create | 创建表，可加`-p`和`-r`选项指定分片数和副本数，要求分片数是 2 的指数倍，不指定 -r 则默认副本数为
3（推荐值）|
| drop | 删除表，参见[使用 drop
命令删除表](/administration/table-soft-delete#使用drop命令删除表) |
| recall | 恢复已删除的表，参见[使用 recall
命令恢复表](/administration/table-soft-delete#使用recall命令恢复表) |
-| get_app_envs | 获取表的环境变量，参见 [Table
环境变量#get_app_envs](/administration/table-env#get_app_envs) |
-| set_app_envs | 设置表的环境变量，参见 [Table
环境变量#set_app_envs](/administration/table-env#set_app_envs) |
-| del_app_envs | 删除表的环境变量，参见 [Table
环境变量#del_app_envs](/administration/table-env#del_app_envs) |
-| clear_app_envs | 清理表的环境变量，参见 [Table
环境变量#clear_app_envs](/administration/table-env#clear_app_envs) |
+| get_app_envs | 获取表的环境变量 |
+| set_app_envs | 设置表的环境变量 |
+| del_app_envs | 删除表的环境变量 |
+| clear_app_envs | 清理表的环境变量 |
| add_dup | 添加 duplication
的集群，参见[跨机房同步](/administration/duplication) |
| query_dup | 查询表的跨机房同步的集群, 参加[跨机房同步](/administration/duplication)
|
| remove_dup | 移除 duplication 的集群,
参见[跨机房同步](/administration/duplication) |
@@ -685,13 +685,16 @@ USAGE: get_app_envs
说明：
-- 该命令输出当前表的环境变量，使用前请首先使用`use [app_name]`选定特定表，参见
[get_app_envs](/administration/table-env#get_app_envs)。
+- 该命令输出当前表的环境变量，使用前请首先使用`use [app_name]`选定特定表。
示例：
```
>>> use temp
+OK
>>> get_app_envs
+[app_envs]
+rocksdb.usage_scenario : normal
```
### set_app_envs
@@ -706,13 +709,15 @@ USAGE: set_app_envs <key> <value> [key
value...]
说明：
-- 该命令设置当前表的环境变量，使用前请首先使用`use [app_name]`选定特定表，参见
[set_app_envs](/administration/table-env#set_app_envs)。
+- 该命令设置当前表的环境变量，使用前请首先使用`use [app_name]`选定特定表。
示例：
```
>>> use temp
+OK
>>> set_app_envs rocksdb.usage_scenario bulk_load
+set app envs succeed
```
### del_app_envs
@@ -727,13 +732,21 @@ USAGE: del_app_envs <key> [key...]
说明：
-- 该命令删除当前表的环境变量，使用前请首先使用`use [app_name]`选定特定表，参见
[del_app_envs](/administration/table-env#del_app_envs)。
+- 该命令删除当前表的环境变量，使用前请首先使用`use [app_name]`选定特定表。
示例：
```
>>> use temp
+OK
+>>> set_app_envs rocksdb.usage_scenario bulk_load
+set app envs succeed
>>> del_app_envs rocksdb.usage_scenario
+del app envs succeed
+=============================
+deleted keys:
+ rocksdb.usage_scenario
+=============================
```
### clear_app_envs
@@ -748,7 +761,7 @@ USAGE: clear_app_envs [-a|--all] [-p|--prefix
str]
说明：
-- 该命令删除当前表的环境变量，使用前请首先使用`use [app_name]`选定特定表，参见
[clear_app_envs](/administration/table-env#clear_app_envs)。
+- 该命令删除当前表的环境变量，使用前请首先使用`use [app_name]`选定特定表。
- `-a`选项：如果指定，则清理所有的环境变量。
- `-p`选项：如果指定，则可以清理以特定字符串为前缀的环境变量。
@@ -756,7 +769,26 @@ USAGE: clear_app_envs [-a|--all] [-p|--prefix
str]
```
>>> use temp
->>> clear_app_envs -p rocksdb
+OK
+>>> set_app_envs manual_compact.once.trigger_time 1713700000
+set app envs succeed
+>>> set_app_envs manual_compact.once.target_level -1
+set app envs succeed
+>>> set_app_envs manual_compact.once.bottommost_level_compaction force
+set app envs succeed
+>>> set_app_envs rocksdb.usage_scenario bulk_load
+set app envs succeed
+>>> clear_app_envs -p manual_compact
+clear app envs succeed
+=============================
+deleted keys:
+ manual_compact.once.bottommost_level_compaction
+ manual_compact.once.target_level
+ manual_compact.once.trigger_time
+=============================
+>>> get_app_envs
+[app_envs]
+rocksdb.usage_scenario : bulk_load
```
### add_dup
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
