rust/greptimedb
1
0
Fork 0
mirror of https://github.com/GreptimeTeam/greptimedb.git synced 2026-05-17 05:20:37 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
290e830bf8d8ca0e8aba96b520cfd72d632deb18
greptimedb/mito2/config/index.html
github-merge-queue[bot] 290e830bf8 Deploying to gh-pages from @ GreptimeTeam/greptimedb@fcb77fd025 🚀
2026-05-15 04:01:35 +00:00

3 lines
7.9 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="Configurations."><title>mito2::config - 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-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="mito2" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (ac7f9ec7d 2026-03-20)" data-channel="nightly" data-search-js="search-63369b7b.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-5013f961.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 config</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../mito2/index.html">mito2</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module config</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 mito2</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">mito2</a></div><h1>Module <span>config</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/mito2/config.rs.html#15-724">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Configurations.</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.BloomFilterConfig.html" title="struct mito2::config::BloomFilterConfig">Bloom<wbr>Filter<wbr>Config</a></dt><dd>Configuration options for the bloom filter.</dd><dt><a class="struct" href="struct.FulltextIndexConfig.html" title="struct mito2::config::FulltextIndexConfig">Fulltext<wbr>Index<wbr>Config</a></dt><dd>Configuration options for the full-text index.</dd><dt><a class="struct" href="struct.IndexConfig.html" title="struct mito2::config::IndexConfig">Index<wbr>Config</a></dt><dt><a class="struct" href="struct.InvertedIndexConfig.html" title="struct mito2::config::InvertedIndexConfig">Inverted<wbr>Index<wbr>Config</a></dt><dd>Configuration options for the inverted index.</dd><dt><a class="struct" href="struct.MitoConfig.html" title="struct mito2::config::MitoConfig">Mito<wbr>Config</a></dt><dd>Configuration for <a href="../engine/struct.MitoEngine.html" title="struct mito2::engine::MitoEngine">MitoEngine</a>.
Before using the config, make sure to call <code>MitoConfig::validate()</code> to check if the config is valid.</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.IndexBuildMode.html" title="enum mito2::config::IndexBuildMode">Index<wbr>Build<wbr>Mode</a></dt><dd>Index build mode.</dd><dt><a class="enum" href="enum.MemoryThreshold.html" title="enum mito2::config::MemoryThreshold">Memory<wbr>Threshold</a></dt><dd>Memory threshold for performing certain actions.</dd><dt><a class="enum" href="enum.Mode.html" title="enum mito2::config::Mode">Mode</a></dt><dd>Operational mode for certain actions.</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.DEFAULT_MAX_CONCURRENT_SCAN_FILES.html" title="constant mito2::config::DEFAULT_MAX_CONCURRENT_SCAN_FILES">DEFAULT_<wbr>MAX_<wbr>CONCURRENT_<wbr>SCAN_<wbr>FILES</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Default maximum number of SST files to scan concurrently.</dd><dt><a class="constant" href="constant.FETCH_OPTION_TIMEOUT.html" title="constant mito2::config::FETCH_OPTION_TIMEOUT">FETCH_<wbr>OPTION_<wbr>TIMEOUT</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Fetch option timeout</dd><dt><a class="constant" href="constant.GLOBAL_WRITE_BUFFER_SIZE_FACTOR.html" title="constant mito2::config::GLOBAL_WRITE_BUFFER_SIZE_FACTOR">GLOBAL_<wbr>WRITE_<wbr>BUFFER_<wbr>SIZE_<wbr>FACTOR</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.INDEX_CREATE_MEM_THRESHOLD_FACTOR.html" title="constant mito2::config::INDEX_CREATE_MEM_THRESHOLD_FACTOR">INDEX_<wbr>CREATE_<wbr>MEM_<wbr>THRESHOLD_<wbr>FACTOR</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Use <code>1/INDEX_CREATE_MEM_THRESHOLD_FACTOR</code> of OS memory size as mem threshold for creating index</dd><dt><a class="constant" href="constant.MEM_CACHE_SIZE_FACTOR.html" title="constant mito2::config::MEM_CACHE_SIZE_FACTOR">MEM_<wbr>CACHE_<wbr>SIZE_<wbr>FACTOR</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Use <code>1/MEM_CACHE_SIZE_FACTOR</code> of OS memory size as mem cache size in default mode</dd><dt><a class="constant" href="constant.MULTIPART_UPLOAD_MINIMUM_SIZE.html" title="constant mito2::config::MULTIPART_UPLOAD_MINIMUM_SIZE">MULTIPART_<wbr>UPLOAD_<wbr>MINIMUM_<wbr>SIZE</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="constant" href="constant.PAGE_CACHE_SIZE_FACTOR.html" title="constant mito2::config::PAGE_CACHE_SIZE_FACTOR">PAGE_<wbr>CACHE_<wbr>SIZE_<wbr>FACTOR</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Use <code>1/PAGE_CACHE_SIZE_FACTOR</code> of OS memory size as page cache size in default mode</dd><dt><a class="constant" href="constant.SST_META_CACHE_SIZE_FACTOR.html" title="constant mito2::config::SST_META_CACHE_SIZE_FACTOR">SST_<wbr>META_<wbr>CACHE_<wbr>SIZE_<wbr>FACTOR</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Use <code>1/SST_META_CACHE_SIZE_FACTOR</code> of OS memory size as SST meta cache size in default mode</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.divide_num_cpus.html" title="fn mito2::config::divide_num_cpus">divide_<wbr>num_<wbr>cpus</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Divide cpu num by a non-zero <code>divisor</code> and returns at least 1.</dd></dl></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink