This is an automated email from the ASF dual-hosted git repository.
CritasWang pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iotdb-docs.git
The following commit(s) were added to refs/heads/main by this push:
new b23bedfa Document REST cache parameter deprecation (#1176)
b23bedfa is described below
commit b23bedfad11ea367a2305179c59039ff7cae4d1b
Author: leto-bbq <[email protected]>
AuthorDate: Fri Jul 3 10:01:30 2026 +0800
Document REST cache parameter deprecation (#1176)
---
src/UserGuide/Master/Table/Reference/System-Config-Manual_apache.md | 6 +++---
.../Master/Tree/Reference/DataNode-Config-Manual_apache.md | 6 +++---
src/UserGuide/latest-Table/Reference/System-Config-Manual_apache.md | 6 +++---
src/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md | 6 +++---
.../UserGuide/Master/Table/Reference/System-Config-Manual_apache.md | 6 +++---
.../Master/Tree/Reference/DataNode-Config-Manual_apache.md | 6 +++---
.../UserGuide/latest-Table/Reference/System-Config-Manual_apache.md | 6 +++---
src/zh/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md | 6 +++---
8 files changed, 24 insertions(+), 24 deletions(-)
diff --git
a/src/UserGuide/Master/Table/Reference/System-Config-Manual_apache.md
b/src/UserGuide/Master/Table/Reference/System-Config-Manual_apache.md
index d5a7bc7e..7e5defdc 100644
--- a/src/UserGuide/Master/Table/Reference/System-Config-Manual_apache.md
+++ b/src/UserGuide/Master/Table/Reference/System-Config-Manual_apache.md
@@ -859,7 +859,7 @@ The `iotdb-system.properties` file contains various
configurations for managing
| Name | cache_expire_in_seconds |
| ----------- | ------------------------------------------------------------ |
-| Description | The expiration time of the user login information cache (in
seconds) |
+| Description | The expiration time of the user login information cache (in
seconds). This parameter will be deprecated after V2.0.8. |
| Type | int32 |
| Default | 28800 |
| Effective | Restart required. |
@@ -868,7 +868,7 @@ The `iotdb-system.properties` file contains various
configurations for managing
| Name | cache_max_num |
| ----------- | ------------------------------------------------------------ |
-| Description | The maximum number of users can be stored in the user login
cache. |
+| Description | The maximum number of users can be stored in the user login
cache. This parameter will be deprecated after V2.0.8. |
| Type | int32 |
| Default | 100 |
| Effective | Restart required. |
@@ -877,7 +877,7 @@ The `iotdb-system.properties` file contains various
configurations for managing
| Name | cache_init_num |
| ----------- | ------------------------------------------------------------ |
-| Description | The initial capacity of users can be stored in the user login
cache. |
+| Description | The initial capacity of users can be stored in the user login
cache. This parameter will be deprecated after V2.0.8. |
| Type | int32 |
| Default | 10 |
| Effective | Restart required. |
diff --git
a/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md
b/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md
index fc65cf4d..6c49cd33 100644
--- a/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md
+++ b/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md
@@ -495,7 +495,7 @@ There will be at most 10 gc.log.* files and each one can
reach to 10MB.
|Name| cache\_expire |
|:---:|:--------------------------------------------------------|
-|Description| Expiration time for caching customer login information |
+|Description| Expiration time for caching customer login information. This
parameter will be deprecated after V2.0.8. |
|Type| int32 |
|Default| 28800 |
|Effective| After restarting system |
@@ -504,7 +504,7 @@ There will be at most 10 gc.log.* files and each one can
reach to 10MB.
|Name| cache\_max\_num |
|:---:|:--------------|
-|Description| The maximum number of users stored in the cache |
+|Description| The maximum number of users stored in the cache. This parameter
will be deprecated after V2.0.8. |
|Type| int32 |
|Default| 100 |
|Effective| After restarting system |
@@ -513,7 +513,7 @@ There will be at most 10 gc.log.* files and each one can
reach to 10MB.
|Name| cache\_init\_num |
|:---:|:---------------|
-|Description| Initial cache capacity |
+|Description| Initial cache capacity. This parameter will be deprecated after
V2.0.8. |
|Type| int32 |
|Default| 10 |
|Effective| After restarting system |
diff --git
a/src/UserGuide/latest-Table/Reference/System-Config-Manual_apache.md
b/src/UserGuide/latest-Table/Reference/System-Config-Manual_apache.md
index d5a7bc7e..7e5defdc 100644
--- a/src/UserGuide/latest-Table/Reference/System-Config-Manual_apache.md
+++ b/src/UserGuide/latest-Table/Reference/System-Config-Manual_apache.md
@@ -859,7 +859,7 @@ The `iotdb-system.properties` file contains various
configurations for managing
| Name | cache_expire_in_seconds |
| ----------- | ------------------------------------------------------------ |
-| Description | The expiration time of the user login information cache (in
seconds) |
+| Description | The expiration time of the user login information cache (in
seconds). This parameter will be deprecated after V2.0.8. |
| Type | int32 |
| Default | 28800 |
| Effective | Restart required. |
@@ -868,7 +868,7 @@ The `iotdb-system.properties` file contains various
configurations for managing
| Name | cache_max_num |
| ----------- | ------------------------------------------------------------ |
-| Description | The maximum number of users can be stored in the user login
cache. |
+| Description | The maximum number of users can be stored in the user login
cache. This parameter will be deprecated after V2.0.8. |
| Type | int32 |
| Default | 100 |
| Effective | Restart required. |
@@ -877,7 +877,7 @@ The `iotdb-system.properties` file contains various
configurations for managing
| Name | cache_init_num |
| ----------- | ------------------------------------------------------------ |
-| Description | The initial capacity of users can be stored in the user login
cache. |
+| Description | The initial capacity of users can be stored in the user login
cache. This parameter will be deprecated after V2.0.8. |
| Type | int32 |
| Default | 10 |
| Effective | Restart required. |
diff --git a/src/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md
b/src/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md
index fc65cf4d..6c49cd33 100644
--- a/src/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md
+++ b/src/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md
@@ -495,7 +495,7 @@ There will be at most 10 gc.log.* files and each one can
reach to 10MB.
|Name| cache\_expire |
|:---:|:--------------------------------------------------------|
-|Description| Expiration time for caching customer login information |
+|Description| Expiration time for caching customer login information. This
parameter will be deprecated after V2.0.8. |
|Type| int32 |
|Default| 28800 |
|Effective| After restarting system |
@@ -504,7 +504,7 @@ There will be at most 10 gc.log.* files and each one can
reach to 10MB.
|Name| cache\_max\_num |
|:---:|:--------------|
-|Description| The maximum number of users stored in the cache |
+|Description| The maximum number of users stored in the cache. This parameter
will be deprecated after V2.0.8. |
|Type| int32 |
|Default| 100 |
|Effective| After restarting system |
@@ -513,7 +513,7 @@ There will be at most 10 gc.log.* files and each one can
reach to 10MB.
|Name| cache\_init\_num |
|:---:|:---------------|
-|Description| Initial cache capacity |
+|Description| Initial cache capacity. This parameter will be deprecated after
V2.0.8. |
|Type| int32 |
|Default| 10 |
|Effective| After restarting system |
diff --git
a/src/zh/UserGuide/Master/Table/Reference/System-Config-Manual_apache.md
b/src/zh/UserGuide/Master/Table/Reference/System-Config-Manual_apache.md
index 0d3fb886..8e1cf717 100644
--- a/src/zh/UserGuide/Master/Table/Reference/System-Config-Manual_apache.md
+++ b/src/zh/UserGuide/Master/Table/Reference/System-Config-Manual_apache.md
@@ -836,7 +836,7 @@ IoTDB 配置文件位于 IoTDB 安装目录:`conf`文件夹下。
| 名字 | cache_expire_in_seconds |
| ------------ | -------------------------------- |
-| 描述 | 用户登录信息缓存的过期时间(秒) |
+| 描述 | 用户登录信息缓存的过期时间(秒)。V2.0.8 版本之后将作废该参数。 |
| 类型 | int32 |
| 默认值 | 28800 |
| 改后生效方式 | 重启服务生效 |
@@ -845,7 +845,7 @@ IoTDB 配置文件位于 IoTDB 安装目录:`conf`文件夹下。
| 名字 | cache_max_num |
| ------------ | ------------------------ |
-| 描述 | 缓存中存储的最大用户数量 |
+| 描述 | 缓存中存储的最大用户数量。V2.0.8 版本之后将作废该参数。 |
| 类型 | int32 |
| 默认值 | 100 |
| 改后生效方式 | 重启服务生效 |
@@ -854,7 +854,7 @@ IoTDB 配置文件位于 IoTDB 安装目录:`conf`文件夹下。
| 名字 | cache_init_num |
| ------------ | -------------- |
-| 描述 | 缓存初始容量 |
+| 描述 | 缓存初始容量。V2.0.8 版本之后将作废该参数。 |
| 类型 | int32 |
| 默认值 | 10 |
| 改后生效方式 | 重启服务生效 |
diff --git
a/src/zh/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md
b/src/zh/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md
index 8ba41328..b96c8473 100644
--- a/src/zh/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md
+++ b/src/zh/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md
@@ -489,7 +489,7 @@ GC 日志会被存储在`IOTDB_HOME/logs/gc.log`. 至多会存储 10 个 gc.log
|名字| cache\_expire |
|:---:|:--------------|
-|描述| 缓存客户登录信息的过期时间 |
+|描述| 缓存客户登录信息的过期时间。V2.0.8 版本之后将作废该参数。 |
|类型| int32 |
|默认值| 28800 |
|改后生效方式| 重启生效 |
@@ -498,7 +498,7 @@ GC 日志会被存储在`IOTDB_HOME/logs/gc.log`. 至多会存储 10 个 gc.log
|名字| cache\_max\_num |
|:---:|:--------------|
-|描述| 缓存中存储的最大用户数量 |
+|描述| 缓存中存储的最大用户数量。V2.0.8 版本之后将作废该参数。 |
|类型| int32 |
|默认值| 100 |
|改后生效方式| 重启生效 |
@@ -507,7 +507,7 @@ GC 日志会被存储在`IOTDB_HOME/logs/gc.log`. 至多会存储 10 个 gc.log
|名字| cache\_init\_num |
|:---:|:---------------|
-|描述| 缓存初始容量 |
+|描述| 缓存初始容量。V2.0.8 版本之后将作废该参数。 |
|类型| int32 |
|默认值| 10 |
|改后生效方式| 重启生效 |
diff --git
a/src/zh/UserGuide/latest-Table/Reference/System-Config-Manual_apache.md
b/src/zh/UserGuide/latest-Table/Reference/System-Config-Manual_apache.md
index 0d3fb886..8e1cf717 100644
--- a/src/zh/UserGuide/latest-Table/Reference/System-Config-Manual_apache.md
+++ b/src/zh/UserGuide/latest-Table/Reference/System-Config-Manual_apache.md
@@ -836,7 +836,7 @@ IoTDB 配置文件位于 IoTDB 安装目录:`conf`文件夹下。
| 名字 | cache_expire_in_seconds |
| ------------ | -------------------------------- |
-| 描述 | 用户登录信息缓存的过期时间(秒) |
+| 描述 | 用户登录信息缓存的过期时间(秒)。V2.0.8 版本之后将作废该参数。 |
| 类型 | int32 |
| 默认值 | 28800 |
| 改后生效方式 | 重启服务生效 |
@@ -845,7 +845,7 @@ IoTDB 配置文件位于 IoTDB 安装目录:`conf`文件夹下。
| 名字 | cache_max_num |
| ------------ | ------------------------ |
-| 描述 | 缓存中存储的最大用户数量 |
+| 描述 | 缓存中存储的最大用户数量。V2.0.8 版本之后将作废该参数。 |
| 类型 | int32 |
| 默认值 | 100 |
| 改后生效方式 | 重启服务生效 |
@@ -854,7 +854,7 @@ IoTDB 配置文件位于 IoTDB 安装目录:`conf`文件夹下。
| 名字 | cache_init_num |
| ------------ | -------------- |
-| 描述 | 缓存初始容量 |
+| 描述 | 缓存初始容量。V2.0.8 版本之后将作废该参数。 |
| 类型 | int32 |
| 默认值 | 10 |
| 改后生效方式 | 重启服务生效 |
diff --git a/src/zh/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md
b/src/zh/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md
index 8ba41328..b96c8473 100644
--- a/src/zh/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md
+++ b/src/zh/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md
@@ -489,7 +489,7 @@ GC 日志会被存储在`IOTDB_HOME/logs/gc.log`. 至多会存储 10 个 gc.log
|名字| cache\_expire |
|:---:|:--------------|
-|描述| 缓存客户登录信息的过期时间 |
+|描述| 缓存客户登录信息的过期时间。V2.0.8 版本之后将作废该参数。 |
|类型| int32 |
|默认值| 28800 |
|改后生效方式| 重启生效 |
@@ -498,7 +498,7 @@ GC 日志会被存储在`IOTDB_HOME/logs/gc.log`. 至多会存储 10 个 gc.log
|名字| cache\_max\_num |
|:---:|:--------------|
-|描述| 缓存中存储的最大用户数量 |
+|描述| 缓存中存储的最大用户数量。V2.0.8 版本之后将作废该参数。 |
|类型| int32 |
|默认值| 100 |
|改后生效方式| 重启生效 |
@@ -507,7 +507,7 @@ GC 日志会被存储在`IOTDB_HOME/logs/gc.log`. 至多会存储 10 个 gc.log
|名字| cache\_init\_num |
|:---:|:---------------|
-|描述| 缓存初始容量 |
+|描述| 缓存初始容量。V2.0.8 版本之后将作废该参数。 |
|类型| int32 |
|默认值| 10 |
|改后生效方式| 重启生效 |