Skip to content

Commit a7e1384

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

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
@@ -151,6 +151,8 @@
151151
| `region_engine.mito.write_cache_path` | String | `""` | File system path for write cache, defaults to `{data_home}`. |
152152
| `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. |
153153
| `region_engine.mito.write_cache_ttl` | String | Unset | TTL for write cache. |
154+
| `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. |
155+
| `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. |
154156
| `region_engine.mito.sst_write_buffer_size` | String | `8MB` | Buffer size for SST writing. |
155157
| `region_engine.mito.parallel_scan_channel_size` | Integer | `32` | Capacity of the channel to send data from parallel scan tasks to the main task. |
156158
| `region_engine.mito.max_concurrent_scan_files` | Integer | `384` | Maximum number of SST files to scan concurrently. |
@@ -549,6 +551,8 @@
549551
| `region_engine.mito.write_cache_path` | String | `""` | File system path for write cache, defaults to `{data_home}`. |
550552
| `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. |
551553
| `region_engine.mito.write_cache_ttl` | String | Unset | TTL for write cache. |
554+
| `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. |
555+
| `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. |
552556
| `region_engine.mito.sst_write_buffer_size` | String | `8MB` | Buffer size for SST writing. |
553557
| `region_engine.mito.parallel_scan_channel_size` | Integer | `32` | Capacity of the channel to send data from parallel scan tasks to the main task. |
554558
| `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
@@ -489,6 +489,17 @@ write_cache_size = "5GiB"
489489
## @toml2docs:none-default
490490
write_cache_ttl = "8h"
491491

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

config/standalone.example.toml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -580,6 +580,17 @@ write_cache_size = "5GiB"
580580
## @toml2docs:none-default
581581
write_cache_ttl = "8h"
582582

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

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)