Files
greptimedb/metric_engine/engine/options/index.html
2026-05-15 04:01:35 +00:00

5 lines
5.6 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="Specific options for the metric engine to create or open a region."><title>metric_engine::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-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="metric_engine" 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="../../../metric_engine/index.html">metric_<wbr>engine</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="#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><a href="../index.html">In metric_<wbr>engine::<wbr>engine</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">metric_engine</a>::<wbr><a href="../index.html">engine</a></div><h1>Module <span>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/metric_engine/engine/options.rs.html#15-234">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Specific options for the metric engine to create or open a region.</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.PhysicalRegionOptions.html" title="struct metric_engine::engine::options::PhysicalRegionOptions">Physical<wbr>Region<wbr>Options</a></dt><dd>Physical region 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.IndexOptions.html" title="enum metric_engine::engine::options::IndexOptions">Index<wbr>Options</a></dt><dd>Index options for auto created columns</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_DATA_REGION_COMPACTION_TIME_WINDOW.html" title="constant metric_engine::engine::options::DEFAULT_DATA_REGION_COMPACTION_TIME_WINDOW">DEFAULT_<wbr>DATA_<wbr>REGION_<wbr>COMPACTION_<wbr>TIME_<wbr>WINDOW</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>The default compaction time window for metric engine data regions.</dd><dt><a class="constant" href="constant.SEG_ROW_COUNT_FOR_DATA_REGION.html" title="constant metric_engine::engine::options::SEG_ROW_COUNT_FOR_DATA_REGION">SEG_<wbr>ROW_<wbr>COUNT_<wbr>FOR_<wbr>DATA_<wbr>REGION</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>The empirical value for the seg row count of the metric data region.
Compared to the mito engine, the pattern of the metric engine constructs smaller indices.
Therefore, compared to the default seg row count of 1024, by adjusting it to a smaller
value and appropriately increasing the size of the index, it results in an improved indexing effect.</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.set_data_region_options.html" title="fn metric_engine::engine::options::set_data_region_options">set_<wbr>data_<wbr>region_<wbr>options</a></dt><dd>Sets data region specific options.</dd></dl></section></div></main></body></html>