Skip to content

Commit d110b09

Browse files
committed
chore: update config docs and test
Signed-off-by: evenyag <[email protected]>
1 parent c48eeb3 commit d110b09

File tree

4 files changed

+28
-0
lines changed

4 files changed

+28
-0
lines changed

config/config.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,8 @@
150150
| `region_engine.mito.write_cache_path` | String | `""` | File system path for write cache, defaults to `{data_home}`. |
151151
| `region_engine.mito.write_cache_size` | String | `5GiB` | Capacity for write cache. If your disk space is sufficient, it is recommended to set it larger. |
152152
| `region_engine.mito.write_cache_ttl` | String | Unset | TTL for write cache. |
153+
| `region_engine.mito.preload_index_cache` | Bool | `true` | Preload index (puffin) files into cache on region open (default: true).<br/>When enabled, index files are loaded into the write cache during region initialization,<br/>which can improve query performance at the cost of longer startup times. |
154+
| `region_engine.mito.index_cache_percent` | Integer | `20` | Percentage of write cache capacity allocated for index (puffin) files (default: 20).<br/>The remaining capacity is used for data (parquet) files.<br/>Must be between 0 and 100 (exclusive). For example, with a 5GiB write cache and 20% allocation,<br/>1GiB is reserved for index files and 4GiB for data files. |
153155
| `region_engine.mito.sst_write_buffer_size` | String | `8MB` | Buffer size for SST writing. |
154156
| `region_engine.mito.parallel_scan_channel_size` | Integer | `32` | Capacity of the channel to send data from parallel scan tasks to the main task. |
155157
| `region_engine.mito.max_concurrent_scan_files` | Integer | `384` | Maximum number of SST files to scan concurrently. |
@@ -546,6 +548,8 @@
546548
| `region_engine.mito.write_cache_path` | String | `""` | File system path for write cache, defaults to `{data_home}`. |
547549
| `region_engine.mito.write_cache_size` | String | `5GiB` | Capacity for write cache. If your disk space is sufficient, it is recommended to set it larger. |
548550
| `region_engine.mito.write_cache_ttl` | String | Unset | TTL for write cache. |
551+
| `region_engine.mito.preload_index_cache` | Bool | `true` | Preload index (puffin) files into cache on region open (default: true).<br/>When enabled, index files are loaded into the write cache during region initialization,<br/>which can improve query performance at the cost of longer startup times. |
552+
| `region_engine.mito.index_cache_percent` | Integer | `20` | Percentage of write cache capacity allocated for index (puffin) files (default: 20).<br/>The remaining capacity is used for data (parquet) files.<br/>Must be between 0 and 100 (exclusive). For example, with a 5GiB write cache and 20% allocation,<br/>1GiB is reserved for index files and 4GiB for data files. |
549553
| `region_engine.mito.sst_write_buffer_size` | String | `8MB` | Buffer size for SST writing. |
550554
| `region_engine.mito.parallel_scan_channel_size` | Integer | `32` | Capacity of the channel to send data from parallel scan tasks to the main task. |
551555
| `region_engine.mito.max_concurrent_scan_files` | Integer | `384` | Maximum number of SST files to scan concurrently. |

config/datanode.example.toml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -485,6 +485,17 @@ write_cache_size = "5GiB"
485485
## @toml2docs:none-default
486486
write_cache_ttl = "8h"
487487

488+
## Preload index (puffin) files into cache on region open (default: true).
489+
## When enabled, index files are loaded into the write cache during region initialization,
490+
## which can improve query performance at the cost of longer startup times.
491+
preload_index_cache = true
492+
493+
## Percentage of write cache capacity allocated for index (puffin) files (default: 20).
494+
## The remaining capacity is used for data (parquet) files.
495+
## Must be between 0 and 100 (exclusive). For example, with a 5GiB write cache and 20% allocation,
496+
## 1GiB is reserved for index files and 4GiB for data files.
497+
index_cache_percent = 20
498+
488499
## Buffer size for SST writing.
489500
sst_write_buffer_size = "8MB"
490501

config/standalone.example.toml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -576,6 +576,17 @@ write_cache_size = "5GiB"
576576
## @toml2docs:none-default
577577
write_cache_ttl = "8h"
578578

579+
## Preload index (puffin) files into cache on region open (default: true).
580+
## When enabled, index files are loaded into the write cache during region initialization,
581+
## which can improve query performance at the cost of longer startup times.
582+
preload_index_cache = true
583+
584+
## Percentage of write cache capacity allocated for index (puffin) files (default: 20).
585+
## The remaining capacity is used for data (parquet) files.
586+
## Must be between 0 and 100 (exclusive). For example, with a 5GiB write cache and 20% allocation,
587+
## 1GiB is reserved for index files and 4GiB for data files.
588+
index_cache_percent = 20
589+
579590
## Buffer size for SST writing.
580591
sst_write_buffer_size = "8MB"
581592

tests-integration/tests/http.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1497,6 +1497,8 @@ auto_flush_interval = "30m"
14971497
enable_write_cache = false
14981498
write_cache_path = ""
14991499
write_cache_size = "5GiB"
1500+
preload_index_cache = true
1501+
index_cache_percent = 20
15001502
sst_write_buffer_size = "8MiB"
15011503
parallel_scan_channel_size = 32
15021504
max_concurrent_scan_files = 384

0 commit comments

Comments
 (0)