greptimedb/store_api/mito_engine_options/index.html

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Option keys for the mito engine. We define them in this mod so the create parser can use it to validate table options."><title>store_api::mito_engine_options - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-1ed95124.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="store_api" data-themes="" data-resource-suffix="" data-rustdoc-version="1.98.1 (48a229cea 2026-09-01)" data-channel="1.98.1" data-search-js="search-9944d736.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../static.files/storage-41dd4d93.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-417ebf0a.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module mito_engine_options</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../store_api/index.html">store_<wbr>api</a><span class="version">1.4.0-alpha.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module mito_<wbr>engine_<wbr>options</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate store_<wbr>api</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">store_api</a></div><h1>Module <span>mito_<wbr>engine_<wbr>options</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/store_api/mito_engine_options.rs.html#15-319">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Option keys for the mito engine.
We define them in this mod so the create parser can use it to validate table options.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.TwcsTriggerOptionConflict.html" title="struct store_api::mito_engine_options::TwcsTriggerOptionConflict">Twcs<wbr>Trigger<wbr>Option<wbr>Conflict</a></dt><dd>Conflicting values supplied through the legacy and canonical TWCS trigger options.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.FloatFieldEncoding.html" title="enum store_api::mito_engine_options::FloatFieldEncoding">Float<wbr>Field<wbr>Encoding</a></dt><dd>Encoding policy for direct floating-point field columns in Parquet SSTs.</dd></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.APPEND_MODE_KEY.html" title="constant store_api::mito_engine_options::APPEND_MODE_KEY">APPEND_<wbr>MODE_<wbr>KEY</a></dt><dd>Option key for append mode.</dd><dt><a class="constant" href="constant.AUTO_FLUSH_INTERVAL_KEY.html" title="constant store_api::mito_engine_options::AUTO_FLUSH_INTERVAL_KEY">AUTO_<wbr>FLUSH_<wbr>INTERVAL_<wbr>KEY</a></dt><dd>Option key for the per-table auto flush interval.</dd><dt><a class="constant" href="constant.COMPACTION_EXPERIMENTAL_OUTPUT_PARALLELISM.html" title="constant store_api::mito_engine_options::COMPACTION_EXPERIMENTAL_OUTPUT_PARALLELISM">COMPACTION_<wbr>EXPERIMENTAL_<wbr>OUTPUT_<wbr>PARALLELISM</a></dt><dd>Per-table override for each compaction output’s decode and encode parallelism.</dd><dt><a class="constant" href="constant.COMPACTION_OPTION_KEYS.html" title="constant store_api::mito_engine_options::COMPACTION_OPTION_KEYS">COMPACTION_<wbr>OPTION_<wbr>KEYS</a></dt><dd>Table options that configure compaction.</dd><dt><a class="constant" href="constant.COMPACTION_OVERRIDE.html" title="constant store_api::mito_engine_options::COMPACTION_OVERRIDE">COMPACTION_<wbr>OVERRIDE</a></dt><dd>Option key for forcing compaction options override.</dd><dt><a class="constant" href="constant.COMPACTION_TWCS_PREFIX.html" title="constant store_api::mito_engine_options::COMPACTION_TWCS_PREFIX">COMPACTION_<wbr>TWCS_<wbr>PREFIX</a></dt><dd>Prefix for TWCS compaction options.</dd><dt><a class="constant" href="constant.COMPACTION_TYPE.html" title="constant store_api::mito_engine_options::COMPACTION_TYPE">COMPACTION_<wbr>TYPE</a></dt><dd>Option key for compaction type.</dd><dt><a class="constant" href="constant.COMPACTION_TYPE_TWCS.html" title="constant store_api::mito_engine_options::COMPACTION_TYPE_TWCS">COMPACTION_<wbr>TYPE_<wbr>TWCS</a></dt><dd>TWCS compaction strategy.</dd><dt><a class="constant" href="constant.EXPERIMENTAL_SST_FLOAT_FIELD_ENCODING.html" title="constant store_api::mito_engine_options::EXPERIMENTAL_SST_FLOAT_FIELD_ENCODING">EXPERIMENTAL_<wbr>SST_<wbr>FLOAT_<wbr>FIELD_<wbr>ENCODING</a></dt><dd>Option key for experimental Parquet float field encoding.</dd><dt><a class="constant" href="constant.MAX_ROW_GROUP_ROW_COUNT.html" title="constant store_api::mito_engine_options::MAX_ROW_GROUP_ROW_COUNT">MAX_<wbr>ROW_<wbr>GROUP_<wbr>ROW_<wbr>COUNT</a></dt><dd>Option key for the max number of rows in a parquet row group.</dd><dt><a class="constant" href="constant.MAX_ROW_GROUP_ROW_COUNT_LIMIT.html" title="constant store_api::mito_engine_options::MAX_ROW_GROUP_ROW_COUNT_LIMIT">MAX_<wbr>ROW_<wbr>GROUP_<wbr>ROW_<wbr>COUNT_<wbr>LIMIT</a></dt><dd>Upper bound for <a href="constant.MAX_ROW_GROUP_ROW_COUNT.html" title="constant store_api::mito_engine_options::MAX_ROW_GROUP_ROW_COUNT"><code>MAX_ROW_GROUP_ROW_COUNT</code></a>.</dd><dt><a class="constant" href="constant.MEMTABLE_BULK_ENCODE_BYTES_THRESHOLD.html" title="constant store_api::mito_engine_options::MEMTABLE_BULK_ENCODE_BYTES_THRESHOLD">MEMTABLE_<wbr>BULK_<wbr>ENCODE_<wbr>BYTES_<wbr>THRESHOLD</a></dt><dd>Option key for bulk memtable encode bytes threshold.</dd><dt><a class="constant" href="constant.MEMTABLE_BULK_ENCODE_ROW_THRESHOLD.html" title="constant store_api::mito_engine_options::MEMTABLE_BULK_ENCODE_ROW_THRESHOLD">MEMTABLE_<wbr>BULK_<wbr>ENCODE_<wbr>ROW_<wbr>THRESHOLD</a></dt><dd>Option key for bulk memtable encode row threshold.</dd><dt><a class="constant" href="constant.MEMTABLE_BULK_MAX_MERGE_GROUPS.html" title="constant store_api::mito_engine_options::MEMTABLE_BULK_MAX_MERGE_GROUPS">MEMTABLE_<wbr>BULK_<wbr>MAX_<wbr>MERGE_<wbr>GROUPS</a></dt><dd>Option key for bulk memtable max merge groups.</dd><dt><a class="constant" href="constant.MEMTABLE_BULK_MERGE_THRESHOLD.html" title="constant store_api::mito_engine_options::MEMTABLE_BULK_MERGE_THRESHOLD">MEMTABLE_<wbr>BULK_<wbr>MERGE_<wbr>THRESHOLD</a></dt><dd>Option key for bulk memtable merge threshold.</dd><dt><a class="constant" href="constant.MEMTABLE_PARTITION_TREE_DATA_FREEZE_THRESHOLD.html" title="constant store_api::mito_engine_options::MEMTABLE_PARTITION_TREE_DATA_FREEZE_THRESHOLD">MEMTABLE_<wbr>PARTITION_<wbr>TREE_<wbr>DATA_<wbr>FREEZE_<wbr>THRESHOLD</a></dt><dd>Option key for memtable partition tree data freeze threshold.</dd><dt><a class="constant" href="constant.MEMTABLE_PARTITION_TREE_FORK_DICTIONARY_BYTES.html" title="constant store_api::mito_engine_options::MEMTABLE_PARTITION_TREE_FORK_DICTIONARY_BYTES">MEMTABLE_<wbr>PARTITION_<wbr>TREE_<wbr>FORK_<wbr>DICTIONARY_<wbr>BYTES</a></dt><dd>Option key for memtable partition tree fork dictionary bytes.</dd><dt><a class="constant" href="constant.MEMTABLE_PARTITION_TREE_INDEX_MAX_KEYS_PER_SHARD.html" title="constant store_api::mito_engine_options::MEMTABLE_PARTITION_TREE_INDEX_MAX_KEYS_PER_SHARD">MEMTABLE_<wbr>PARTITION_<wbr>TREE_<wbr>INDEX_<wbr>MAX_<wbr>KEYS_<wbr>PER_<wbr>SHARD</a></dt><dd>Option key for memtable partition tree index max keys per shard.</dd><dt><a class="constant" href="constant.MEMTABLE_TYPE.html" title="constant store_api::mito_engine_options::MEMTABLE_TYPE">MEMTABLE_<wbr>TYPE</a></dt><dd>Option key for memtable type.</dd><dt><a class="constant" href="constant.MERGE_MODE_KEY.html" title="constant store_api::mito_engine_options::MERGE_MODE_KEY">MERGE_<wbr>MODE_<wbr>KEY</a></dt><dd>Option key for merge mode.</dd><dt><a class="constant" href="constant.PRESERVE_ROW_SEQUENCE.html" title="constant store_api::mito_engine_options::PRESERVE_ROW_SEQUENCE">PRESERVE_<wbr>ROW_<wbr>SEQUENCE</a></dt><dd>Option key for preserving per-row sequence numbers through flush and compaction.</dd><dt><a class="constant" href="constant.SKIP_WAL_KEY.html" title="constant store_api::mito_engine_options::SKIP_WAL_KEY">SKIP_<wbr>WAL_<wbr>KEY</a></dt><dd>Option key for skipping WAL.</dd><dt><a class="constant" href="constant.SST_FORMAT_KEY.html" title="constant store_api::mito_engine_options::SST_FORMAT_KEY">SST_<wbr>FORMAT_<wbr>KEY</a></dt><dd>Option key for sst format.</dd><dt><a class="constant" href="constant.TTL_KEY.html" title="constant store_api::mito_engine_options::TTL_KEY">TTL_KEY</a></dt><dd>Option key for TTL(time-to-live)</dd><dt><a class="constant" href="constant.TWCS_ACTIVE_WINDOW_L1_MERGE_TRIGGER.html" title="constant store_api::mito_engine_options::TWCS_ACTIVE_WINDOW_L1_MERGE_TRIGGER">TWCS_<wbr>ACTIVE_<wbr>WINDOW_<wbr>L1_<wbr>MERGE_<wbr>TRIGGER</a></dt><dd>Option key for the active-window L1 safety compaction threshold.</dd><dt><a class="constant" href="constant.TWCS_ACTIVE_WINDOW_TRIGGER_FILE_NUM.html" title="constant store_api::mito_engine_options::TWCS_ACTIVE_WINDOW_TRIGGER_FILE_NUM">TWCS_<wbr>ACTIVE_<wbr>WINDOW_<wbr>TRIGGER_<wbr>FILE_<wbr>NUM</a></dt><dd>Option key for twcs min file num to trigger compaction in the active window.</dd><dt><a class="constant" href="constant.TWCS_FALLBACK_TO_LOCAL.html" title="constant store_api::mito_engine_options::TWCS_FALLBACK_TO_LOCAL">TWCS_<wbr>FALLBACK_<wbr>TO_<wbr>LOCAL</a></dt><dd>Option key for twcs fallback to local.</dd><dt><a class="constant" href="constant.TWCS_INACTIVE_WINDOW_L1_MERGE_TRIGGER.html" title="constant store_api::mito_engine_options::TWCS_INACTIVE_WINDOW_L1_MERGE_TRIGGER">TWCS_<wbr>INACTIVE_<wbr>WINDOW_<wbr>L1_<wbr>MERGE_<wbr>TRIGGER</a></dt><dd>Option key for the inactive-window L1 compaction threshold.</dd><dt><a class="constant" href="constant.TWCS_INACTIVE_WINDOW_TRIGGER_FILE_NUM.html" title="constant store_api::mito_engine_options::TWCS_INACTIVE_WINDOW_TRIGGER_FILE_NUM">TWCS_<wbr>INACTIVE_<wbr>WINDOW_<wbr>TRIGGER_<wbr>FILE_<wbr>NUM</a></dt><dd>Option key for twcs min file num to trigger compaction in an inactive window.</dd><dt><a class="constant" href="constant.TWCS_MAX_OUTPUT_FILE_SIZE.html" title="constant store_api::mito_engine_options::TWCS_MAX_OUTPUT_FILE_SIZE">TWCS_<wbr>MAX_<wbr>OUTPUT_<wbr>FILE_<wbr>SIZE</a></dt><dd>Option key for twcs max output file size.</dd><dt><a class="constant" href="constant.TWCS_REMOTE_COMPACTION.html" title="constant store_api::mito_engine_options::TWCS_REMOTE_COMPACTION">TWCS_<wbr>REMOTE_<wbr>COMPACTION</a></dt><dd>Option key for twcs remote compaction.</dd><dt><a class="constant" href="constant.TWCS_TIME_WINDOW.html" title="constant store_api::mito_engine_options::TWCS_TIME_WINDOW">TWCS_<wbr>TIME_<wbr>WINDOW</a></dt><dd>Option key for twcs time window.</dd><dt><a class="constant" href="constant.TWCS_TRIGGER_FILE_NUM.html" title="constant store_api::mito_engine_options::TWCS_TRIGGER_FILE_NUM">TWCS_<wbr>TRIGGER_<wbr>FILE_<wbr>NUM</a></dt><dd>Option key for twcs min file num to trigger a compaction.</dd><dt><a class="constant" href="constant.WAL_OPTIONS_KEY.html" title="constant store_api::mito_engine_options::WAL_OPTIONS_KEY">WAL_<wbr>OPTIONS_<wbr>KEY</a></dt><dd>Option key for all WAL options.
An encoded wal options will be wrapped into a (WAL_OPTIONS_KEY, encoded wal options) key-value pair
and inserted into the options of a <code>RegionCreateRequest</code>.</dd><dt><a class="constant" href="constant.WRITE_BUFFER_SIZE_KEY.html" title="constant store_api::mito_engine_options::WRITE_BUFFER_SIZE_KEY">WRITE_<wbr>BUFFER_<wbr>SIZE_<wbr>KEY</a></dt><dd>Option key for the per-region write buffer size.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.is_mito_engine_option_key.html" title="fn store_api::mito_engine_options::is_mito_engine_option_key">is_<wbr>mito_<wbr>engine_<wbr>option_<wbr>key</a></dt><dd>Returns true if the <code>key</code> is a valid option key for the mito engine.</dd><dt><a class="fn" href="fn.normalize_twcs_trigger_options.html" title="fn store_api::mito_engine_options::normalize_twcs_trigger_options">normalize_<wbr>twcs_<wbr>trigger_<wbr>options</a></dt><dd>Normalizes the active-window TWCS trigger option to its legacy storage key.</dd></dl></section></div></main></body></html>