This is an automated email from the ASF dual-hosted git repository.
HTHou 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 d2d0f81e Update tiered storage required parameters (#1148)
d2d0f81e is described below
commit d2d0f81e5945ecee3d6f605e551fe10d417a2c3a
Author: leto-b <[email protected]>
AuthorDate: Tue Jun 9 11:57:34 2026 +0800
Update tiered storage required parameters (#1148)
* Update tiered storage required parameters
* Remove redundant configuration notes from constraints
---
.../Table/User-Manual/Tiered-Storage_timecho.md | 30 +++++++++++-----------
.../Tree/User-Manual/Tiered-Storage_timecho.md | 30 +++++++++++-----------
.../User-Manual/Tiered-Storage_timecho.md | 30 +++++++++++-----------
.../latest/User-Manual/Tiered-Storage_timecho.md | 30 +++++++++++-----------
.../Table/User-Manual/Tiered-Storage_timecho.md | 30 +++++++++++-----------
.../Tree/User-Manual/Tiered-Storage_timecho.md | 30 +++++++++++-----------
.../User-Manual/Tiered-Storage_timecho.md | 30 +++++++++++-----------
.../latest/User-Manual/Tiered-Storage_timecho.md | 30 +++++++++++-----------
8 files changed, 120 insertions(+), 120 deletions(-)
diff --git a/src/UserGuide/Master/Table/User-Manual/Tiered-Storage_timecho.md
b/src/UserGuide/Master/Table/User-Manual/Tiered-Storage_timecho.md
index 9ffa9dd8..0fe24c1f 100644
--- a/src/UserGuide/Master/Table/User-Manual/Tiered-Storage_timecho.md
+++ b/src/UserGuide/Master/Table/User-Manual/Tiered-Storage_timecho.md
@@ -36,21 +36,21 @@ To enable multi-level storage in IoTDB, the following
configurations are require
The specific parameter definitions and their descriptions are as follows.
-| **Parameter**
| **Default Value** | **Description**
| **Constraints**
[...]
-|:---------------------------------------------------------------------------------------------------|
:-------------------------
|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| `dn_data_dirs`
| `data/datanode/data` | Specifies storage
directories grouped into tiers.
| Tiers are separated by `;`, directories
within the same tier are separated by `,`. <br>Cloud storage (e.g., AWS S3) can
only be the last tier. <br [...]
-| `tier_ttl_in_ms`
| `-1` | Defines the TTL (in
milliseconds) for each tier to determine the data range it manages.
| Tiers are separated by `;`. <br>The number of
tiers must match `dn_data_dirs`. <br>`-1` means "no limit".
[...]
-| `dn_default_space_usage_thresholds`
| `0.85` | Define the maximum storage
usage threshold ratio for each tier of data directories. When the used space
exceeds this ratio, the data will be automatically migrated to the next tier.
If the storage usage of the last tier surpasses this threshold, the system will
be set to READ_ONLY mode. | -Tiers are separated by `;`.The number of tiers
must match `dn_dat [...]
-| `object_storage_type`
| `AWS_S3` | Cloud storage type.
| all `AWS_S3` is supported.
[...]
-| `object_storage_bucket`
| `iotdb_data` | Cloud storage bucket name.
| Required only if cloud storage is used.
[...]
-| `object_storage_endpoint`
| (Empty) | Cloud storage endpoint.
| Required only if cloud storage is used.
[...]
-| `object_storage_region`
| (Empty) | Cloud storage Region.
| Required only if cloud storage is used.
[...]
-| `object_storage_access_key`
| (Empty) | Cloud storage access key.
| Required only if cloud storage is used.
[...]
-| `object_storage_access_secret`
| (Empty) | Cloud storage access
secret.
| Required only if cloud storage is used.
[...]
-| `enable_path_style_access`
| false | Whether to enable path style
access for object storage service.
| Required only if cloud
storage is used.
[...]
-| `remote_tsfile_cache_dirs`
| `data/datanode/data/cache` | Local cache directory for
cloud storage.
| Required only if cloud storage is used.
[...]
-| `remote_tsfile_cache_page_size_in_kb`
| `20480` | Page size (in KB) for
cloud storage local cache.
| Required only if cloud storage is used.
[...]
-| `remote_tsfile_cache_max_disk_usage_in_mb`
| `51200` | Maximum disk space (in MB)
allocated for cloud storage local cache.
| Required only if cloud storage is used.
[...]
+| **Parameter** | **Default Value** | **Required** | **Description** |
**Constraints** |
+|
:---------------------------------------------------------------------------------------------------
| :------------------------- | --- |
:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
:---------------------------------------------------------------------------------------------------------------------------------------
[...]
+| `dn_data_dirs` | `data/datanode/data` | Yes | Specifies storage directories
grouped into tiers. | Tiers are separated by `;`, directories within the same
tier are separated by `,`. <br>Cloud storage (e.g., AWS S3) can only be the
last tier. <br>Use `OBJECT_STORAGE` to denote cloud storage. <br>Only one cloud
storage bucket is allowed. |
+| `tier_ttl_in_ms` | `-1` | Yes | Defines the TTL (in milliseconds) for each
tier to determine the data range it manages. | Tiers are separated by `;`.
<br>The number of tiers must match `dn_data_dirs`. <br>`-1` means "no limit". |
+| `dn_default_space_usage_thresholds` | `0.85` | Yes | Define the maximum
storage usage threshold ratio for each tier of data directories. When the used
space exceeds this ratio, the data will be automatically migrated to the next
tier. If the storage usage of the last tier surpasses this threshold, the
system will be set to READ_ONLY mode. | -Tiers are separated by `;`.The
number of tiers must match `dn_data_dirs`. |
+| `object_storage_type` | `AWS_S3` | Required when using remote storage |
Cloud storage type. | all `AWS_S3` is supported. |
+| `object_storage_bucket` | `iotdb_data` | Required when using remote storage
| Cloud storage bucket name. | |
+| `object_storage_endpoint` | (Empty) | Required when using remote storage |
Cloud storage endpoint. | |
+| `object_storage_region` | (Empty) | Required when using remote storage |
Cloud storage Region. | |
+| `object_storage_access_key` | (Empty) | Required when using remote storage |
Cloud storage access key. | |
+| `object_storage_access_secret` | (Empty) | Required when using remote
storage | Cloud storage access secret. | |
+| `enable_path_style_access` | false | No | Whether to enable path style
access for object storage service. | |
+| `remote_tsfile_cache_dirs` | `data/datanode/data/cache` | No | Local cache
directory for cloud storage. | |
+| `remote_tsfile_cache_page_size_in_kb` | `20480` | No | Page size (in KB) for
cloud storage local cache. | |
+| `remote_tsfile_cache_max_disk_usage_in_mb` | `51200` | No | Maximum disk
space (in MB) allocated for cloud storage local cache. | |
## 3. Local Tiered Storage Example
diff --git a/src/UserGuide/Master/Tree/User-Manual/Tiered-Storage_timecho.md
b/src/UserGuide/Master/Tree/User-Manual/Tiered-Storage_timecho.md
index 3f081627..5d4c4a1d 100644
--- a/src/UserGuide/Master/Tree/User-Manual/Tiered-Storage_timecho.md
+++ b/src/UserGuide/Master/Tree/User-Manual/Tiered-Storage_timecho.md
@@ -34,21 +34,21 @@ To enable tiered storage in IoTDB, you need to configure
the following aspects:
The specific parameter definitions and their descriptions are as follows.
-| Configuration | Default
| Description |
Constraint |
-| --------------------------------------- | ------------------------ |
------------------------------------------------------------ |
------------------------------------------------------------ |
-| dn_data_dirs | data/datanode/data
| specify different storage directories and divide the storage
directories into tiers | Each level of storage uses a semicolon to
separate, and commas to separate within a single level; cloud (OBJECT_STORAGE)
configuration can only be used as the last level of storage and the first level
can't be used as cloud storage; a cloud object at most; the remote storage
directory is denoted by OBJECT [...]
-| tier_ttl_in_ms | -1 | Define
the maximum age of data for which each tier is responsible |
Each level of storage is separated by a semicolon; the number of levels should
match the number of levels defined by dn_data_dirs;"-1" means "unlimited". |
-| dn_default_space_usage_thresholds | 0.85 | Define
the maximum storage usage threshold ratio for each tier of data directories.
When the used space exceeds this ratio, the data will be automatically migrated
to the next tier. If the storage usage of the last tier surpasses this
threshold, the system will be set to READ_ONLY mode. | Each level of
storage is separated by a semicolon; the number of levels should match the
number of levels defined by dn_data_dirs |
-| object_storage_type | `AWS_S3` | Cloud
storage type. | all `AWS_S3` is supported.
|
-| object_storage_bucket | iotdb_data
| Name of cloud storage bucket | Bucket
definition in AWS S3; no need to configure if remote storage is not used
|
-| object_storage_endpoint | |
endpoint of cloud storage | endpoint
of AWS S3;If remote storage is not used, no configuration required |
-| object_storage_region | (Empty) | Cloud
storage Region. | Required only if cloud storage is used.
|
-| object_storage_access_key | |
Authentication information stored in the cloud: key
| AWS S3 credential key;If remote storage is not used, no
configuration required |
-| object_storage_access_secret | |
Authentication information stored in the cloud: secret
| AWS S3 credential secret;If remote storage is not used, no
configuration required |
-| enable_path_style_access | false | Whether to
enable path style access for object storage service. | Required only if
cloud storage is used. |
-| remote_tsfile_cache_dirs | data/datanode/data/cache | Cache
directory stored locally in the cloud | If
remote storage is not used, no configuration required
|
-| remote_tsfile_cache_page_size_in_kb | 20480 |Block
size of locally cached files stored in the cloud
| If remote storage is not used, no configuration required
|
-| remote_tsfile_cache_max_disk_usage_in_mb | 51200 |
Maximum Disk Occupancy Size for Cloud Storage Local Cache
| If remote storage is not used, no configuration required
|
+| Configuration | Default | Required | Description | Constraint |
+| --------------------------------------- | ------------------------ | --- |
------------------------------------------------------------ |
------------------------------------------------------------ |
+| dn_data_dirs | data/datanode/data | Yes | specify different storage
directories and divide the storage directories into tiers | Each level of
storage uses a semicolon to separate, and commas to separate within a single
level; cloud (OBJECT_STORAGE) configuration can only be used as the last level
of storage and the first level can't be used as cloud storage; a cloud object
at most; the remote storage directory is denoted by OBJECT_STORAGE |
+| tier_ttl_in_ms | -1 | Yes | Define the maximum age of data for which each
tier is responsible | Each level of storage is separated by a semicolon; the
number of levels should match the number of levels defined by dn_data_dirs;"-1"
means "unlimited". |
+| dn_default_space_usage_thresholds | 0.85 | Yes | Define the maximum storage
usage threshold ratio for each tier of data directories. When the used space
exceeds this ratio, the data will be automatically migrated to the next tier.
If the storage usage of the last tier surpasses this threshold, the system will
be set to READ_ONLY mode. | Each level of storage is separated by a
semicolon; the number of levels should match the number of levels defined by
dn_data_dirs |
+| object_storage_type | `AWS_S3` | Required when using remote storage | Cloud
storage type. | all `AWS_S3` is supported. |
+| object_storage_bucket | iotdb_data | Required when using remote storage |
Name of cloud storage bucket | Bucket definition in AWS S3 |
+| object_storage_endpoint | | Required when using remote storage | endpoint
of cloud storage | endpoint of AWS S3 |
+| object_storage_region | (Empty) | Required when using remote storage | Cloud
storage Region. | |
+| object_storage_access_key | | Required when using remote storage |
Authentication information stored in the cloud: key | AWS S3 credential key |
+| object_storage_access_secret | | Required when using remote storage |
Authentication information stored in the cloud: secret | AWS S3 credential
secret |
+| enable_path_style_access | false | No | Whether to enable path style access
for object storage service. | |
+| remote_tsfile_cache_dirs | data/datanode/data/cache | No | Cache directory
stored locally in the cloud | |
+| remote_tsfile_cache_page_size_in_kb | 20480 | No | Block size of locally
cached files stored in the cloud | |
+| remote_tsfile_cache_max_disk_usage_in_mb | 51200 | No | Maximum Disk
Occupancy Size for Cloud Storage Local Cache | |
## 3. local tiered storag configuration example
diff --git a/src/UserGuide/latest-Table/User-Manual/Tiered-Storage_timecho.md
b/src/UserGuide/latest-Table/User-Manual/Tiered-Storage_timecho.md
index c6d06a5b..36d72f18 100644
--- a/src/UserGuide/latest-Table/User-Manual/Tiered-Storage_timecho.md
+++ b/src/UserGuide/latest-Table/User-Manual/Tiered-Storage_timecho.md
@@ -36,21 +36,21 @@ To enable multi-level storage in IoTDB, the following
configurations are require
The specific parameter definitions and their descriptions are as follows.
-| **Parameter** | **Default Value** |
**Description**
| **Constraints**
[...]
-|:-------------------------------------------| :-------------------------
|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| `dn_data_dirs` | `data/datanode/data` |
Specifies storage directories grouped into tiers.
| Tiers are separated by
`;`, directories within the same tier are separated by `,`. <br>Cloud storage
(e.g., AWS S3) can only be the last tier. <br>Use `OBJECT_STORAGE` to denote
cloud storage. <br>Only [...]
-| `tier_ttl_in_ms` | `-1` |
Defines the TTL (in milliseconds) for each tier to determine the data range it
manages.
| Tiers are separated by
`;`. <br>The number of tiers must match `dn_data_dirs`. <br>`-1` means "no
limit".
[...]
-| `dn_default_space_usage_thresholds` | `0.85` |
Define the maximum storage usage threshold ratio for each tier of data
directories. When the used space exceeds this ratio, the data will be
automatically migrated to the next tier. If the storage usage of the last tier
surpasses this threshold, the system will be set to READ_ONLY mode. |
-Tiers are separated by `;`.The number of tiers must match `dn_data_dirs`.
[...]
-| `object_storage_type` | `AWS_S3` |
Cloud storage type.
| all `AWS_S3` is
supported.
[...]
-| `object_storage_bucket` | `iotdb_data` |
Cloud storage bucket name.
| Required only if cloud
storage is used.
[...]
-| `object_storage_endpoint` | (Empty) |
Cloud storage endpoint.
| Required only if cloud
storage is used.
[...]
-| `object_storage_region` | (Empty) |
Cloud storage Region.
| Required only if cloud
storage is used.
[...]
-| `object_storage_access_key` | (Empty) |
Cloud storage access key.
| Required only if cloud
storage is used.
[...]
-| `object_storage_access_secret` | (Empty) |
Cloud storage access secret.
| Required only if cloud
storage is used.
[...]
-| `enable_path_style_access` | false |
Whether to enable path style access for object storage service.
| Required only if cloud storage is used.
[...]
-| `remote_tsfile_cache_dirs` | `data/datanode/data/cache` |
Local cache directory for cloud storage.
| Required only if cloud
storage is used.
[...]
-| `remote_tsfile_cache_page_size_in_kb` | `20480` |
Page size (in KB) for cloud storage local cache.
| Required only if cloud
storage is used.
[...]
-| `remote_tsfile_cache_max_disk_usage_in_mb` | `51200` |
Maximum disk space (in MB) allocated for cloud storage local cache.
| Required only if cloud
storage is used.
[...]
+| **Parameter** | **Default Value** | **Required** | **Description** |
**Constraints** |
+| :------------------------------------------- | :------------------------- |
--- |
:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
+| `dn_data_dirs` | `data/datanode/data` | Yes | Specifies storage directories
grouped into tiers. | Tiers are separated by `;`, directories within the same
tier are separated by `,`. <br>Cloud storage (e.g., AWS S3) can only be the
last tier. <br>Use `OBJECT_STORAGE` to denote cloud storage. <br>Only one cloud
storage bucket is allowed. |
+| `tier_ttl_in_ms` | `-1` | Yes | Defines the TTL (in milliseconds) for each
tier to determine the data range it manages. | Tiers are separated by `;`.
<br>The number of tiers must match `dn_data_dirs`. <br>`-1` means "no limit". |
+| `dn_default_space_usage_thresholds` | `0.85` | Yes | Define the maximum
storage usage threshold ratio for each tier of data directories. When the used
space exceeds this ratio, the data will be automatically migrated to the next
tier. If the storage usage of the last tier surpasses this threshold, the
system will be set to READ_ONLY mode. | -Tiers are separated by `;`.The
number of tiers must match `dn_data_dirs`. |
+| `object_storage_type` | `AWS_S3` | Required when using remote storage |
Cloud storage type. | all `AWS_S3` is supported. |
+| `object_storage_bucket` | `iotdb_data` | Required when using remote storage
| Cloud storage bucket name. | |
+| `object_storage_endpoint` | (Empty) | Required when using remote storage |
Cloud storage endpoint. | |
+| `object_storage_region` | (Empty) | Required when using remote storage |
Cloud storage Region. | |
+| `object_storage_access_key` | (Empty) | Required when using remote storage |
Cloud storage access key. | |
+| `object_storage_access_secret` | (Empty) | Required when using remote
storage | Cloud storage access secret. | |
+| `enable_path_style_access` | false | No | Whether to enable path style
access for object storage service. | |
+| `remote_tsfile_cache_dirs` | `data/datanode/data/cache` | No | Local cache
directory for cloud storage. | |
+| `remote_tsfile_cache_page_size_in_kb` | `20480` | No | Page size (in KB) for
cloud storage local cache. | |
+| `remote_tsfile_cache_max_disk_usage_in_mb` | `51200` | No | Maximum disk
space (in MB) allocated for cloud storage local cache. | |
## 3. Local Tiered Storage Example
diff --git a/src/UserGuide/latest/User-Manual/Tiered-Storage_timecho.md
b/src/UserGuide/latest/User-Manual/Tiered-Storage_timecho.md
index 3f081627..5d4c4a1d 100644
--- a/src/UserGuide/latest/User-Manual/Tiered-Storage_timecho.md
+++ b/src/UserGuide/latest/User-Manual/Tiered-Storage_timecho.md
@@ -34,21 +34,21 @@ To enable tiered storage in IoTDB, you need to configure
the following aspects:
The specific parameter definitions and their descriptions are as follows.
-| Configuration | Default
| Description |
Constraint |
-| --------------------------------------- | ------------------------ |
------------------------------------------------------------ |
------------------------------------------------------------ |
-| dn_data_dirs | data/datanode/data
| specify different storage directories and divide the storage
directories into tiers | Each level of storage uses a semicolon to
separate, and commas to separate within a single level; cloud (OBJECT_STORAGE)
configuration can only be used as the last level of storage and the first level
can't be used as cloud storage; a cloud object at most; the remote storage
directory is denoted by OBJECT [...]
-| tier_ttl_in_ms | -1 | Define
the maximum age of data for which each tier is responsible |
Each level of storage is separated by a semicolon; the number of levels should
match the number of levels defined by dn_data_dirs;"-1" means "unlimited". |
-| dn_default_space_usage_thresholds | 0.85 | Define
the maximum storage usage threshold ratio for each tier of data directories.
When the used space exceeds this ratio, the data will be automatically migrated
to the next tier. If the storage usage of the last tier surpasses this
threshold, the system will be set to READ_ONLY mode. | Each level of
storage is separated by a semicolon; the number of levels should match the
number of levels defined by dn_data_dirs |
-| object_storage_type | `AWS_S3` | Cloud
storage type. | all `AWS_S3` is supported.
|
-| object_storage_bucket | iotdb_data
| Name of cloud storage bucket | Bucket
definition in AWS S3; no need to configure if remote storage is not used
|
-| object_storage_endpoint | |
endpoint of cloud storage | endpoint
of AWS S3;If remote storage is not used, no configuration required |
-| object_storage_region | (Empty) | Cloud
storage Region. | Required only if cloud storage is used.
|
-| object_storage_access_key | |
Authentication information stored in the cloud: key
| AWS S3 credential key;If remote storage is not used, no
configuration required |
-| object_storage_access_secret | |
Authentication information stored in the cloud: secret
| AWS S3 credential secret;If remote storage is not used, no
configuration required |
-| enable_path_style_access | false | Whether to
enable path style access for object storage service. | Required only if
cloud storage is used. |
-| remote_tsfile_cache_dirs | data/datanode/data/cache | Cache
directory stored locally in the cloud | If
remote storage is not used, no configuration required
|
-| remote_tsfile_cache_page_size_in_kb | 20480 |Block
size of locally cached files stored in the cloud
| If remote storage is not used, no configuration required
|
-| remote_tsfile_cache_max_disk_usage_in_mb | 51200 |
Maximum Disk Occupancy Size for Cloud Storage Local Cache
| If remote storage is not used, no configuration required
|
+| Configuration | Default | Required | Description | Constraint |
+| --------------------------------------- | ------------------------ | --- |
------------------------------------------------------------ |
------------------------------------------------------------ |
+| dn_data_dirs | data/datanode/data | Yes | specify different storage
directories and divide the storage directories into tiers | Each level of
storage uses a semicolon to separate, and commas to separate within a single
level; cloud (OBJECT_STORAGE) configuration can only be used as the last level
of storage and the first level can't be used as cloud storage; a cloud object
at most; the remote storage directory is denoted by OBJECT_STORAGE |
+| tier_ttl_in_ms | -1 | Yes | Define the maximum age of data for which each
tier is responsible | Each level of storage is separated by a semicolon; the
number of levels should match the number of levels defined by dn_data_dirs;"-1"
means "unlimited". |
+| dn_default_space_usage_thresholds | 0.85 | Yes | Define the maximum storage
usage threshold ratio for each tier of data directories. When the used space
exceeds this ratio, the data will be automatically migrated to the next tier.
If the storage usage of the last tier surpasses this threshold, the system will
be set to READ_ONLY mode. | Each level of storage is separated by a
semicolon; the number of levels should match the number of levels defined by
dn_data_dirs |
+| object_storage_type | `AWS_S3` | Required when using remote storage | Cloud
storage type. | all `AWS_S3` is supported. |
+| object_storage_bucket | iotdb_data | Required when using remote storage |
Name of cloud storage bucket | Bucket definition in AWS S3 |
+| object_storage_endpoint | | Required when using remote storage | endpoint
of cloud storage | endpoint of AWS S3 |
+| object_storage_region | (Empty) | Required when using remote storage | Cloud
storage Region. | |
+| object_storage_access_key | | Required when using remote storage |
Authentication information stored in the cloud: key | AWS S3 credential key |
+| object_storage_access_secret | | Required when using remote storage |
Authentication information stored in the cloud: secret | AWS S3 credential
secret |
+| enable_path_style_access | false | No | Whether to enable path style access
for object storage service. | |
+| remote_tsfile_cache_dirs | data/datanode/data/cache | No | Cache directory
stored locally in the cloud | |
+| remote_tsfile_cache_page_size_in_kb | 20480 | No | Block size of locally
cached files stored in the cloud | |
+| remote_tsfile_cache_max_disk_usage_in_mb | 51200 | No | Maximum Disk
Occupancy Size for Cloud Storage Local Cache | |
## 3. local tiered storag configuration example
diff --git
a/src/zh/UserGuide/Master/Table/User-Manual/Tiered-Storage_timecho.md
b/src/zh/UserGuide/Master/Table/User-Manual/Tiered-Storage_timecho.md
index b982596b..86c183dc 100644
--- a/src/zh/UserGuide/Master/Table/User-Manual/Tiered-Storage_timecho.md
+++ b/src/zh/UserGuide/Master/Table/User-Manual/Tiered-Storage_timecho.md
@@ -34,21 +34,21 @@
具体的参数定义及其描述如下。
-| 配置项 | 默认值 | 说明
| 约束
|
-| --------------------------------------- | ------------------------ |
------------------------------------------------------------ |
------------------------------------------------------------ |
-| dn_data_dirs | data/datanode/data
| 用来指定不同的存储目录,并将存储目录进行层级划分 |
每级存储使用分号分隔,单级内使用逗号分隔;云端配置只能作为最后一级存储且第一级不能作为云端存储;最多配置一个云端对象;远端存储目录使用
OBJECT_STORAGE 来表示 |
-| tier_ttl_in_ms | -1 |
定义每个层级负责的数据范围,通过 TTL 表示 | 每级存储使用分号分隔;层级数量需与 dn_data_dirs
定义的层级数一致;"-1" 表示"无限制" |
-| dn_default_space_usage_thresholds | 0.85 |
定义每个层级数据目录的最大使用空间比例;当使用空间大于该比例时,数据会被自动迁移至下一个层级;当最后一个层级的使用存储空间大于此阈值时,会将系统置为
READ_ONLY | 每级存储使用分号分隔;层级数量需与 dn_data_dirs 定义的层级数一致 |
-| object_storage_type | AWS_S3 | 云端存储类型
| IoTDB 支持 S3 协议作为远端存储类型 |
-| object_storage_bucket | iotdb_data |
云端存储 bucket 的名称 | AWS S3 中的 bucket
定义;如果未使用远端存储,无需配置 |
-| object_storage_region | |
云端存储的服务区域 | AWS S3 中的 region
定义;如果未使用远端存储,无需配置 |
-| object_storage_endpoint | | 云端存储的
endpoint | AWS S3 的
endpoint;如果未使用远端存储,无需配置 |
-| object_storage_access_key | |
云端存储的验证信息 key | AWS S3 的 credential
key;如果未使用远端存储,无需配置 |
-| object_storage_access_secret | |
云端存储的验证信息 secret | AWS S3 的 credential
secret;如果未使用远端存储,无需配置 |
-| enable_path_style_access | false |
是否启用云端存储服务路径访问 | 如果未使用远端存储,无需配置 |
-| remote_tsfile_cache_dirs | data/datanode/data/cache |
云端存储在本地的缓存目录 | 如果未使用远端存储,无需配置
|
-| remote_tsfile_cache_page_size_in_kb | 20480 |
云端存储在本地缓存文件的块大小 | 如果未使用远端存储,无需配置
|
-| remote_tsfile_cache_max_disk_usage_in_mb | 51200 |
云端存储本地缓存的最大磁盘占用大小 | 如果未使用远端存储,无需配置
|
+| 配置项 | 默认值 | 是否必填 | 说明 | 约束 |
+| --------------------------------------- | ------------------------ | --- |
------------------------------------------------------------ |
------------------------------------------------------------ |
+| dn_data_dirs | data/datanode/data | 是 | 用来指定不同的存储目录,并将存储目录进行层级划分 |
每级存储使用分号分隔,单级内使用逗号分隔;云端配置只能作为最后一级存储且第一级不能作为云端存储;最多配置一个云端对象;远端存储目录使用
OBJECT_STORAGE 来表示 |
+| tier_ttl_in_ms | -1 | 是 | 定义每个层级负责的数据范围,通过 TTL 表示 | 每级存储使用分号分隔;层级数量需与
dn_data_dirs 定义的层级数一致;"-1" 表示"无限制" |
+| dn_default_space_usage_thresholds | 0.85 | 是 |
定义每个层级数据目录的最大使用空间比例;当使用空间大于该比例时,数据会被自动迁移至下一个层级;当最后一个层级的使用存储空间大于此阈值时,会将系统置为
READ_ONLY | 每级存储使用分号分隔;层级数量需与 dn_data_dirs 定义的层级数一致 |
+| object_storage_type | AWS_S3 | 使用远端存储时必填 | 云端存储类型 | IoTDB 支持 S3 协议作为远端存储类型 |
+| object_storage_bucket | iotdb_data | 使用远端存储时必填 | 云端存储 bucket 的名称 | AWS S3 中的
bucket 定义 |
+| object_storage_region | | 使用远端存储时必填 | 云端存储的服务区域 | AWS S3 中的 region 定义 |
+| object_storage_endpoint | | 使用远端存储时必填 | 云端存储的 endpoint | AWS S3 的 endpoint |
+| object_storage_access_key | | 使用远端存储时必填 | 云端存储的验证信息 key | AWS S3 的
credential key |
+| object_storage_access_secret | | 使用远端存储时必填 | 云端存储的验证信息 secret | AWS S3 的
credential secret |
+| enable_path_style_access | false | 否 | 是否启用云端存储服务路径访问 | |
+| remote_tsfile_cache_dirs | data/datanode/data/cache | 否 | 云端存储在本地的缓存目录 | |
+| remote_tsfile_cache_page_size_in_kb | 20480 | 否 | 云端存储在本地缓存文件的块大小 | |
+| remote_tsfile_cache_max_disk_usage_in_mb | 51200 | 否 | 云端存储本地缓存的最大磁盘占用大小 | |
## 3. 本地多级存储配置示例
diff --git a/src/zh/UserGuide/Master/Tree/User-Manual/Tiered-Storage_timecho.md
b/src/zh/UserGuide/Master/Tree/User-Manual/Tiered-Storage_timecho.md
index b982596b..86c183dc 100644
--- a/src/zh/UserGuide/Master/Tree/User-Manual/Tiered-Storage_timecho.md
+++ b/src/zh/UserGuide/Master/Tree/User-Manual/Tiered-Storage_timecho.md
@@ -34,21 +34,21 @@
具体的参数定义及其描述如下。
-| 配置项 | 默认值 | 说明
| 约束
|
-| --------------------------------------- | ------------------------ |
------------------------------------------------------------ |
------------------------------------------------------------ |
-| dn_data_dirs | data/datanode/data
| 用来指定不同的存储目录,并将存储目录进行层级划分 |
每级存储使用分号分隔,单级内使用逗号分隔;云端配置只能作为最后一级存储且第一级不能作为云端存储;最多配置一个云端对象;远端存储目录使用
OBJECT_STORAGE 来表示 |
-| tier_ttl_in_ms | -1 |
定义每个层级负责的数据范围,通过 TTL 表示 | 每级存储使用分号分隔;层级数量需与 dn_data_dirs
定义的层级数一致;"-1" 表示"无限制" |
-| dn_default_space_usage_thresholds | 0.85 |
定义每个层级数据目录的最大使用空间比例;当使用空间大于该比例时,数据会被自动迁移至下一个层级;当最后一个层级的使用存储空间大于此阈值时,会将系统置为
READ_ONLY | 每级存储使用分号分隔;层级数量需与 dn_data_dirs 定义的层级数一致 |
-| object_storage_type | AWS_S3 | 云端存储类型
| IoTDB 支持 S3 协议作为远端存储类型 |
-| object_storage_bucket | iotdb_data |
云端存储 bucket 的名称 | AWS S3 中的 bucket
定义;如果未使用远端存储,无需配置 |
-| object_storage_region | |
云端存储的服务区域 | AWS S3 中的 region
定义;如果未使用远端存储,无需配置 |
-| object_storage_endpoint | | 云端存储的
endpoint | AWS S3 的
endpoint;如果未使用远端存储,无需配置 |
-| object_storage_access_key | |
云端存储的验证信息 key | AWS S3 的 credential
key;如果未使用远端存储,无需配置 |
-| object_storage_access_secret | |
云端存储的验证信息 secret | AWS S3 的 credential
secret;如果未使用远端存储,无需配置 |
-| enable_path_style_access | false |
是否启用云端存储服务路径访问 | 如果未使用远端存储,无需配置 |
-| remote_tsfile_cache_dirs | data/datanode/data/cache |
云端存储在本地的缓存目录 | 如果未使用远端存储,无需配置
|
-| remote_tsfile_cache_page_size_in_kb | 20480 |
云端存储在本地缓存文件的块大小 | 如果未使用远端存储,无需配置
|
-| remote_tsfile_cache_max_disk_usage_in_mb | 51200 |
云端存储本地缓存的最大磁盘占用大小 | 如果未使用远端存储,无需配置
|
+| 配置项 | 默认值 | 是否必填 | 说明 | 约束 |
+| --------------------------------------- | ------------------------ | --- |
------------------------------------------------------------ |
------------------------------------------------------------ |
+| dn_data_dirs | data/datanode/data | 是 | 用来指定不同的存储目录,并将存储目录进行层级划分 |
每级存储使用分号分隔,单级内使用逗号分隔;云端配置只能作为最后一级存储且第一级不能作为云端存储;最多配置一个云端对象;远端存储目录使用
OBJECT_STORAGE 来表示 |
+| tier_ttl_in_ms | -1 | 是 | 定义每个层级负责的数据范围,通过 TTL 表示 | 每级存储使用分号分隔;层级数量需与
dn_data_dirs 定义的层级数一致;"-1" 表示"无限制" |
+| dn_default_space_usage_thresholds | 0.85 | 是 |
定义每个层级数据目录的最大使用空间比例;当使用空间大于该比例时,数据会被自动迁移至下一个层级;当最后一个层级的使用存储空间大于此阈值时,会将系统置为
READ_ONLY | 每级存储使用分号分隔;层级数量需与 dn_data_dirs 定义的层级数一致 |
+| object_storage_type | AWS_S3 | 使用远端存储时必填 | 云端存储类型 | IoTDB 支持 S3 协议作为远端存储类型 |
+| object_storage_bucket | iotdb_data | 使用远端存储时必填 | 云端存储 bucket 的名称 | AWS S3 中的
bucket 定义 |
+| object_storage_region | | 使用远端存储时必填 | 云端存储的服务区域 | AWS S3 中的 region 定义 |
+| object_storage_endpoint | | 使用远端存储时必填 | 云端存储的 endpoint | AWS S3 的 endpoint |
+| object_storage_access_key | | 使用远端存储时必填 | 云端存储的验证信息 key | AWS S3 的
credential key |
+| object_storage_access_secret | | 使用远端存储时必填 | 云端存储的验证信息 secret | AWS S3 的
credential secret |
+| enable_path_style_access | false | 否 | 是否启用云端存储服务路径访问 | |
+| remote_tsfile_cache_dirs | data/datanode/data/cache | 否 | 云端存储在本地的缓存目录 | |
+| remote_tsfile_cache_page_size_in_kb | 20480 | 否 | 云端存储在本地缓存文件的块大小 | |
+| remote_tsfile_cache_max_disk_usage_in_mb | 51200 | 否 | 云端存储本地缓存的最大磁盘占用大小 | |
## 3. 本地多级存储配置示例
diff --git
a/src/zh/UserGuide/latest-Table/User-Manual/Tiered-Storage_timecho.md
b/src/zh/UserGuide/latest-Table/User-Manual/Tiered-Storage_timecho.md
index b982596b..86c183dc 100644
--- a/src/zh/UserGuide/latest-Table/User-Manual/Tiered-Storage_timecho.md
+++ b/src/zh/UserGuide/latest-Table/User-Manual/Tiered-Storage_timecho.md
@@ -34,21 +34,21 @@
具体的参数定义及其描述如下。
-| 配置项 | 默认值 | 说明
| 约束
|
-| --------------------------------------- | ------------------------ |
------------------------------------------------------------ |
------------------------------------------------------------ |
-| dn_data_dirs | data/datanode/data
| 用来指定不同的存储目录,并将存储目录进行层级划分 |
每级存储使用分号分隔,单级内使用逗号分隔;云端配置只能作为最后一级存储且第一级不能作为云端存储;最多配置一个云端对象;远端存储目录使用
OBJECT_STORAGE 来表示 |
-| tier_ttl_in_ms | -1 |
定义每个层级负责的数据范围,通过 TTL 表示 | 每级存储使用分号分隔;层级数量需与 dn_data_dirs
定义的层级数一致;"-1" 表示"无限制" |
-| dn_default_space_usage_thresholds | 0.85 |
定义每个层级数据目录的最大使用空间比例;当使用空间大于该比例时,数据会被自动迁移至下一个层级;当最后一个层级的使用存储空间大于此阈值时,会将系统置为
READ_ONLY | 每级存储使用分号分隔;层级数量需与 dn_data_dirs 定义的层级数一致 |
-| object_storage_type | AWS_S3 | 云端存储类型
| IoTDB 支持 S3 协议作为远端存储类型 |
-| object_storage_bucket | iotdb_data |
云端存储 bucket 的名称 | AWS S3 中的 bucket
定义;如果未使用远端存储,无需配置 |
-| object_storage_region | |
云端存储的服务区域 | AWS S3 中的 region
定义;如果未使用远端存储,无需配置 |
-| object_storage_endpoint | | 云端存储的
endpoint | AWS S3 的
endpoint;如果未使用远端存储,无需配置 |
-| object_storage_access_key | |
云端存储的验证信息 key | AWS S3 的 credential
key;如果未使用远端存储,无需配置 |
-| object_storage_access_secret | |
云端存储的验证信息 secret | AWS S3 的 credential
secret;如果未使用远端存储,无需配置 |
-| enable_path_style_access | false |
是否启用云端存储服务路径访问 | 如果未使用远端存储,无需配置 |
-| remote_tsfile_cache_dirs | data/datanode/data/cache |
云端存储在本地的缓存目录 | 如果未使用远端存储,无需配置
|
-| remote_tsfile_cache_page_size_in_kb | 20480 |
云端存储在本地缓存文件的块大小 | 如果未使用远端存储,无需配置
|
-| remote_tsfile_cache_max_disk_usage_in_mb | 51200 |
云端存储本地缓存的最大磁盘占用大小 | 如果未使用远端存储,无需配置
|
+| 配置项 | 默认值 | 是否必填 | 说明 | 约束 |
+| --------------------------------------- | ------------------------ | --- |
------------------------------------------------------------ |
------------------------------------------------------------ |
+| dn_data_dirs | data/datanode/data | 是 | 用来指定不同的存储目录,并将存储目录进行层级划分 |
每级存储使用分号分隔,单级内使用逗号分隔;云端配置只能作为最后一级存储且第一级不能作为云端存储;最多配置一个云端对象;远端存储目录使用
OBJECT_STORAGE 来表示 |
+| tier_ttl_in_ms | -1 | 是 | 定义每个层级负责的数据范围,通过 TTL 表示 | 每级存储使用分号分隔;层级数量需与
dn_data_dirs 定义的层级数一致;"-1" 表示"无限制" |
+| dn_default_space_usage_thresholds | 0.85 | 是 |
定义每个层级数据目录的最大使用空间比例;当使用空间大于该比例时,数据会被自动迁移至下一个层级;当最后一个层级的使用存储空间大于此阈值时,会将系统置为
READ_ONLY | 每级存储使用分号分隔;层级数量需与 dn_data_dirs 定义的层级数一致 |
+| object_storage_type | AWS_S3 | 使用远端存储时必填 | 云端存储类型 | IoTDB 支持 S3 协议作为远端存储类型 |
+| object_storage_bucket | iotdb_data | 使用远端存储时必填 | 云端存储 bucket 的名称 | AWS S3 中的
bucket 定义 |
+| object_storage_region | | 使用远端存储时必填 | 云端存储的服务区域 | AWS S3 中的 region 定义 |
+| object_storage_endpoint | | 使用远端存储时必填 | 云端存储的 endpoint | AWS S3 的 endpoint |
+| object_storage_access_key | | 使用远端存储时必填 | 云端存储的验证信息 key | AWS S3 的
credential key |
+| object_storage_access_secret | | 使用远端存储时必填 | 云端存储的验证信息 secret | AWS S3 的
credential secret |
+| enable_path_style_access | false | 否 | 是否启用云端存储服务路径访问 | |
+| remote_tsfile_cache_dirs | data/datanode/data/cache | 否 | 云端存储在本地的缓存目录 | |
+| remote_tsfile_cache_page_size_in_kb | 20480 | 否 | 云端存储在本地缓存文件的块大小 | |
+| remote_tsfile_cache_max_disk_usage_in_mb | 51200 | 否 | 云端存储本地缓存的最大磁盘占用大小 | |
## 3. 本地多级存储配置示例
diff --git a/src/zh/UserGuide/latest/User-Manual/Tiered-Storage_timecho.md
b/src/zh/UserGuide/latest/User-Manual/Tiered-Storage_timecho.md
index b982596b..86c183dc 100644
--- a/src/zh/UserGuide/latest/User-Manual/Tiered-Storage_timecho.md
+++ b/src/zh/UserGuide/latest/User-Manual/Tiered-Storage_timecho.md
@@ -34,21 +34,21 @@
具体的参数定义及其描述如下。
-| 配置项 | 默认值 | 说明
| 约束
|
-| --------------------------------------- | ------------------------ |
------------------------------------------------------------ |
------------------------------------------------------------ |
-| dn_data_dirs | data/datanode/data
| 用来指定不同的存储目录,并将存储目录进行层级划分 |
每级存储使用分号分隔,单级内使用逗号分隔;云端配置只能作为最后一级存储且第一级不能作为云端存储;最多配置一个云端对象;远端存储目录使用
OBJECT_STORAGE 来表示 |
-| tier_ttl_in_ms | -1 |
定义每个层级负责的数据范围,通过 TTL 表示 | 每级存储使用分号分隔;层级数量需与 dn_data_dirs
定义的层级数一致;"-1" 表示"无限制" |
-| dn_default_space_usage_thresholds | 0.85 |
定义每个层级数据目录的最大使用空间比例;当使用空间大于该比例时,数据会被自动迁移至下一个层级;当最后一个层级的使用存储空间大于此阈值时,会将系统置为
READ_ONLY | 每级存储使用分号分隔;层级数量需与 dn_data_dirs 定义的层级数一致 |
-| object_storage_type | AWS_S3 | 云端存储类型
| IoTDB 支持 S3 协议作为远端存储类型 |
-| object_storage_bucket | iotdb_data |
云端存储 bucket 的名称 | AWS S3 中的 bucket
定义;如果未使用远端存储,无需配置 |
-| object_storage_region | |
云端存储的服务区域 | AWS S3 中的 region
定义;如果未使用远端存储,无需配置 |
-| object_storage_endpoint | | 云端存储的
endpoint | AWS S3 的
endpoint;如果未使用远端存储,无需配置 |
-| object_storage_access_key | |
云端存储的验证信息 key | AWS S3 的 credential
key;如果未使用远端存储,无需配置 |
-| object_storage_access_secret | |
云端存储的验证信息 secret | AWS S3 的 credential
secret;如果未使用远端存储,无需配置 |
-| enable_path_style_access | false |
是否启用云端存储服务路径访问 | 如果未使用远端存储,无需配置 |
-| remote_tsfile_cache_dirs | data/datanode/data/cache |
云端存储在本地的缓存目录 | 如果未使用远端存储,无需配置
|
-| remote_tsfile_cache_page_size_in_kb | 20480 |
云端存储在本地缓存文件的块大小 | 如果未使用远端存储,无需配置
|
-| remote_tsfile_cache_max_disk_usage_in_mb | 51200 |
云端存储本地缓存的最大磁盘占用大小 | 如果未使用远端存储,无需配置
|
+| 配置项 | 默认值 | 是否必填 | 说明 | 约束 |
+| --------------------------------------- | ------------------------ | --- |
------------------------------------------------------------ |
------------------------------------------------------------ |
+| dn_data_dirs | data/datanode/data | 是 | 用来指定不同的存储目录,并将存储目录进行层级划分 |
每级存储使用分号分隔,单级内使用逗号分隔;云端配置只能作为最后一级存储且第一级不能作为云端存储;最多配置一个云端对象;远端存储目录使用
OBJECT_STORAGE 来表示 |
+| tier_ttl_in_ms | -1 | 是 | 定义每个层级负责的数据范围,通过 TTL 表示 | 每级存储使用分号分隔;层级数量需与
dn_data_dirs 定义的层级数一致;"-1" 表示"无限制" |
+| dn_default_space_usage_thresholds | 0.85 | 是 |
定义每个层级数据目录的最大使用空间比例;当使用空间大于该比例时,数据会被自动迁移至下一个层级;当最后一个层级的使用存储空间大于此阈值时,会将系统置为
READ_ONLY | 每级存储使用分号分隔;层级数量需与 dn_data_dirs 定义的层级数一致 |
+| object_storage_type | AWS_S3 | 使用远端存储时必填 | 云端存储类型 | IoTDB 支持 S3 协议作为远端存储类型 |
+| object_storage_bucket | iotdb_data | 使用远端存储时必填 | 云端存储 bucket 的名称 | AWS S3 中的
bucket 定义 |
+| object_storage_region | | 使用远端存储时必填 | 云端存储的服务区域 | AWS S3 中的 region 定义 |
+| object_storage_endpoint | | 使用远端存储时必填 | 云端存储的 endpoint | AWS S3 的 endpoint |
+| object_storage_access_key | | 使用远端存储时必填 | 云端存储的验证信息 key | AWS S3 的
credential key |
+| object_storage_access_secret | | 使用远端存储时必填 | 云端存储的验证信息 secret | AWS S3 的
credential secret |
+| enable_path_style_access | false | 否 | 是否启用云端存储服务路径访问 | |
+| remote_tsfile_cache_dirs | data/datanode/data/cache | 否 | 云端存储在本地的缓存目录 | |
+| remote_tsfile_cache_page_size_in_kb | 20480 | 否 | 云端存储在本地缓存文件的块大小 | |
+| remote_tsfile_cache_max_disk_usage_in_mb | 51200 | 否 | 云端存储本地缓存的最大磁盘占用大小 | |
## 3. 本地多级存储配置示例