rust/greptimedb
1
0
Fork 0
mirror of https://github.com/GreptimeTeam/greptimedb.git synced 2026-01-17 02:32:56 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
a5293fa69193df2d163c0562886d253aa16716cb
greptimedb/store_api/mito_engine_options/index.html
github-merge-queue[bot] a5293fa691 Deploying to gh-pages from @ GreptimeTeam/greptimedb@2f4a15ec40 🚀
2025-12-18 14:53:29 +00:00

5 lines
8.1 KiB
HTML
Raw Blame History

<!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-e56847b5.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.92.0-nightly (fa3155a64 2025-09-30)" data-channel="nightly" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-828709d0.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.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"><!--[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.0.0-beta.3</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="#constants">Module Items</a></h3><ul class="block"><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"><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-118">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="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.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.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.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.SNAPSHOT_READ.html" title="constant store_api::mito_engine_options::SNAPSHOT_READ">SNAPSHOT_<wbr>READ</a></dt><dd>Option key for snapshot read.</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_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_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></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></dl></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink