mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-28 19:00:39 +00:00
2 lines
9.3 KiB
HTML
2 lines
9.3 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="API documentation for the Rust `index` mod in crate `mito2`."><title>mito2::sst::index - 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 index</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 index</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="#traits" title="Traits">Traits</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><a href="../index.html">In mito2::<wbr>sst</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">sst</a></div><h1>Module <span>index</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/sst/index.rs.html#15-2340">Source</a> </span></div><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="bloom_filter/index.html" title="mod mito2::sst::index::bloom_filter">bloom_<wbr>filter</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="fulltext_index/index.html" title="mod mito2::sst::index::fulltext_index">fulltext_<wbr>index</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="indexer/index.html" title="mod mito2::sst::index::indexer">indexer</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="intermediate/index.html" title="mod mito2::sst::index::intermediate">intermediate</a></dt><dt><a class="mod" href="inverted_index/index.html" title="mod mito2::sst::index::inverted_index">inverted_<wbr>index</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="puffin_manager/index.html" title="mod mito2::sst::index::puffin_manager">puffin_<wbr>manager</a></dt><dt><a class="mod" href="statistics/index.html" title="mod mito2::sst::index::statistics">statistics</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="store/index.html" title="mod mito2::sst::index::store">store</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.IndexBaseOutput.html" title="struct mito2::sst::index::IndexBaseOutput">Index<wbr>Base<wbr>Output</a></dt><dd>Base output of the index creation.</dd><dt><a class="struct" href="struct.IndexBuildScheduler.html" title="struct mito2::sst::index::IndexBuildScheduler">Index<wbr>Build<wbr>Scheduler</a></dt><dt><a class="struct" href="struct.IndexBuildStatus.html" title="struct mito2::sst::index::IndexBuildStatus">Index<wbr>Build<wbr>Status</a></dt><dd>Tracks the index build status of a region scheduled by the <a href="struct.IndexBuildScheduler.html" title="struct mito2::sst::index::IndexBuildScheduler">IndexBuildScheduler</a>.</dd><dt><a class="struct" href="struct.IndexBuildTask.html" title="struct mito2::sst::index::IndexBuildTask">Index<wbr>Build<wbr>Task</a></dt><dt><a class="struct" href="struct.IndexOutput.html" title="struct mito2::sst::index::IndexOutput">Index<wbr>Output</a></dt><dd>Output of the index creation.</dd><dt><a class="struct" href="struct.Indexer.html" title="struct mito2::sst::index::Indexer">Indexer</a></dt><dd>The index creator that hides the error handling details.</dd><dt><a class="struct" href="struct.IndexerBuilderImpl.html" title="struct mito2::sst::index::IndexerBuilderImpl">Indexer<wbr>Builder<wbr>Impl</a><span title="Restricted Visibility"> 🔒</span> </dt></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.IndexBuildOutcome.html" title="enum mito2::sst::index::IndexBuildOutcome">Index<wbr>Build<wbr>Outcome</a></dt><dd>Outcome of an index build task.</dd><dt><a class="enum" href="enum.IndexBuildType.html" title="enum mito2::sst::index::IndexBuildType">Index<wbr>Build<wbr>Type</a></dt><dd>Type of an index build task.</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.TYPE_BLOOM_FILTER_INDEX.html" title="constant mito2::sst::index::TYPE_BLOOM_FILTER_INDEX">TYPE_<wbr>BLOOM_<wbr>FILTER_<wbr>INDEX</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="constant" href="constant.TYPE_FULLTEXT_INDEX.html" title="constant mito2::sst::index::TYPE_FULLTEXT_INDEX">TYPE_<wbr>FULLTEXT_<wbr>INDEX</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="constant" href="constant.TYPE_INVERTED_INDEX.html" title="constant mito2::sst::index::TYPE_INVERTED_INDEX">TYPE_<wbr>INVERTED_<wbr>INDEX</a><span title="Restricted Visibility"> 🔒</span> </dt></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.IndexerBuilder.html" title="trait mito2::sst::index::IndexerBuilder">Indexer<wbr>Builder</a></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.decode_primary_keys_with_counts.html" title="fn mito2::sst::index::decode_primary_keys_with_counts">decode_<wbr>primary_<wbr>keys_<wbr>with_<wbr>counts</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Decodes primary keys from a flat format RecordBatch.
|
|
Returns a list of (decoded_pk_value, count) tuples where count is the number of occurrences.</dd><dt><a class="fn" href="fn.trigger_index_background_download.html" title="fn mito2::sst::index::trigger_index_background_download">trigger_<wbr>index_<wbr>background_<wbr>download</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Triggers background download of an index file to the local cache.</dd></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.BloomFilterOutput.html" title="type mito2::sst::index::BloomFilterOutput">Bloom<wbr>Filter<wbr>Output</a></dt><dd>Output of the bloom filter creation.</dd><dt><a class="type" href="type.FulltextIndexOutput.html" title="type mito2::sst::index::FulltextIndexOutput">Fulltext<wbr>Index<wbr>Output</a></dt><dd>Output of the fulltext index creation.</dd><dt><a class="type" href="type.InvertedIndexOutput.html" title="type mito2::sst::index::InvertedIndexOutput">Inverted<wbr>Index<wbr>Output</a></dt><dd>Output of the inverted index creation.</dd><dt><a class="type" href="type.ResultMpscSender.html" title="type mito2::sst::index::ResultMpscSender">Result<wbr>Mpsc<wbr>Sender</a></dt><dd>Mpsc output result sender.</dd></dl></section></div></main></body></html> |