Skip to content

Update tiered storage required parameters #1148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HTHou merged 2 commits into from
Jun 9, 2026
Merged

Update tiered storage required parameters #1148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6020541
Update tiered storage required parameters
leto-bbq Jun 8, 2026
b834b2f
Remove redundant configuration notes from constraints
leto-bbq Jun 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions src/UserGuide/Master/Table/User-Manual/Tiered-Storage_timecho.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 one cloud storage bucket is allowed. |
| `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

Expand Down
30 changes: 15 additions & 15 deletions src/UserGuide/Master/Tree/User-Manual/Tiered-Storage_timecho.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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_STORAGE |
| 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

Expand Down
Loading
Loading