mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-25 17:30:41 +00:00
5 lines
8.5 KiB
HTML
5 lines
8.5 KiB
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="Options for a region."><title>mito2::region::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-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 options</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 options</a></h2><h3><a href="#modules">Module Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><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><a href="../index.html">In mito2::<wbr>region</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>::<wbr><a href="../index.html">region</a></div><h1>Module <span>options</span> <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/region/options.rs.html#15-849">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Options for a region.</p>
|
|
<p>If we add options in this mod, we also need to modify [store_api::mito_engine_options].</p>
|
|
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="prefix_inverted_index/index.html" title="mod mito2::region::options::prefix_inverted_index">prefix_<wbr>inverted_<wbr>index</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="prefix_partition_tree/index.html" title="mod mito2::region::options::prefix_partition_tree">prefix_<wbr>partition_<wbr>tree</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="prefix_twcs/index.html" title="mod mito2::region::options::prefix_twcs">prefix_<wbr>twcs</a><span title="Restricted Visibility"> 🔒</span> </dt></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.IndexOptions.html" title="struct mito2::region::options::IndexOptions">Index<wbr>Options</a></dt><dd>Options for index.</dd><dt><a class="struct" href="struct.InvertedIndexOptions.html" title="struct mito2::region::options::InvertedIndexOptions">Inverted<wbr>Index<wbr>Options</a></dt><dd>Options for the inverted index.</dd><dt><a class="struct" href="struct.PartitionTreeOptions.html" title="struct mito2::region::options::PartitionTreeOptions">Partition<wbr>Tree<wbr>Options</a></dt><dd>Partition tree memtable options.</dd><dt><a class="struct" href="struct.RegionOptions.html" title="struct mito2::region::options::RegionOptions">Region<wbr>Options</a></dt><dd>Options that affect the entire region.</dd><dt><a class="struct" href="struct.RegionOptionsWithoutEnum.html" title="struct mito2::region::options::RegionOptionsWithoutEnum">Region<wbr>Options<wbr>Without<wbr>Enum</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>We need to define a new struct without enum fields as <code>#[serde(default)]</code> does not
|
|
support external tagging.</dd><dt><a class="struct" href="struct.TwcsOptions.html" title="struct mito2::region::options::TwcsOptions">Twcs<wbr>Options</a></dt><dd>Time window compaction 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.CompactionOptions.html" title="enum mito2::region::options::CompactionOptions">Compaction<wbr>Options</a></dt><dd>Options for compactions</dd><dt><a class="enum" href="enum.MemtableOptions.html" title="enum mito2::region::options::MemtableOptions">Memtable<wbr>Options</a></dt><dd>Options for region level memtable.</dd><dt><a class="enum" href="enum.MergeMode.html" title="enum mito2::region::options::MergeMode">Merge<wbr>Mode</a></dt><dd>Mode to handle duplicate rows while merging.</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.COMPACTION_TWCS_PREFIX.html" title="constant mito2::region::options::COMPACTION_TWCS_PREFIX">COMPACTION_<wbr>TWCS_<wbr>PREFIX</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="constant" href="constant.DEFAULT_INDEX_SEGMENT_ROW_COUNT.html" title="constant mito2::region::options::DEFAULT_INDEX_SEGMENT_ROW_COUNT">DEFAULT_<wbr>INDEX_<wbr>SEGMENT_<wbr>ROW_<wbr>COUNT</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="constant" href="constant.MEMTABLE_PARTITION_TREE_PREFIX.html" title="constant mito2::region::options::MEMTABLE_PARTITION_TREE_PREFIX">MEMTABLE_<wbr>PARTITION_<wbr>TREE_<wbr>PREFIX</a><span title="Restricted Visibility"> 🔒</span> </dt></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.deserialize_ignore_column_ids.html" title="fn mito2::region::options::deserialize_ignore_column_ids">deserialize_<wbr>ignore_<wbr>column_<wbr>ids</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.options_map_to_value.html" title="fn mito2::region::options::options_map_to_value">options_<wbr>map_<wbr>to_<wbr>value</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Converts the <code>options</code> map to a json object.</dd><dt><a class="fn" href="fn.parse_wal_options.html" title="fn mito2::region::options::parse_wal_options">parse_<wbr>wal_<wbr>options</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.serialize_ignore_column_ids.html" title="fn mito2::region::options::serialize_ignore_column_ids">serialize_<wbr>ignore_<wbr>column_<wbr>ids</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.validate_enum_options.html" title="fn mito2::region::options::validate_enum_options">validate_<wbr>enum_<wbr>options</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Validates whether the <code>options_map</code> has valid options for specific <code>enum_tag_key</code>
|
|
and returns <code>true</code> if the map contains the enum tag.</dd></dl></section></div></main></body></html> |