mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-01-08 06:12:55 +00:00
2 lines
11 KiB
HTML
2 lines
11 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="Cache for the engine."><title>mito2::cache - 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="mito2" 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 cache</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-beta.4</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module cache</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><li><a href="#types" title="Type Aliases">Type Aliases</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"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">mito2</a></div><h1>Module <span>cache</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/cache.rs.html#15-1053">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Cache for the engine.</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="cache_size/index.html" title="mod mito2::cache::cache_size">cache_<wbr>size</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Cache size of different cache value.</dd><dt><a class="mod" href="file_cache/index.html" title="mod mito2::cache::file_cache">file_<wbr>cache</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>A cache for files.</dd><dt><a class="mod" href="index/index.html" title="mod mito2::cache::index">index</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="manifest_cache/index.html" title="mod mito2::cache::manifest_cache">manifest_<wbr>cache</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>A cache for manifest files.</dd><dt><a class="mod" href="write_cache/index.html" title="mod mito2::cache::write_cache">write_<wbr>cache</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>A write-through cache for remote object stores.</dd></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.CacheManager.html" title="struct mito2::cache::CacheManager">Cache<wbr>Manager</a></dt><dd>Manages cached data for the engine.</dd><dt><a class="struct" href="struct.CacheManagerBuilder.html" title="struct mito2::cache::CacheManagerBuilder">Cache<wbr>Manager<wbr>Builder</a></dt><dd>Builder to construct a <a href="struct.CacheManager.html" title="struct mito2::cache::CacheManager">CacheManager</a>.</dd><dt><a class="struct" href="struct.ColumnPagePath.html" title="struct mito2::cache::ColumnPagePath">Column<wbr>Page<wbr>Path</a></dt><dd>Path to column pages in the SST file.</dd><dt><a class="struct" href="struct.PageKey.html" title="struct mito2::cache::PageKey">PageKey</a></dt><dd>Cache key to pages in a row group (after projection).</dd><dt><a class="struct" href="struct.PageValue.html" title="struct mito2::cache::PageValue">Page<wbr>Value</a></dt><dd>Cached row group pages for a column.</dd><dt><a class="struct" href="struct.SelectorResultKey.html" title="struct mito2::cache::SelectorResultKey">Selector<wbr>Result<wbr>Key</a></dt><dd>Cache key for time series row selector result.</dd><dt><a class="struct" href="struct.SelectorResultValue.html" title="struct mito2::cache::SelectorResultValue">Selector<wbr>Result<wbr>Value</a></dt><dd>Cached result for time series row selector.</dd><dt><a class="struct" href="struct.SstMetaKey.html" title="struct mito2::cache::SstMetaKey">SstMeta<wbr>Key</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Cache key (region id, file id) for SST meta.</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.CacheStrategy.html" title="enum mito2::cache::CacheStrategy">Cache<wbr>Strategy</a></dt><dd>Cache strategies that may only enable a subset of caches.</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.FILE_TYPE.html" title="constant mito2::cache::FILE_TYPE">FILE_<wbr>TYPE</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Metrics type key for files on the local store.</dd><dt><a class="constant" href="constant.INDEX_TYPE.html" title="constant mito2::cache::INDEX_TYPE">INDEX_<wbr>TYPE</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Metrics type key for index files (puffin) on the local store.</dd><dt><a class="constant" href="constant.PAGE_TYPE.html" title="constant mito2::cache::PAGE_TYPE">PAGE_<wbr>TYPE</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Metrics type key for pages.</dd><dt><a class="constant" href="constant.SELECTOR_RESULT_TYPE.html" title="constant mito2::cache::SELECTOR_RESULT_TYPE">SELECTOR_<wbr>RESULT_<wbr>TYPE</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Metrics type key for selector result cache.</dd><dt><a class="constant" href="constant.SST_META_TYPE.html" title="constant mito2::cache::SST_META_TYPE">SST_<wbr>META_<wbr>TYPE</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Metrics type key for sst meta.</dd><dt><a class="constant" href="constant.VECTOR_TYPE.html" title="constant mito2::cache::VECTOR_TYPE">VECTOR_<wbr>TYPE</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Metrics type key for vector.</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.meta_cache_weight.html" title="fn mito2::cache::meta_cache_weight">meta_<wbr>cache_<wbr>weight</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.page_cache_weight.html" title="fn mito2::cache::page_cache_weight">page_<wbr>cache_<wbr>weight</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.selector_result_cache_hit.html" title="fn mito2::cache::selector_result_cache_hit">selector_<wbr>result_<wbr>cache_<wbr>hit</a></dt><dd>Increases selector cache hit metrics.</dd><dt><a class="fn" href="fn.selector_result_cache_miss.html" title="fn mito2::cache::selector_result_cache_miss">selector_<wbr>result_<wbr>cache_<wbr>miss</a></dt><dd>Increases selector cache miss metrics.</dd><dt><a class="fn" href="fn.selector_result_cache_weight.html" title="fn mito2::cache::selector_result_cache_weight">selector_<wbr>result_<wbr>cache_<wbr>weight</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.update_hit_miss.html" title="fn mito2::cache::update_hit_miss">update_<wbr>hit_<wbr>miss</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Updates cache hit/miss metrics.</dd><dt><a class="fn" href="fn.vector_cache_weight.html" title="fn mito2::cache::vector_cache_weight">vector_<wbr>cache_<wbr>weight</a><span title="Restricted Visibility"> 🔒</span> </dt></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.CacheManagerRef.html" title="type mito2::cache::CacheManagerRef">Cache<wbr>Manager<wbr>Ref</a></dt><dt><a class="type" href="type.PageCache.html" title="type mito2::cache::PageCache">Page<wbr>Cache</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Maps (region, file, row group, column) to <a href="struct.PageValue.html" title="struct mito2::cache::PageValue">PageValue</a>.</dd><dt><a class="type" href="type.SelectorResultCache.html" title="type mito2::cache::SelectorResultCache">Selector<wbr>Result<wbr>Cache</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Maps (file id, row group id, time series row selector) to <a href="struct.SelectorResultValue.html" title="struct mito2::cache::SelectorResultValue">SelectorResultValue</a>.</dd><dt><a class="type" href="type.SstMetaCache.html" title="type mito2::cache::SstMetaCache">SstMeta<wbr>Cache</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Maps (region id, file id) to [ParquetMetaData].</dd><dt><a class="type" href="type.VectorCache.html" title="type mito2::cache::VectorCache">Vector<wbr>Cache</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Maps [Value] to a vector that holds this value repeatedly.</dd></dl></section></div></main></body></html> |